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
RouteNameCacheContext class Drupal\Core\Cache\Context core/lib/Drupal/Core/Cache/Context/RouteNameCacheContext.php Defines the RouteCacheContext service, for "per route name" caching. 1 1 2
RouteNoneTest class Drupal\KernelTests\Core\RouteProcessor core/tests/Drupal/KernelTests/Core/RouteProcessor/RouteNoneTest.php Tests the <none> route processor.
RouteObjectInterface interface Drupal\Core\Routing core/lib/Drupal/Core/Routing/RouteObjectInterface.php Provides constants used for retrieving matched routes. 50
RoutePreloader class Drupal\Core\Routing core/lib/Drupal/Core/Routing/RoutePreloader.php Defines a class that can pre-load non-admin routes. 1 2
RoutePreloaderTest class Drupal\Tests\Core\Routing core/tests/Drupal/Tests/Core/Routing/RoutePreloaderTest.php @coversDefaultClass \Drupal\Core\Routing\RoutePreloader[[api-linebreak]] @group Routing
RouteProcessorCsrf class Drupal\Core\Access core/lib/Drupal/Core/Access/RouteProcessorCsrf.php Processes the outbound route to handle the CSRF token. 1 2
RouteProcessorCsrfTest class Drupal\Tests\Core\Access core/tests/Drupal/Tests/Core/Access/RouteProcessorCsrfTest.php @coversDefaultClass \Drupal\Core\Access\RouteProcessorCsrf[[api-linebreak]] @group Access
RouteProcessorCurrent class Drupal\Core\RouteProcessor core/lib/Drupal/Core/RouteProcessor/RouteProcessorCurrent.php Provides a route processor to replace <current>. 2
RouteProcessorCurrentIntegrationTest class Drupal\KernelTests\Core\RouteProcessor core/tests/Drupal/KernelTests/Core/RouteProcessor/RouteProcessorCurrentIntegrationTest.php Tests the <current> route processor.
RouteProcessorManager class Drupal\Core\RouteProcessor core/lib/Drupal/Core/RouteProcessor/RouteProcessorManager.php Route processor manager. 1 2
RouteProcessorManagerTest class Drupal\Tests\Core\RouteProcessor core/tests/Drupal/Tests/Core/RouteProcessor/RouteProcessorManagerTest.php @coversDefaultClass \Drupal\Core\RouteProcessor\RouteProcessorManager[[api-linebreak]] @group RouteProcessor
RouteProvider class Drupal\Core\Routing core/lib/Drupal/Core/Routing/RouteProvider.php A Route Provider front-end for all Drupal-stored routes. 1 2 2
RouteProvider class Drupal\KernelTests core/tests/Drupal/KernelTests/RouteProvider.php Rebuilds the router when the provider is instantiated.
RouteProviderInterface interface Drupal\Core\Routing core/lib/Drupal/Core/Routing/RouteProviderInterface.php Defines the route provider interface. 3 35
RouteProviderLazyBuilder class Drupal\Core\Routing core/lib/Drupal/Core/Routing/RouteProviderLazyBuilder.php A Route Provider front-end for all Drupal-stored routes. 1 1 2
RouteProviderTest class Drupal\KernelTests\Core\Routing core/tests/Drupal/KernelTests/Core/Routing/RouteProviderTest.php Confirm that the default route provider is working correctly.
RouteProviderTest class Drupal\KernelTests\Core\Entity core/tests/Drupal/KernelTests/Core/Entity/RouteProviderTest.php Tests route providers for entity types.
Router class Drupal\Core\Routing core/lib/Drupal/Core/Routing/Router.php Router implementation in Drupal. 2 2
RouterPermissionTest class Drupal\Tests\system\Functional\Routing core/modules/system/tests/src/Functional/Routing/RouterPermissionTest.php Function Tests for the routing permission system.
RouterTest class Drupal\Tests\system\Functional\Routing core/modules/system/tests/src/Functional/Routing/RouterTest.php Functional class for the full integrated routing system.
RouterTest class Drupal\Tests\Core\Routing core/tests/Drupal/Tests/Core/Routing/RouterTest.php @coversDefaultClass \Drupal\Core\Routing\Router[[api-linebreak]] @group Routing
RouterTestEarlyExceptionSubscriber class Drupal\router_test core/modules/system/tests/modules/router_test_directory/src/RouterTestEarlyExceptionSubscriber.php Event subscribers for exceptions thrown in early kernel middleware.
RouterTestServiceProvider class Drupal\router_test core/modules/system/tests/modules/router_test_directory/src/RouterTestServiceProvider.php Registers a dynamic route provider.
RouterUnsupportedTest class Drupal\Tests\Core\Routing core/tests/Drupal/Tests/Core/Routing/RouterUnsupportedTest.php @coversDefaultClass \Drupal\Core\Routing\Router[[api-linebreak]] @group Routing @group legacy
Routes class Drupal\jsonapi\Routing core/modules/jsonapi/src/Routing/Routes.php Defines dynamic routes. 10
Routes class Drupal\menu_link_content_dynamic_route core/modules/menu_link_content/tests/menu_link_content_dynamic_route/src/Routes.php Provides dynamic routes for test purposes.
RoutesTest class Drupal\Tests\jsonapi\Unit\Routing core/modules/jsonapi/tests/src/Unit/Routing/RoutesTest.php @coversDefaultClass \Drupal\jsonapi\Routing\Routes[[api-linebreak]] @group jsonapi
RouteSubscriber class Drupal\config_translation\Routing core/modules/config_translation/src/Routing/RouteSubscriber.php Listens to the dynamic route events. 2
RouteSubscriber class Drupal\media_library\Routing core/modules/media_library/src/Routing/RouteSubscriber.php Subscriber for media library routes. 2
RouteSubscriber class Drupal\media_test_embed\Routing core/modules/media/tests/modules/media_test_embed/src/Routing/RouteSubscriber.php Listens to the dynamic route events. 2
RouteSubscriber class Drupal\node\Routing core/modules/node/src/Routing/RouteSubscriber.php Listens to the dynamic route events. 2
RouteSubscriber class Drupal\views\EventSubscriber core/modules/views/src/EventSubscriber/RouteSubscriber.php Builds up the routes of all views. 1 1 2
RouteSubscriber class Drupal\field_ui\Routing core/modules/field_ui/src/Routing/RouteSubscriber.php Subscriber for Field UI routes. 2
RouteSubscriber class Drupal\block_content\Routing core/modules/block_content/src/Routing/RouteSubscriber.php Subscriber for Block content BC routes. 2
RouteSubscriber class Drupal\user_route_alter_test\Routing core/modules/serialization/tests/modules/user_route_alter_test/src/Routing/RouteSubscriber.php Alter the 'user.pass.http' route.
RouteSubscriberBase abstract class Drupal\Core\Routing core/lib/Drupal/Core/Routing/RouteSubscriberBase.php Provides a base implementation for RouteSubscriber. 18 18
RouteSubscriberTest class Drupal\Tests\views\Unit\EventSubscriber core/modules/views/tests/src/Unit/EventSubscriber/RouteSubscriberTest.php @coversDefaultClass \Drupal\views\EventSubscriber\RouteSubscriber[[api-linebreak]] @group views
RouteTest class Drupal\Tests\migrate\Kernel\process core/modules/migrate/tests/src/Kernel/process/RouteTest.php Tests the route process plugin.
RouteTestSubscriber class Drupal\router_test core/modules/system/tests/modules/router_test_directory/src/RouteTestSubscriber.php Listens to the dynamic route event and add a test route.
RoutingEvents final class Drupal\Core\Routing core/lib/Drupal/Core/Routing/RoutingEvents.php Contains all events thrown in the core routing component. 26
RoutingFixtures class Drupal\Tests\Core\Routing core/tests/Drupal/Tests/Core/Routing/RoutingFixtures.php Utility methods to generate sample data, database configuration, etc. 2
Row class Drupal\migrate core/modules/migrate/src/Row.php Stores a row. 226
RowCountException class Drupal\Core\Database core/lib/Drupal/Core/Database/RowCountException.php Exception thrown if a SELECT query trying to execute rowCount() on result. 3
RowCountExceptionTest class Drupal\Tests\Core\Database core/tests/Drupal/Tests/Core/Database/RowCountExceptionTest.php @coversDefaultClass \Drupal\Core\Database\RowCountException[[api-linebreak]]
RowEntityRenderersTest class Drupal\Tests\views\Kernel\Entity core/modules/views/tests/src/Kernel/Entity/RowEntityRenderersTest.php Tests the entity row renderers.
RowEntityTest class Drupal\Tests\views\Kernel\Plugin core/modules/views/tests/src/Kernel/Plugin/RowEntityTest.php Tests the generic entity row plugin.
RowPluginBase abstract class Drupal\views\Plugin\views\row core/modules/views/src/Plugin/views/row/RowPluginBase.php Base class for Views row plugins. 9 5
RowPluginTest class Drupal\Tests\node\Kernel\Views core/modules/node/tests/src/Kernel/Views/RowPluginTest.php Tests the node row plugin.
RowRenderCacheTest class Drupal\Tests\views\Kernel\Plugin core/modules/views/tests/src/Kernel/Plugin/RowRenderCacheTest.php Tests row render caching.
RowRssTest class Drupal\Tests\comment\Functional\Views core/modules/comment/tests/src/Functional/Views/RowRssTest.php Tests the comment rss row plugin.

Other projects

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