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 1529

Name Deprecated Object type Namespace File name Summary Direct uses Use statements Strings
ComponentNodeVisitor class Drupal\Core\Template core/lib/Drupal/Core/Template/ComponentNodeVisitor.php Provides a ComponentNodeVisitor to change the generated parse-tree. 1
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. 5
ComponentPluginManager class Drupal\Core\Theme core/lib/Drupal/Core/Theme/ComponentPluginManager.php Defines a plugin manager to deal with components. 8 2
ComponentPluginManagerCachedDiscoveryTest class Drupal\KernelTests\Components core/tests/Drupal/KernelTests/Components/ComponentPluginManagerCachedDiscoveryTest.php Tests discovery of components in a theme being installed or uninstalled.
ComponentPluginManagerTest class Drupal\KernelTests\Components core/tests/Drupal/KernelTests/Components/ComponentPluginManagerTest.php Tests the component plugin manager.
ComponentRenderInvalidTest class Drupal\KernelTests\Components core/tests/Drupal/KernelTests/Components/ComponentRenderInvalidTest.php Tests invalid render options for components.
ComponentRenderTest class Drupal\KernelTests\Components core/tests/Drupal/KernelTests/Components/ComponentRenderTest.php Tests the correct rendering of components.
ComponentRenderTest final class Drupal\KernelTests\Component core/tests/Drupal/KernelTests/Component/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
ComponentValidatorTest class Drupal\Tests\Core\Theme\Component core/tests/Drupal/Tests/Core/Theme/Component/ComponentValidatorTest.php Unit tests for the component validation.
Composer class Drupal\Core\Composer core/lib/Drupal/Core/Composer/Composer.php Provides static functions for composer script events.
Composer class Drupal\Composer composer/Composer.php Provides static functions for composer script events. 9
ComposerBuildTestBase abstract class Drupal\BuildTests\Composer core/tests/Drupal/BuildTests/Composer/ComposerBuildTestBase.php Base class for Composer build tests. 3 3
ComposerHookTest class Drupal\Tests\Composer\Plugin\Scaffold\Functional core/tests/Drupal/Tests/Composer/Plugin/Scaffold/Functional/ComposerHookTest.php Tests Composer Hooks that run scaffold operations.
ComposerInspector class Drupal\package_manager core/modules/package_manager/src/ComposerInspector.php Defines a class to get information from Composer. 22
ComposerInspectorTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerInspectorTest.php Tests Drupal\package_manager\ComposerInspector.
ComposerInstallersTrait trait Drupal\Tests\package_manager\Traits core/modules/package_manager/tests/src/Traits/ComposerInstallersTrait.php A utility for kernel tests that need to use 'composer/installers'. 3
ComposerIntegrationTest class Drupal\Tests core/tests/Drupal/Tests/ComposerIntegrationTest.php Tests Composer integration.
ComposerIntegrationTrait trait Drupal\Tests\Composer core/tests/Drupal/Tests/Composer/ComposerIntegrationTrait.php Some utility functions for testing the Composer integration. 2
ComposerMinimumStabilityValidator final class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/ComposerMinimumStabilityValidator.php Checks that the packages to install meet the minimum stability. 1
ComposerMinimumStabilityValidatorTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerMinimumStabilityValidatorTest.php Tests Composer Minimum Stability Validator.
ComposerNotReadyException final class Drupal\package_manager\Exception core/modules/package_manager/src/Exception/ComposerNotReadyException.php Exception thrown if we cannot reliably use Composer. 2
ComposerPatches class cweagans\Fake core/modules/package_manager/tests/fixtures/path_repos/cweagans--composer-patches/src/ComposerPatches.php Dummy composer plugin implementation.
ComposerPatchesValidator final class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/ComposerPatchesValidator.php Validates the configuration of the cweagans/composer-patches plugin. 1
ComposerPatchesValidatorTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPatchesValidatorTest.php Tests Composer Patches Validator.
ComposerPluginImplementsScaffoldEvents class Drupal\Tests\fixture\Composer\Plugin core/tests/Drupal/Tests/Composer/Plugin/Scaffold/fixtures/composer-plugin-implements-scaffold-events/src/ComposerPluginImplementsScaffoldEvents.php A fixture composer plugin implement Drupal scaffold events.
ComposerPluginsValidator final class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/ComposerPluginsValidator.php Validates the allowed Composer plugins, both in active and stage. 4
ComposerPluginsValidatorComplexInvalidTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorComplexInvalidTest.php Tests Composer Plugins Validator Complex Invalid.
ComposerPluginsValidatorInsecureTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorInsecureTest.php Tests Composer Plugins Validator Insecure.
ComposerPluginsValidatorSimpleInvalidTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorSimpleInvalidTest.php Tests Composer Plugins Validator Simple Invalid.
ComposerPluginsValidatorSimpleValidTest class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorSimpleValidTest.php Tests Composer Plugins Validator Simple Valid.
ComposerPluginsValidatorTestBase abstract class Drupal\Tests\package_manager\Kernel core/modules/package_manager/tests/src/Kernel/ComposerPluginsValidatorTestBase.php @internal 3
ComposerProjectTemplatesTest class Drupal\BuildTests\Composer\Template core/tests/Drupal/BuildTests/Composer/Template/ComposerProjectTemplatesTest.php Demonstrate that Composer project templates can be built as patched.
ComposerRequirementTest class Drupal\Tests\package_manager\Functional core/modules/package_manager/tests/src/Functional/ComposerRequirementTest.php Tests that Package Manager shows the Composer version on the status report.
ComposerRunner final class Drupal\package_manager core/modules/package_manager/src/ComposerRunner.php Runs Composer through the current PHP interpreter. 1 2
ComposerRunnerTest class Drupal\Tests\package_manager\Unit core/modules/package_manager/tests/src/Unit/ComposerRunnerTest.php Tests Package Manager's Composer runner service.
ComposerScaffoldCommand class Drupal\Composer\Plugin\Scaffold composer/Plugin/Scaffold/ComposerScaffoldCommand.php The "drupal:scaffold" command class.
ComposerStagerExceptionTrait trait Drupal\package_manager_bypass core/modules/package_manager/tests/modules/package_manager_bypass/src/ComposerStagerExceptionTrait.php Trait to make Composer Stager throw pre-determined exceptions in tests.
ComposerStagerTestTrait trait Drupal\Tests\package_manager\Traits core/modules/package_manager/tests/src/Traits/ComposerStagerTestTrait.php Contains helper methods for testing Composer Stager interactions. 1
ComposerTest class Drupal\Tests\Composer core/tests/Drupal/Tests/Composer/ComposerTest.php Tests Drupal\Composer\Composer.
ComposerValidateTest class Drupal\BuildTests\Composer core/tests/Drupal/BuildTests/Composer/ComposerValidateTest.php Tests.
ComposerValidator final class Drupal\package_manager\Validator core/modules/package_manager/src/Validator/ComposerValidator.php Validates the project can be used by the Composer Inspector. 1

Other projects

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