Classes, traits, and interfaces - 10.3.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
AreaPluginBase abstract class Drupal\views\Plugin\views\area core/modules/views/src/Plugin/views/area/AreaPluginBase.php Base class for area handler plugins. 11 4
AreaResultTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaResultTest.php Tests the result area handler.
AreaTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaTest.php Tests the plugin base of the area handler.
AreaTest class Drupal\Tests\views\Functional\Handler core/modules/views/tests/src/Functional/Handler/AreaTest.php Tests the plugin base of the area handler.
AreaTextTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaTextTest.php Tests the core views_handler_area_text handler.
AreaTextTokenTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaTextTokenTest.php Tests the token in text area handler.
AreaTitleTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaTitleTest.php Tests the title area handler.
AreaTitleWebTest class Drupal\Tests\views\Functional\Handler core/modules/views/tests/src/Functional/Handler/AreaTitleWebTest.php Tests the title area handler with a web test.
AreaViewTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/AreaViewTest.php Tests the view area handler.
ArgumentDateTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/ArgumentDateTest.php Tests the core date argument handlers.
ArgumentDateTimeTest class Drupal\Tests\datetime\Kernel\Views core/modules/datetime/tests/src/Kernel/Views/ArgumentDateTimeTest.php Tests the Drupal\datetime\Plugin\views\filter\Date handler.
ArgumentDefaultPluginBase abstract class Drupal\views\Plugin\views\argument_default core/modules/views/src/Plugin/views/argument_default/ArgumentDefaultPluginBase.php The fixed argument default handler; also used as the base. 8 5
ArgumentDefaultTest class Drupal\Tests\views\Functional\Plugin core/modules/views/tests/src/Functional/Plugin/ArgumentDefaultTest.php Tests pluggable argument_default for views.
ArgumentDefaultTest class Drupal\views_test_data\Plugin\views\argument_default core/modules/views/tests/modules/views_test_data/src/Plugin/views/argument_default/ArgumentDefaultTest.php Defines an argument default test plugin. 1
ArgumentDefaultTest class Drupal\Tests\user\Kernel\Views core/modules/user/tests/src/Kernel/Views/ArgumentDefaultTest.php Tests views user argument default plugin.
ArgumentLanguageTest class Drupal\Tests\language\Kernel\Views core/modules/language/tests/src/Kernel/Views/ArgumentLanguageTest.php Tests the argument language handler.
ArgumentNodeRevisionIdTest class Drupal\Tests\node\Kernel\Views core/modules/node/tests/src/Kernel/Views/ArgumentNodeRevisionIdTest.php Tests the node_vid handler.
ArgumentNullTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/ArgumentNullTest.php Tests the core Drupal\views\Plugin\views\argument\NullArgument handler.
ArgumentPluginBase abstract class Drupal\views\Plugin\views\argument core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php Base class for argument (contextual filter) handler plugins. 13 9
ArgumentsAllNull class Drupal\Tests\Component\Plugin\Factory core/tests/Drupal/Tests/Component/Plugin/Factory/ReflectionFactoryTest.php A stub class used by testGetInstanceArguments().
ArgumentsConfigArrayKey class Drupal\Tests\Component\Plugin\Factory core/tests/Drupal/Tests/Component/Plugin/Factory/ReflectionFactoryTest.php A stub class used by testGetInstanceArguments().
ArgumentsMany class Drupal\Tests\Component\Plugin\Factory core/tests/Drupal/Tests/Component/Plugin/Factory/ReflectionFactoryTest.php A stub class used by testGetInstanceArguments().
ArgumentsNoConstructor class Drupal\Tests\Component\Plugin\Factory core/tests/Drupal/Tests/Component/Plugin/Factory/ReflectionFactoryTest.php A stub class used by testGetInstanceArguments().
ArgumentsPluginId class Drupal\Tests\Component\Plugin\Factory core/tests/Drupal/Tests/Component/Plugin/Factory/ReflectionFactoryTest.php A stub class used by testGetInstanceArguments().
ArgumentsResolver class Drupal\Component\Utility core/lib/Drupal/Component/Utility/ArgumentsResolver.php Resolves the arguments to pass to a callable. 3
ArgumentsResolverInterface interface Drupal\Component\Utility core/lib/Drupal/Component/Utility/ArgumentsResolverInterface.php Resolves the arguments to pass to a callable. 1 1
ArgumentsResolverTest class Drupal\Tests\Component\Utility core/tests/Drupal/Tests/Component/Utility/ArgumentsResolverTest.php @coversDefaultClass \Drupal\Component\Utility\ArgumentsResolver @group Access
ArgumentStringTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/ArgumentStringTest.php Tests the core Drupal\views\Plugin\views\argument\StringArgument handler.
ArgumentSummaryTest class Drupal\Tests\views\Kernel\Handler core/modules/views/tests/src/Kernel/Handler/ArgumentSummaryTest.php Tests the summary of results when an argument is not provided.
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 @coversDefaultClass \Drupal\migrate\Plugin\migrate\process\ArrayBuild @group migrate
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. 9
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 @coversDefaultClass \Drupal\KernelTests\AssertContentTrait @group Test
AssertMailTrait trait Drupal\Core\Test core/lib/Drupal/Core/Test/AssertMailTrait.php Provides methods for testing emails sent during test runs. 15
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.

Other projects

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