Classes, traits, and interfaces - 8.9.x - drupal

Introduction to classes

A lot of the PHP code in Drupal is object oriented (OO), making use of PHP classes, interfaces, and traits. See the Objected-oriented programming conventions for more information.

See also

Objected-oriented programming conventions

File

core/core.api.php, line 1511

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
ContextRepositoryInterface interface Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextRepositoryInterface.php Offers a global context repository. 1 7
ContextTest class Drupal\Tests\Core\Plugin\Context core/tests/Drupal/Tests/Core/Plugin/Context/ContextTest.php @coversDefaultClass \Drupal\Core\Plugin\Context\Context @group Plugin
ContextTest class Drupal\Tests\Component\Plugin\Context core/tests/Drupal/Tests/Component/Plugin/Context/ContextTest.php @coversDefaultClass \Drupal\Component\Plugin\Context\Context @group Plugin
ContextTypedDataTest class Drupal\KernelTests\Core\Plugin core/tests/Drupal/KernelTests/Core/Plugin/ContextTypedDataTest.php Tests that contexts work properly with the typed data manager.
ContextualController class Drupal\contextual core/modules/contextual/src/ContextualController.php Returns responses for Contextual module routes.
ContextualDynamicContextTest class Drupal\Tests\contextual\Functional core/modules/contextual/tests/src/Functional/ContextualDynamicContextTest.php Tests if contextual links are showing on the front page depending on permissions.
ContextualFiltersBlockContextTest class Drupal\Tests\views\Functional\Plugin core/modules/views/tests/src/Functional/Plugin/ContextualFiltersBlockContextTest.php A test for contextual filters exposed as block context.
ContextualFilterTest class Drupal\Tests\views\FunctionalJavascript\Plugin\views\Handler core/modules/views/tests/src/FunctionalJavascript/Plugin/views/Handler/ContextualFilterTest.php Tests the contextual filter handler UI.
ContextualLinkClickTrait trait Drupal\Tests\contextual\FunctionalJavascript core/modules/contextual/tests/src/FunctionalJavascript/ContextualLinkClickTrait.php Functions for testing contextual links. 14
ContextualLinkDefault class Drupal\Core\Menu core/lib/Drupal/Core/Menu/ContextualLinkDefault.php Provides a common base implementation of a contextual link. 2 4
ContextualLinkDefaultTest class Drupal\Tests\Core\Menu core/tests/Drupal/Tests/Core/Menu/ContextualLinkDefaultTest.php @group Menu @coversDefaultClass \Drupal\Core\Menu\ContextualLinkDefault
ContextualLinkInterface interface Drupal\Core\Menu core/lib/Drupal/Core/Menu/ContextualLinkInterface.php Defines a contextual link plugin. 1
ContextualLinkManager class Drupal\Core\Menu core/lib/Drupal/Core/Menu/ContextualLinkManager.php Defines a contextual link plugin manager to deal with contextual links. 2
ContextualLinkManagerInterface interface Drupal\Core\Menu core/lib/Drupal/Core/Menu/ContextualLinkManagerInterface.php Provides an object which returns the available contextual links. 1
ContextualLinkManagerTest class Drupal\Tests\Core\Menu core/tests/Drupal/Tests/Core/Menu/ContextualLinkManagerTest.php @coversDefaultClass \Drupal\Core\Menu\ContextualLinkManager @group Menu
ContextualLinks class Drupal\contextual\Element core/modules/contextual/src/Element/ContextualLinks.php Provides a contextual_links element.
ContextualLinks class Drupal\contextual\Plugin\views\field core/modules/contextual/src/Plugin/views/field/ContextualLinks.php Provides a handler that adds contextual links.
ContextualLinksPlaceholder class Drupal\contextual\Element core/modules/contextual/src/Element/ContextualLinksPlaceholder.php Provides a contextual_links_placeholder element.
ContextualLinksTest class Drupal\Tests\contextual\FunctionalJavascript core/modules/contextual/tests/src/FunctionalJavascript/ContextualLinksTest.php Tests the UI for correct contextual links.
ContextualLinksTest class Drupal\Tests\layout_builder\FunctionalJavascript core/modules/layout_builder/tests/src/FunctionalJavascript/ContextualLinksTest.php Test contextual links compatibility with the Layout Builder.
ContextualLinksTest class Drupal\Tests\node\FunctionalJavascript core/modules/node/tests/src/FunctionalJavascript/ContextualLinksTest.php Create a node with revisions and test contextual links.
ContextualUnitTest class Drupal\Tests\contextual\Kernel core/modules/contextual/tests/src/Kernel/ContextualUnitTest.php Tests all edge cases of converting from #contextual_links to ids and vice versa.
ContextualValidatorInterface interface Drupal\Core\TypedData\Validation core/lib/Drupal/Core/TypedData/Validation/ContextualValidatorInterface.php Extends the contextual validator validate method by a new parameter. 1
ControllerBase abstract class Drupal\Core\Controller core/lib/Drupal/Core/Controller/ControllerBase.php Utility base class for thin controllers. 75 75
ControllerBaseTest class Drupal\Tests\Core\Controller core/tests/Drupal/Tests/Core/Controller/ControllerBaseTest.php Tests that the base controller class.
ControllerResolver class Drupal\Core\Controller core/lib/Drupal/Core/Controller/ControllerResolver.php ControllerResolver to enhance controllers beyond Symfony's basic handling. 5 2
ControllerResolverInterface interface Drupal\Core\Controller core/lib/Drupal/Core/Controller/ControllerResolverInterface.php Extends the ControllerResolverInterface from symfony. 1 8
ControllerResolverTest class Drupal\Tests\Core\Controller core/tests/Drupal/Tests/Core/Controller/ControllerResolverTest.php @coversDefaultClass \Drupal\Core\Controller\ControllerResolver @group Controller
Convert class Drupal\system\Plugin\ImageToolkit\Operation\gd core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Convert.php Defines GD2 convert operation.
ConvertImageEffect class Drupal\image\Plugin\ImageEffect core/modules/image/src/Plugin/ImageEffect/ConvertImageEffect.php Converts an image resource.
ConvertTokens class Drupal\user\Plugin\migrate\process core/modules/user/src/Plugin/migrate/process/ConvertTokens.php Plugin to replace !tokens with [tokens]. 1
ConvertTokensTest class Drupal\Tests\user\Unit\Plugin\migrate\process core/modules/user/tests/src/Unit/Plugin/migrate/process/ConvertTokensTest.php Tests the ConvertTokens plugin.
Cookie class Drupal\user\Authentication\Provider core/modules/user/src/Authentication/Provider/Cookie.php Cookie based authentication provider. 2
CookieResourceTestTrait trait Drupal\Tests\rest\Functional core/modules/rest/tests/src/Functional/CookieResourceTestTrait.php Trait for ResourceTestBase subclasses testing $auth=cookie. 155
CookiesCacheContext class Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/CookiesCacheContext.php Defines the CookiesCacheContext service, for "per cookie" caching. 2
CopyTest class Drupal\Tests\file\Kernel core/modules/file/tests/src/Kernel/CopyTest.php Tests the file copy function.
CoreServiceProvider class Drupal\Core core/lib/Drupal/Core/CoreServiceProvider.php ServiceProvider class for mandatory core services.
Corn class Drupal\Tests\Component\Plugin\Fixtures\vegetable core/tests/Drupal/Tests/Component/Plugin/Fixtures/vegetable/Corn.php Plugin annotation @Plugin( id = "corn", label = "Corn", color = "yellow" ) 1
CorsCompilerPass class Drupal\Core\DependencyInjection\Compiler core/lib/Drupal/Core/DependencyInjection/Compiler/CorsCompilerPass.php Provides a compiler pass which disables the CORS middleware in case disabled. 1
CorsIntegrationTest class Drupal\FunctionalTests\HttpKernel core/tests/Drupal/FunctionalTests/HttpKernel/CorsIntegrationTest.php Tests CORS provided by Drupal.
CountableResourceType class Drupal\jsonapi_test_collection_count\ResourceType core/modules/jsonapi/tests/modules/jsonapi_test_collection_count/src/ResourceType/CountableResourceType.php Subclass with overridden ::includeCount() for testing purposes.
CountableResourceTypeRepository class Drupal\jsonapi_test_collection_count\ResourceType core/modules/jsonapi/tests/modules/jsonapi_test_collection_count/src/ResourceType/CountableResourceTypeRepository.php Provides a repository of JSON:API configurable resource types. 2
CountConstraint class Drupal\Core\Validation\Plugin\Validation\Constraint core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/CountConstraint.php Count constraint.
Counter class Drupal\views\Plugin\views\field core/modules/views/src/Plugin/views/field/Counter.php Field handler to show a counter of the current row. 1
CounterTest class Drupal\Tests\views\Unit\Plugin\field core/modules/views/tests/src/Unit/Plugin/field/CounterTest.php @coversDefaultClass \Drupal\views\Plugin\views\field\Counter @group views
CountryManager class Drupal\Core\Locale core/lib/Drupal/Core/Locale/CountryManager.php Provides list of countries. 2
CountryManagerInterface interface Drupal\Core\Locale core/lib/Drupal/Core/Locale/CountryManagerInterface.php Defines a common interface for country managers. 1 2
CreatedItem class Drupal\Core\Field\Plugin\Field\FieldType core/lib/Drupal/Core/Field/Plugin/Field/FieldType/CreatedItem.php Defines the 'created' entity field type. 1 3
CreateHalSettingsForLinkDomainUpdateTest class Drupal\Tests\hal\Functional\Update core/modules/hal/tests/src/Functional/Update/CreateHalSettingsForLinkDomainUpdateTest.php Tests that 'hal.settings' is created, to store 'link_domain'.
CreateMigrationsTrait trait Drupal\Tests\migrate_drupal\Traits core/modules/migrate_drupal/tests/src/Traits/CreateMigrationsTrait.php 1

Other projects

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.