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
RouteBuilderTest		class	Drupal\Tests\Core\Routing	core/tests/Drupal/Tests/Core/Routing/RouteBuilderTest.php	Tests Drupal\Core\Routing\RouteBuilder.
RouteBuildEvent		class	Drupal\Core\Routing	core/lib/Drupal/Core/Routing/RouteBuildEvent.php	Represents route building information as event.		22
RouteCacheContext		class	Drupal\Core\Cache\Context	core/lib/Drupal/Core/Cache/Context/RouteCacheContext.php	Defines the RouteCacheContext service, for "per route" caching.	1		2
RouteCachingLanguageTest		class	Drupal\FunctionalTests\Routing	core/tests/Drupal/FunctionalTests/Routing/RouteCachingLanguageTest.php	Tests that route lookup is cached by the current language.
RouteCachingNonPathLanguageNegotiationTest		class	Drupal\FunctionalTests\Routing	core/tests/Drupal/FunctionalTests/Routing/RouteCachingNonPathLanguageNegotiationTest.php	Tests the route cache when the language is not in the path.
RouteCachingQueryAlteredTest		class	Drupal\FunctionalTests\Routing	core/tests/Drupal/FunctionalTests/Routing/RouteCachingQueryAlteredTest.php	Tests the route cache when the request's query parameters are altered.
RouteCompiler		class	Drupal\Core\Routing	core/lib/Drupal/Core/Routing/RouteCompiler.php	Compiler to generate derived information from a Route necessary for matching.		6
RouteCompilerTest		class	Drupal\Tests\Core\Routing	core/tests/Drupal/Tests/Core/Routing/RouteCompilerTest.php	Tests Drupal\Core\Routing\RouteCompiler.
RouteEnhancer		class	Drupal\jsonapi\Routing	core/modules/jsonapi/src/Routing/RouteEnhancer.php	Ensures the loaded entity matches the requested resource type.			2
RouteMatch		class	Drupal\Core\Routing	core/lib/Drupal/Core/Routing/RouteMatch.php	Default object representing the results of routing.		28
RouteMatchInterface		interface	Drupal\Core\Routing	core/lib/Drupal/Core/Routing/RouteMatchInterface.php	Provides an interface for classes representing the result of routing.	3	244
RouteMatchTest		class	Drupal\Tests\Core\Routing	core/tests/Drupal/Tests/Core/Routing/RouteMatchTest.php	Tests Drupal\Core\Routing\RouteMatch.
RouteMatchTestBase		abstract class	Drupal\Tests\Core\Routing	core/tests/Drupal/Tests/Core/Routing/RouteMatchTestBase.php	Base test class for testing classes implementing the route match interface.	2
RouteMatchValueResolver		final class	Drupal\Core\Controller\ArgumentResolver	core/lib/Drupal/Core/Controller/ArgumentResolver/RouteMatchValueResolver.php	Yields a RouteMatch object based on the request object passed along.			2
RouteMethodSubscriber		class	Drupal\Core\EventSubscriber	core/lib/Drupal/Core/EventSubscriber/RouteMethodSubscriber.php	Provides a default value for the HTTP method restriction on routes.			2
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.		53
RoutePathGenerationTrait		trait	Drupal\Core\Access	core/lib/Drupal/Core/Access/RoutePathGenerationTrait.php	Provides a method for generating route paths.		1
RoutePathGenerationTraitTest		class	Drupal\Tests\Core\Access	core/tests/Drupal/Tests/Core/Access/RoutePathGenerationTraitTest.php	Tests Route Path Generation Trait.
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	Tests Drupal\Core\Routing\RoutePreloader.
RouteProcessorCsrf		class	Drupal\Core\Access	core/lib/Drupal/Core/Access/RouteProcessorCsrf.php	Processes the outbound route to handle the CSRF token.		2	2
RouteProcessorCsrfTest		class	Drupal\Tests\Core\Access	core/tests/Drupal/Tests/Core/Access/RouteProcessorCsrfTest.php	Tests Drupal\Core\Access\RouteProcessorCsrf.
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.		3	2
RouteProcessorManagerTest		class	Drupal\Tests\Core\RouteProcessor	core/tests/Drupal/Tests/Core/RouteProcessor/RouteProcessorManagerTest.php	Tests Drupal\Core\RouteProcessor\RouteProcessorManager.
RouteProvider		class	Drupal\Core\Routing	core/lib/Drupal/Core/Routing/RouteProvider.php	A Route Provider front-end for all Drupal-stored routes.	1	3	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	56
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
RouterInstallerTestHooks		class	Drupal\router_installer_test\Hook	core/modules/system/tests/modules/router_installer_test/src/Hook/RouterInstallerTestHooks.php	Hook implementations for router_installer_test.
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	Tests Drupal\Core\Routing\Router.
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.
RouterTestThemeHooks		class	Drupal\router_test\Hook	core/modules/system/tests/modules/router_test_directory/src/Hook/RouterTestThemeHooks.php	Hook implementations for router_test.
RouterUnsupportedTest		class	Drupal\Tests\Core\Routing	core/tests/Drupal/Tests/Core/Routing/RouterUnsupportedTest.php	Tests Drupal\Core\Routing\Router.
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	Tests Drupal\jsonapi\Routing\Routes.
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\node\Routing	core/modules/node/src/Routing/RouteSubscriber.php	Listens to the dynamic route events.			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

Other projects

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