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
TipPluginTextLegacy class Drupal\tour_test\Plugin\tour\tip core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginTextLegacy.php Displays some text as a tip.
TipsPluginCollection class Drupal\tour core/modules/tour/src/TipsPluginCollection.php A collection of tips. 1
Title class Drupal\views\Plugin\views\area core/modules/views/src/Plugin/views/area/Title.php Views area title override handler.
TitleBlockPluginInterface interface Drupal\Core\Block core/lib/Drupal/Core/Block/TitleBlockPluginInterface.php The interface for "title" blocks. 1 3
TitleCallback class Drupal\Tests\Core\Controller core/tests/Drupal/Tests/Core/Controller/TitleResolverTest.php Provides an example title callback for the testDynamicTitle method above.
TitleResolver class Drupal\Core\Controller core/lib/Drupal/Core/Controller/TitleResolver.php Provides the default implementation of the title resolver interface. 1 2
TitleResolverInterface interface Drupal\Core\Controller core/lib/Drupal/Core/Controller/TitleResolverInterface.php Defines a class which knows how to generate the title from a given route. 1 6
TitleResolverTest class Drupal\Tests\Core\Controller core/tests/Drupal/Tests/Core/Controller/TitleResolverTest.php @coversDefaultClass \Drupal\Core\Controller\TitleResolver[[api-linebreak]] @group Controller
Token class Drupal\Core\Utility core/lib/Drupal/Core/Utility/Token.php Drupal placeholder/token replacement system. 11 2
Token class Drupal\Core\Render\Element core/lib/Drupal/Core/Render/Element/Token.php Stores token data in a hidden form field. 1
TokenizeAreaPluginBase abstract class Drupal\views\Plugin\views\area core/modules/views/src/Plugin/views/area/TokenizeAreaPluginBase.php Tokenized base class for area handlers. 3
TokenizeAreaUITest class Drupal\Tests\views_ui\Functional core/modules/views_ui/tests/src/Functional/TokenizeAreaUITest.php Tests the token display for the TokenizeAreaPluginBase UI.
TokenReplaceKernelTest class Drupal\Tests\system\Kernel\Token core/modules/system/tests/src/Kernel/Token/TokenReplaceKernelTest.php Tests token replacement.
TokenReplaceKernelTestBase abstract class Drupal\Tests\system\Kernel\Token core/modules/system/tests/src/Kernel/Token/TokenReplaceKernelTestBase.php Base class for token replacement tests. 2 1
TokenReplaceTest class Drupal\Tests\views\Kernel core/modules/views/tests/src/Kernel/TokenReplaceTest.php Tests core view token replacement.
TokenReplaceTest class Drupal\Tests\taxonomy\Kernel core/modules/taxonomy/tests/src/Kernel/TokenReplaceTest.php Tests taxonomy token replacement.
TokenReplaceWebTest class Drupal\Tests\system\Functional\System core/modules/system/tests/src/Functional/System/TokenReplaceWebTest.php Tests the token system integration.
TokenTest class Drupal\Tests\Core\Render\Element core/tests/Drupal/Tests/Core/Render/Element/TokenTest.php @coversDefaultClass \Drupal\Core\Render\Element\Token[[api-linebreak]] @group Render
TokenTest class Drupal\Tests\Core\Utility core/tests/Drupal/Tests/Core/Utility/TokenTest.php @coversDefaultClass \Drupal\Core\Utility\Token[[api-linebreak]] @group Utility
Toolbar class Drupal\toolbar\Element core/modules/toolbar/src/Element/Toolbar.php Provides a render element for the default Drupal toolbar.
ToolbarActiveTrailTest class Drupal\Tests\toolbar\FunctionalJavascript core/modules/toolbar/tests/src/FunctionalJavascript/ToolbarActiveTrailTest.php Tests that the active trail is maintained in the toolbar.
ToolbarAdminMenuTest class Drupal\Tests\toolbar\Functional core/modules/toolbar/tests/src/Functional/ToolbarAdminMenuTest.php Tests the caching of the admin menu subtree items.
ToolbarCacheContextsTest class Drupal\Tests\toolbar\Functional core/modules/toolbar/tests/src/Functional/ToolbarCacheContextsTest.php Tests the cache contexts for toolbar.
ToolbarClaroOverridesTest class Drupal\Tests\system\Functional\Theme core/modules/system/tests/src/Functional/Theme/ToolbarClaroOverridesTest.php Tests the loading of Claro assets on a non-Claro default theme.
ToolbarController class Drupal\toolbar\Controller core/modules/toolbar/src/Controller/ToolbarController.php Defines a controller for the toolbar module. 1
ToolbarHookToolbarTest class Drupal\Tests\toolbar\Functional core/modules/toolbar/tests/src/Functional/ToolbarHookToolbarTest.php Tests the implementation of hook_toolbar() by a module.
ToolbarIntegrationTest class Drupal\Tests\toolbar\FunctionalJavascript core/modules/toolbar/tests/src/FunctionalJavascript/ToolbarIntegrationTest.php Tests the JavaScript functionality of the toolbar.
ToolbarItem class Drupal\toolbar\Element core/modules/toolbar/src/Element/ToolbarItem.php Provides a toolbar item that is wrapped in markup for common styling.
ToolbarItemConditionsMetConstraint class Drupal\ckeditor5\Plugin\Validation\Constraint core/modules/ckeditor5/src/Plugin/Validation/Constraint/ToolbarItemConditionsMetConstraint.php A (placed) CKEditor 5 toolbar item's conditions must be met.
ToolbarItemConditionsMetConstraintValidator class Drupal\ckeditor5\Plugin\Validation\Constraint core/modules/ckeditor5/src/Plugin/Validation/Constraint/ToolbarItemConditionsMetConstraintValidator.php Toolbar item conditions met constraint validator.
ToolbarItemConstraint class Drupal\ckeditor5\Plugin\Validation\Constraint core/modules/ckeditor5/src/Plugin/Validation/Constraint/ToolbarItemConstraint.php A CKEditor 5 toolbar item.
ToolbarItemConstraintValidator class Drupal\ckeditor5\Plugin\Validation\Constraint core/modules/ckeditor5/src/Plugin/Validation/Constraint/ToolbarItemConstraintValidator.php Toolbar item constraint validator.
ToolbarItemDependencyConstraint class Drupal\ckeditor5\Plugin\Validation\Constraint core/modules/ckeditor5/src/Plugin/Validation/Constraint/ToolbarItemDependencyConstraint.php A CKEditor 5 toolbar item.
ToolbarItemDependencyConstraintValidator class Drupal\ckeditor5\Plugin\Validation\Constraint core/modules/ckeditor5/src/Plugin/Validation/Constraint/ToolbarItemDependencyConstraintValidator.php Toolbar item dependency constraint validator.
ToolbarLinkBuilder class Drupal\user core/modules/user/src/ToolbarLinkBuilder.php ToolbarLinkBuilder fills out the placeholders generated in user_toolbar(). 1 2
ToolbarLinkBuilderTest class Drupal\Tests\user\Unit core/modules/user/tests/src/Unit/ToolbarLinkBuilderTest.php Tests user's ToolbarLinkBuilder.
ToolbarMenuLinkTree class Drupal\toolbar\Menu core/modules/toolbar/src/Menu/ToolbarMenuLinkTree.php Extends MenuLinkTree to add specific theme suggestions for the toolbar. 2
ToolbarMenuTranslationTest class Drupal\Tests\toolbar\Functional core/modules/toolbar/tests/src/Functional/ToolbarMenuTranslationTest.php Tests that the toolbar icon class remains for translated menu items.
ToolbarStoredStateTest class Drupal\Tests\toolbar\FunctionalJavascript core/modules/toolbar/tests/src/FunctionalJavascript/ToolbarStoredStateTest.php Tests the sessionStorage state set by the toolbar.
ToolkitGdTest class Drupal\KernelTests\Core\Image core/tests/Drupal/KernelTests/Core/Image/ToolkitGdTest.php Tests for the GD image toolkit.
ToolkitSetupFormTest class Drupal\FunctionalTests\Image core/tests/Drupal/FunctionalTests/Image/ToolkitSetupFormTest.php Tests image toolkit setup form.
ToolkitTest class Drupal\KernelTests\Core\Image core/tests/Drupal/KernelTests/Core/Image/ToolkitTest.php Tests the image toolkit.
ToolkitTestTrait trait Drupal\Tests\Traits\Core\Image core/tests/Drupal/Tests/Traits/Core/Image/ToolkitTestTrait.php Provides common methods for image toolkit kernel tests. 2
TopLevelBook class Drupal\book\Plugin\views\argument_default core/modules/book/src/Plugin/views/argument_default/TopLevelBook.php Default argument plugin to get the current node's top level book.
TopLevelDataInterface interface Drupal\jsonapi\JsonApiResource core/modules/jsonapi/src/JsonApiResource/TopLevelDataInterface.php Interface for objects that can appear as top-level object data. 2 1
ToStringTrait trait Drupal\Component\Utility core/lib/Drupal/Component/Utility/ToStringTrait.php Wraps __toString in a trait to avoid some fatal errors. 2
Tour class Drupal\tour\Entity core/modules/tour/src/Entity/Tour.php Defines the configured tour entity. 6
TourAccessControlHandler class Drupal\tour core/modules/tour/src/TourAccessControlHandler.php Defines the access control handler for the tour entity type.
TourCacheTagsTest class Drupal\Tests\tour\Functional core/modules/tour/tests/src/Functional/TourCacheTagsTest.php Tests the Tour entity's cache tags.
TourHelpPageTest class Drupal\Tests\tour\Functional core/modules/tour/tests/src/Functional/TourHelpPageTest.php Verifies help page display of tours.

Other projects

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