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

Primary tabs

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
ContentTranslationSyncUnitTest class Drupal\Tests\content_translation\Kernel core/modules/content_translation/tests/src/Kernel/ContentTranslationSyncUnitTest.php Tests the field synchronization logic.
ContentTranslationTestBase

in drupal:8.?.? and is removed from drupal:9.0.0. Use \Drupal\Tests\content_translation\Functional\ContentTranslationTestBase instead.

abstract class Drupal\content_translation\Tests core/modules/content_translation/src/Tests/ContentTranslationTestBase.php Base class for content translation tests. 1
ContentTranslationTestBase abstract class Drupal\Tests\content_translation\Functional core/modules/content_translation/tests/src/Functional/ContentTranslationTestBase.php Base class for content translation tests. 7 2
ContentTranslationUISkipTest class Drupal\Tests\content_translation\Functional core/modules/content_translation/tests/src/Functional/ContentTranslationUISkipTest.php Tests the content translation UI check skip.
ContentTranslationUITestBase

in drupal:8.?.? and is removed from drupal:9.0.0. Use \Drupal\Tests\content_translation\Functional\ContentTranslationUITestBase instead.

abstract class Drupal\content_translation\Tests core/modules/content_translation/src/Tests/ContentTranslationUITestBase.php Tests the Content Translation UI.
ContentTranslationUITestBase abstract class Drupal\Tests\content_translation\Functional core/modules/content_translation/tests/src/Functional/ContentTranslationUITestBase.php Tests the Content Translation UI. 9 8
ContentTranslationUntranslatableFieldsTest class Drupal\Tests\content_translation\Functional core/modules/content_translation/tests/src/Functional/ContentTranslationUntranslatableFieldsTest.php Tests the untranslatable fields behaviors.
ContentTranslationUpdatesManager

in drupal:8.7.0 and is removed from drupal:9.0.0. Definitions are updated automatically now so no replacement is needed.

class Drupal\content_translation core/modules/content_translation/src/ContentTranslationUpdatesManager.php Provides the logic needed to update field storage definitions when needed. 2
ContentTranslationUpdateTest class Drupal\Tests\content_translation\Functional\Update core/modules/content_translation/tests/src/Functional/Update/ContentTranslationUpdateTest.php Tests the upgrade path for the Content Translation module.
ContentTranslationViewsUITest class Drupal\Tests\content_translation\Functional\Views core/modules/content_translation/tests/src/Functional/Views/ContentTranslationViewsUITest.php Tests the views UI when content_translation is enabled.
ContentTranslationWorkflowsTest class Drupal\Tests\content_translation\Functional core/modules/content_translation/tests/src/Functional/ContentTranslationWorkflowsTest.php Tests the content translation workflows for the test entity.
ContentTypeCreationTrait

in drupal:8.4.0 and is removed from drupal:9.0.0. Use \Drupal\Tests\node\Traits\ContentTypeCreationTrait instead.

trait Drupal\simpletest core/modules/simpletest/src/ContentTypeCreationTrait.php Provides methods to create content type from given values.
ContentTypeCreationTrait trait Drupal\Tests\node\Traits core/modules/node/tests/src/Traits/ContentTypeCreationTrait.php Provides methods to create content type from given values. 32
ContentTypeHeaderMatcher class Drupal\Core\Routing core/lib/Drupal/Core/Routing/ContentTypeHeaderMatcher.php Filters routes based on the HTTP Content-type header. 1 2
ContentTypeHeaderMatcherTest class Drupal\Tests\Core\Routing core/tests/Drupal/Tests/Core/Routing/ContentTypeHeaderMatcherTest.php Confirm that the content types partial matcher is functioning properly.
ContentUninstallValidator class Drupal\Core\ProxyClass\Entity core/lib/Drupal/Core/ProxyClass/Entity/ContentUninstallValidator.php Provides a proxy class for \Drupal\Core\Entity\ContentUninstallValidator.
ContentUninstallValidator class Drupal\Core\Entity core/lib/Drupal/Core/Entity/ContentUninstallValidator.php Validates module uninstall readiness based on existing content entities. 2
Context class Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/Context.php A Drupal specific context wrapper class. 1 25
Context class Drupal\Component\Plugin\Context core/lib/Drupal/Component/Plugin/Context/Context.php A generic context class for wrapping data a plugin needs to operate. 1 3
ContextAwarePluginAssignmentTrait trait Drupal\Core\Plugin core/lib/Drupal/Core/Plugin/ContextAwarePluginAssignmentTrait.php Handles context assignments for context-aware plugins. 3
ContextAwarePluginBase abstract class Drupal\Core\Plugin core/lib/Drupal/Core/Plugin/ContextAwarePluginBase.php Base class for plugins that are context aware. 9 9
ContextAwarePluginBase abstract class Drupal\Component\Plugin core/lib/Drupal/Component/Plugin/ContextAwarePluginBase.php Base class for plugins that are context aware. 1 1
ContextAwarePluginBaseTest class Drupal\KernelTests\Core\Plugin\Context core/tests/Drupal/KernelTests/Core/Plugin/Context/ContextAwarePluginBaseTest.php @coversDefaultClass \Drupal\Core\Plugin\ContextAwarePluginBase
ContextAwarePluginDefinition class Drupal\Tests\Core\Plugin core/tests/Drupal/Tests/Core/Plugin/ContextHandlerTest.php
ContextAwarePluginDefinitionInterface interface Drupal\Component\Plugin\Definition core/lib/Drupal/Component/Plugin/Definition/ContextAwarePluginDefinitionInterface.php Provides an interface for plugin definitions which use contexts. 3 5
ContextAwarePluginDefinitionTrait trait Drupal\Component\Plugin\Definition core/lib/Drupal/Component/Plugin/Definition/ContextAwarePluginDefinitionTrait.php Provides a trait for context-aware object-based plugin definitions. 3
ContextAwarePluginInterface interface Drupal\Core\Plugin core/lib/Drupal/Core/Plugin/ContextAwarePluginInterface.php An override of ContextAwarePluginInterface for documentation purposes. 6 13
ContextAwarePluginInterface interface Drupal\Component\Plugin core/lib/Drupal/Component/Plugin/ContextAwarePluginInterface.php Interface for defining context aware plugins. 2 1
ContextAwarePluginManagerInterface interface Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextAwarePluginManagerInterface.php Provides an interface for plugin managers that support context-aware plugins. 1 1
ContextAwarePluginManagerTrait trait Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextAwarePluginManagerTrait.php Provides a trait for plugin managers that support context-aware plugins. 1
ContextAwareVariantInterface interface Drupal\Core\Display core/lib/Drupal/Core/Display/ContextAwareVariantInterface.php Provides an interface for variant plugins that are context-aware. 1 2
ContextCacheKeys class Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/ContextCacheKeys.php A value object to store generated cache keys with its cacheability metadata. 1
ContextDefinition class Drupal\Core\Annotation core/lib/Drupal/Core/Annotation/ContextDefinition.php Defines a context definition annotation object.
ContextDefinition class Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextDefinition.php Defines a class for context definitions. 2 35
ContextDefinitionInterface interface Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextDefinitionInterface.php Interface to define definition objects in ContextInterface via TypedData. 1 1
ContextDefinitionInterface interface Drupal\Component\Plugin\Context core/lib/Drupal/Component/Plugin/Context/ContextDefinitionInterface.php Interface used to define definition objects found in ContextInterface. 1 3
ContextDefinitionIsSatisfiedTest class Drupal\Tests\Core\Plugin\Context core/tests/Drupal/Tests/Core/Plugin/Context/ContextDefinitionIsSatisfiedTest.php @coversDefaultClass \Drupal\Core\Plugin\Context\ContextDefinition @group Plugin
ContextDefinitionTest class Drupal\Tests\Core\Plugin\Context core/tests/Drupal/Tests/Core/Plugin/Context/ContextDefinitionTest.php Tests the ContextDefinition class.
ContextDefinitionTest class Drupal\KernelTests\Core\Plugin core/tests/Drupal/KernelTests/Core/Plugin/ContextDefinitionTest.php @coversDefaultClass \Drupal\Core\Plugin\Context\ContextDefinition @group Plugin
ContextDefinitionTest class Drupal\KernelTests\Core\Plugin\Annotation core/tests/Drupal/KernelTests/Core/Plugin/Annotation/ContextDefinitionTest.php @coversDefaultClass \Drupal\Core\Annotation\ContextDefinition @group Plugin
ContextException class Drupal\Component\Plugin\Exception core/lib/Drupal/Component/Plugin/Exception/ContextException.php An exception class to be thrown for context plugin exceptions. 1 14
ContextHandler class Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextHandler.php Provides methods to handle sets of contexts. 2 2
ContextHandlerInterface interface Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextHandlerInterface.php Provides an interface for handling sets of contexts. 1 7
ContextHandlerTest class Drupal\Tests\Core\Plugin core/tests/Drupal/Tests/Core/Plugin/ContextHandlerTest.php @coversDefaultClass \Drupal\Core\Plugin\Context\ContextHandler @group Plugin
ContextHandlerTest class Drupal\KernelTests\Core\Plugin core/tests/Drupal/KernelTests/Core/Plugin/ContextHandlerTest.php @coversDefaultClass \Drupal\Core\Plugin\Context\ContextHandler
ContextInterface interface Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextInterface.php Context data and definitions for plugins supporting caching and return docs. 1 3
ContextInterface interface Drupal\Component\Plugin\Context core/lib/Drupal/Component/Plugin/Context/ContextInterface.php Provides data and definitions for plugins during runtime and administration. 2 9
ContextPluginTest class Drupal\KernelTests\Core\Plugin core/tests/Drupal/KernelTests/Core/Plugin/ContextPluginTest.php Tests that contexts are properly set and working within plugins.
ContextProviderInterface interface Drupal\Core\Plugin\Context core/lib/Drupal/Core/Plugin/Context/ContextProviderInterface.php Defines an interface for providing plugin contexts. 5 5
ContextProvidersPass class Drupal\Core\DependencyInjection\Compiler core/lib/Drupal/Core/DependencyInjection/Compiler/ContextProvidersPass.php Adds the context provider service IDs to the context manager. 1

Other projects


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