Classes, traits, and interfaces - main - 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
ArgumentTransformTermTest class Drupal\Tests\taxonomy\Kernel\Views core/modules/taxonomy/tests/src/Kernel/Views/ArgumentTransformTermTest.php Tests taxonomy term argument transformation.
ArgumentUidRevisionTest class Drupal\Tests\node\Kernel\Views core/modules/node/tests/src/Kernel/Views/ArgumentUidRevisionTest.php Tests the argument_node_uid_revision handler.
ArgumentValidateTest class Drupal\Tests\user\Kernel\Views core/modules/user/tests/src/Kernel/Views/ArgumentValidateTest.php Tests user argument validators for ID and name.
ArgumentValidatorPluginBase abstract class Drupal\views\Plugin\views\argument_validator core/modules/views/src/Plugin/views/argument_validator/ArgumentValidatorPluginBase.php Base argument validator plugin to provide basic functionality. 4 1
ArgumentValidatorTermNameTest class Drupal\Tests\taxonomy\Kernel\Views core/modules/taxonomy/tests/src/Kernel/Views/ArgumentValidatorTermNameTest.php Tests the plugin of the taxonomy: taxonomy_term_name argument validator.
ArgumentValidatorTermTest class Drupal\Tests\taxonomy\Kernel\Views core/modules/taxonomy/tests/src/Kernel/Views/ArgumentValidatorTermTest.php Tests the plugin of the taxonomy: term argument validator.
ArgumentValidatorTest class Drupal\Tests\views_ui\Functional core/modules/views_ui/tests/src/Functional/ArgumentValidatorTest.php Tests the Argument validator through the UI.
ArgumentValidatorTest class Drupal\Tests\views\Kernel\Plugin core/modules/views/tests/src/Kernel/Plugin/ArgumentValidatorTest.php Tests Views argument validators.
ArgumentValidatorTest class Drupal\views_test_data\Plugin\views\argument_validator core/modules/views/tests/modules/views_test_data/src/Plugin/views/argument_validator/ArgumentValidatorTest.php Defines an argument validator test plugin. 1
ArrayBuild class Drupal\migrate\Plugin\migrate\process core/modules/migrate/src/Plugin/migrate/process/ArrayBuild.php Builds an array based on the key and value configuration. 1 2
ArrayBuildTest class Drupal\Tests\migrate\Unit\process core/modules/migrate/tests/src/Unit/process/ArrayBuildTest.php Tests Drupal\migrate\Plugin\migrate\process\ArrayBuild.
ArrayElement abstract class Drupal\Core\Config\Schema core/lib/Drupal/Core/Config/Schema/ArrayElement.php Defines a generic configuration element that contains multiple properties. 2 1
AssertBlockAppearsTrait trait Drupal\Tests\block\Functional core/modules/block/tests/src/Functional/AssertBlockAppearsTrait.php Provides test assertions for testing block appearance. 2
AssertBreadcrumbTrait trait Drupal\Tests\system\Functional\Menu core/modules/system/tests/src/Functional/Menu/AssertBreadcrumbTrait.php Provides test assertions for verifying breadcrumbs. 11
AssertConfigEntityImportTrait trait Drupal\Tests\config\Traits core/modules/config/tests/src/Traits/AssertConfigEntityImportTrait.php Provides test assertions for testing config entity synchronization. 1
AssertConfigTrait trait Drupal\KernelTests core/tests/Drupal/KernelTests/AssertConfigTrait.php Trait to help with diffing config. 4
AssertContentTrait trait Drupal\KernelTests core/tests/Drupal/KernelTests/AssertContentTrait.php Provides test methods to assert content. 1
AssertContentTraitTest class Drupal\Tests\Core\Test core/tests/Drupal/Tests/Core/Test/AssertContentTraitTest.php Tests Drupal\KernelTests\AssertContentTrait.
AssertMailTrait trait Drupal\Core\Test core/lib/Drupal/Core/Test/AssertMailTrait.php Provides methods for testing emails sent during test runs. 16
AssertMailTraitTest class Drupal\KernelTests\Core\Test core/tests/Drupal/KernelTests/Core/Test/AssertMailTraitTest.php Tests \Drupal\Core\Test\AssertMailTrait works.
AssertMenuActiveTrailTrait trait Drupal\Tests\system\Functional\Menu core/modules/system/tests/src/Functional/Menu/AssertMenuActiveTrailTrait.php Provides test assertions for verifying the active menu trail.
AssertPageCacheContextsAndTagsTrait trait Drupal\Tests\system\Functional\Cache core/modules/system/tests/src/Functional/Cache/AssertPageCacheContextsAndTagsTrait.php Provides test assertions for testing page-level cache contexts & tags. 42
AssertPreconditionsTrait trait Drupal\Tests\package_manager\Traits core/modules/package_manager/tests/src/Traits/AssertPreconditionsTrait.php Asserts preconditions for tests to function properly. 4
AssertUtilsTrait trait Drupal\Tests\Composer\Plugin\Scaffold core/tests/Drupal/Tests/Composer/Plugin/Scaffold/AssertUtilsTrait.php Convenience class for creating fixtures. 4
AssertViewsCacheTagsTrait trait Drupal\views\Tests core/modules/views/src/Tests/AssertViewsCacheTagsTrait.php Provides assert methods for testing Views cache tags. 3
AssetAggregationAcrossPagesTest class Drupal\Tests\demo_umami\FunctionalJavascript core/profiles/demo_umami/tests/src/FunctionalJavascript/AssetAggregationAcrossPagesTest.php Tests demo_umami profile performance.
AssetCollectionGrouperInterface interface Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetCollectionGrouperInterface.php Interface defining a service that logically groups a collection of assets. 2 2
AssetCollectionGroupOptimizerInterface interface Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetCollectionGroupOptimizerInterface.php Interface defining a service that optimizes a collection of assets. 2
AssetCollectionOptimizerInterface interface Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetCollectionOptimizerInterface.php Interface defining a service that optimizes a collection of assets. 1 3
AssetCollectionRendererInterface interface Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetCollectionRendererInterface.php Interface defining a service that generates a render array to render assets. 2 4
AssetCompressUpdatePathTest class Drupal\Tests\system\Functional\Update core/modules/system/tests/src/Functional/Update/AssetCompressUpdatePathTest.php Tests the upgrade path renaming system.performance gzip keys to compress.
AssetControllerBase abstract class Drupal\system\Controller core/modules/system/src/Controller/AssetControllerBase.php Defines a controller to serve asset aggregates. 2
AssetDumper class Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetDumper.php Dumps a CSS or JavaScript asset. 3
AssetDumperInterface interface Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetDumperInterface.php Interface defining a service that dumps an (optimized) asset. 1
AssetDumperUriInterface interface Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetDumperUriInterface.php Interface defining a service that dumps an asset to a specified location. 1 1
AssetGroupSetHashTrait trait Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetGroupSetHashTrait.php Provides a method to generate a normalized hash of a given asset group set. 3
AssetOptimizationTest class Drupal\FunctionalTests\Asset core/tests/Drupal/FunctionalTests/Asset/AssetOptimizationTest.php Tests asset aggregation. 1
AssetOptimizationUmamiTest class Drupal\FunctionalTests\Asset core/tests/Drupal/FunctionalTests/Asset/AssetOptimizationUmamiTest.php Tests asset aggregation with the Umami install profile.
AssetOptimizerInterface interface Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetOptimizerInterface.php Interface defining a service that optimizes an asset. 2 1
AssetQueryString class Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetQueryString.php Stores a cache busting query string service for asset URLs. 1 2
AssetQueryStringInterface interface Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetQueryStringInterface.php Provides a cache busting query string service for asset URLs. 1 6
AssetQueryStringTest class Drupal\KernelTests\Core\Asset core/tests/Drupal/KernelTests/Core/Asset/AssetQueryStringTest.php Tests the asset query string functionality.
AssetResolver class Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetResolver.php The default asset resolver. 1 2
AssetResolverInterface interface Drupal\Core\Asset core/lib/Drupal/Core/Asset/AssetResolverInterface.php Resolves asset libraries into concrete CSS and JavaScript assets. 1 5
AssetResolverTest class Drupal\Tests\Core\Asset core/tests/Drupal/Tests/Core/Asset/AssetResolverTest.php Tests Drupal\Core\Asset\AssetResolver.
AssetRoutes class Drupal\system\Routing core/modules/system/src/Routing/AssetRoutes.php Defines a routes' callback to register a URL for serving assets.
AssetsStream class Drupal\Core\StreamWrapper core/lib/Drupal/Core/StreamWrapper/AssetsStream.php Defines a Drupal stream wrapper class for optimized assets (assets://). 1 2
AssetXssTest class Drupal\FunctionalTests\Asset core/tests/Drupal/FunctionalTests/Asset/AssetXssTest.php Tests sanitization of error messages emitted by AssetControllerBase.
AtLeastOneOfConstraint class Drupal\Core\Validation\Plugin\Validation\Constraint core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/AtLeastOneOfConstraint.php Checks that at least one of the given constraint is satisfied. 1
AtLeastOneOfConstraintValidatorTest class Drupal\KernelTests\Core\Validation core/tests/Drupal/KernelTests/Core/Validation/AtLeastOneOfConstraintValidatorTest.php Tests AtLeastOneOf validation constraint with both valid and invalid values.

Other projects

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