Classes, traits, and interfaces - 11.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 1518

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
ComplexTestTypeStateForm class Drupal\workflow_type_test\Form core/modules/workflows/tests/modules/workflow_type_test/src/Form/ComplexTestTypeStateForm.php Form to configure the complex test workflow states.
ComplexTestTypeTransitionForm class Drupal\workflow_type_test\Form core/modules/workflows/tests/modules/workflow_type_test/src/Form/ComplexTestTypeTransitionForm.php Form to configure the complex test workflow states.
ComplexWorkflowTypeTest class Drupal\Tests\workflows\Kernel core/modules/workflows/tests/src/Kernel/ComplexWorkflowTypeTest.php Workflow entity tests that require modules or storage.
Component class Drupal\Core\Plugin core/lib/Drupal/Core/Plugin/Component.php Simple value object that contains information about the component. 6
Component final class Drupal\sdc\Plugin core/modules/sdc/src/Plugin/Component.php Simple value object that contains information about the component. 6
ComponentElement class Drupal\sdc\Element core/modules/sdc/src/Element/ComponentElement.php Provides a Single Directory Component render element.
ComponentElement class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/ComponentElement.php Provides a Single-Directory Component render element.
ComponentEntityDisplayBase abstract class Drupal\migrate\Plugin\migrate\destination core/modules/migrate/src/Plugin/migrate/destination/ComponentEntityDisplayBase.php Provides a destination plugin for migrating entity display components. 3 2
ComponentGenerator class Drupal\Composer\Generator composer/Generator/ComponentGenerator.php Reconciles Drupal component dependencies with core. 1
ComponentInvalidReplacementTest final class Drupal\Tests\sdc\Kernel core/modules/sdc/tests/src/Kernel/ComponentInvalidReplacementTest.php Tests invalid render options for components.
ComponentInvalidReplacementTest class Drupal\KernelTests\Components core/tests/Drupal/KernelTests/Components/ComponentInvalidReplacementTest.php Tests invalid render options for components.
ComponentKernelTestBase abstract class Drupal\Tests\Core\Theme\Component core/tests/Drupal/Tests/Core/Theme/Component/ComponentKernelTestBase.php Defines a base class for component kernel tests. 2
ComponentKernelTestBase abstract class Drupal\KernelTests\Components core/tests/Drupal/KernelTests/Components/ComponentKernelTestBase.php Defines a base class for component kernel tests. 6
ComponentKernelTestBase abstract class Drupal\Tests\sdc\Kernel core/modules/sdc/tests/src/Kernel/ComponentKernelTestBase.php Defines a base class for component kernel tests. 6
ComponentLoader class Drupal\Core\Template\Loader core/lib/Drupal/Core/Template/Loader/ComponentLoader.php Lets you load templates using the component ID.
ComponentMetadata class Drupal\Core\Theme\Component core/lib/Drupal/Core/Theme/Component/ComponentMetadata.php Component metadata. 2
ComponentMetadata final class Drupal\sdc\Component core/modules/sdc/src/Component/ComponentMetadata.php Component metadata. 2
ComponentMetadataTest final class Drupal\Tests\sdc\Unit core/modules/sdc/tests/src/Unit/ComponentMetadataTest.php Unit tests for the component metadata class.
ComponentMetadataTest class Drupal\Tests\Core\Theme\Component core/tests/Drupal/Tests/Core/Theme/Component/ComponentMetadataTest.php Unit tests for the component metadata class.
ComponentNegotiator class Drupal\Core\Theme core/lib/Drupal/Core/Theme/ComponentNegotiator.php Determines which component should be used. 2
ComponentNegotiator final class Drupal\sdc core/modules/sdc/src/ComponentNegotiator.php Determines which component should be used. 1
ComponentNegotiatorTest final class Drupal\Tests\sdc\Kernel core/modules/sdc/tests/src/Kernel/ComponentNegotiatorTest.php Tests the component negotiator.
ComponentNegotiatorTest class Drupal\Tests\Core\Theme\Component core/tests/Drupal/Tests/Core/Theme/Component/ComponentNegotiatorTest.php Tests the component negotiator.
ComponentNegotiatorTest class Drupal\KernelTests\Components core/tests/Drupal/KernelTests/Components/ComponentNegotiatorTest.php Tests the component negotiator.
ComponentNodeVisitor class Drupal\Core\Template core/lib/Drupal/Core/Template/ComponentNodeVisitor.php Provides a ComponentNodeVisitor to change the generated parse-tree.
ComponentNodeVisitor final class Drupal\sdc\Twig core/modules/sdc/src/Twig/ComponentNodeVisitor.php Provides a ComponentNodeVisitor to change the generated parse-tree.
ComponentNodeVisitorTest final class Drupal\Tests\sdc\Kernel core/modules/sdc/tests/src/Kernel/ComponentNodeVisitorTest.php Tests the node visitor.
ComponentNodeVisitorTest class Drupal\KernelTests\Components core/tests/Drupal/KernelTests/Components/ComponentNodeVisitorTest.php Tests the node visitor.
ComponentNotFoundException class Drupal\Core\Render\Component\Exception core/lib/Drupal/Core/Render/Component/Exception/ComponentNotFoundException.php Raised when a component cannot be found. 7
ComponentNotFoundException final class Drupal\sdc\Exception core/modules/sdc/src/Exception/ComponentNotFoundException.php Raised when a component cannot be found. 4
ComponentPluginManager final class Drupal\sdc core/modules/sdc/src/ComponentPluginManager.php Defines a plugin manager to deal with sdc. 6 2
ComponentPluginManager class Drupal\Core\Theme core/lib/Drupal/Core/Theme/ComponentPluginManager.php Defines a plugin manager to deal with components. 8
ComponentPluginManagerTest class Drupal\Tests\Core\Theme\Component core/tests/Drupal/Tests/Core/Theme/Component/ComponentPluginManagerTest.php Tests the component plugin manager.
ComponentPluginManagerTest class Drupal\KernelTests\Components core/tests/Drupal/KernelTests/Components/ComponentPluginManagerTest.php Tests the component plugin manager.
ComponentPluginManagerTest final class Drupal\Tests\sdc\Kernel core/modules/sdc/tests/src/Kernel/ComponentPluginManagerTest.php Tests the component plugin manager.
ComponentRendererTrait trait Drupal\Tests\sdc\Traits core/modules/sdc/tests/src/Traits/ComponentRendererTrait.php Defines a trait for rendering components. 1
ComponentRenderInvalidTest class Drupal\KernelTests\Components core/tests/Drupal/KernelTests/Components/ComponentRenderInvalidTest.php Tests invalid render options for components.
ComponentRenderInvalidTest final class Drupal\Tests\sdc\Kernel core/modules/sdc/tests/src/Kernel/ComponentRenderInvalidTest.php Tests invalid render options for components.
ComponentRenderTest final class Drupal\Tests\sdc\FunctionalJavascript core/modules/sdc/tests/src/FunctionalJavascript/ComponentRenderTest.php Tests the correct rendering of components.
ComponentRenderTest final class Drupal\Tests\sdc\Kernel core/modules/sdc/tests/src/Kernel/ComponentRenderTest.php Tests the correct rendering of components.
ComponentRenderTest final class Drupal\Tests\sdc\Functional core/modules/sdc/tests/src/Functional/ComponentRenderTest.php Tests the correct rendering of components.
ComponentRenderTest class Drupal\KernelTests\Components core/tests/Drupal/KernelTests/Components/ComponentRenderTest.php Tests the correct rendering of components.
ComponentRenderTest class Drupal\FunctionalTests\Components core/tests/Drupal/FunctionalTests/Components/ComponentRenderTest.php Tests the correct rendering of components.
ComponentRenderTest class Drupal\FunctionalJavascriptTests\Components core/tests/Drupal/FunctionalJavascriptTests/Components/ComponentRenderTest.php Tests the correct rendering of components.
ComponentsIsolatedBuildTest class Drupal\BuildTests\Composer\Component core/tests/Drupal/BuildTests/Composer/Component/ComponentsIsolatedBuildTest.php Try to install dependencies per component, using Composer.
ComponentsTaggedReleaseTest class Drupal\BuildTests\Composer\Component core/tests/Drupal/BuildTests/Composer/Component/ComponentsTaggedReleaseTest.php Demonstrate that the Component generator responds to release tagging.
ComponentsTwigExtension final class Drupal\Core\Template core/lib/Drupal/Core/Template/ComponentsTwigExtension.php The twig extension so Drupal can recognize the new code.
ComponentTestDoesNotExtendCoreTest final class Drupal\PHPStan\Rules core/tests/PHPStan/Rules/ComponentTestDoesNotExtendCoreTest.php Ensures that no component tests are extending a core test base class. 1
ComponentTestDoesNotExtendCoreTestTest class Drupal\PHPStan\Tests core/tests/PHPStan/tests/ComponentTestDoesNotExtendCoreTestTest.php Tests ComponentTestDoesNotExtendCoreTest rule.
ComponentValidator class Drupal\Core\Theme\Component core/lib/Drupal/Core/Theme/Component/ComponentValidator.php Validates a component based on its definition and the component schema. 3

Other projects

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