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
RollbackTest class Drupal\FunctionalTests\Core\Recipe core/tests/Drupal/FunctionalTests/Core/Recipe/RollbackTest.php Tests Rollback.
RollbackViewModesTest class Drupal\Tests\field\Kernel\Migrate\d7 core/modules/field/tests/src/Kernel/Migrate/d7/RollbackViewModesTest.php Migrates and rolls back Drupal 7 view modes.
RootComposer final class Drupal\Composer\Plugin\RecipeUnpack composer/Plugin/RecipeUnpack/RootComposer.php Provides access to and manipulation of the root composer files.
Rotate class Drupal\system\Plugin\ImageToolkit\Operation\gd core/modules/system/src/Plugin/ImageToolkit/Operation/gd/Rotate.php Defines GD2 rotate operation.
RotateImageEffect class Drupal\image\Plugin\ImageEffect core/modules/image/src/Plugin/ImageEffect/RotateImageEffect.php Rotates an image resource.
Route class Drupal\migrate\Plugin\migrate\process core/modules/migrate/src/Plugin/migrate/process/Route.php Sets the destination route information based on the source link_path. 1
Route class Drupal\Tests\Component\Annotation\Doctrine\Fixtures\Annotation core/tests/Drupal/Tests/Component/Annotation/Doctrine/Fixtures/Annotation/Route.php
RouteAccessResponseSubscriber class Drupal\Core\EventSubscriber core/lib/Drupal/Core/EventSubscriber/RouteAccessResponseSubscriber.php Response subscriber to bubble the route's access result's cacheability. 2
RouteAliasUpdateTest class Drupal\Tests\system\Functional\Update core/modules/system/tests/src/Functional/Update/RouteAliasUpdateTest.php Tests the upgrade path for the router table update.
RouteBuilder class Drupal\Core\ProxyClass\Routing core/lib/Drupal/Core/ProxyClass/Routing/RouteBuilder.php Provides a proxy class for \Drupal\Core\Routing\RouteBuilder.
RouteBuilder class Drupal\Core\Routing core/lib/Drupal/Core/Routing/RouteBuilder.php Managing class for rebuilding the router table. 1 2 2
RouteBuilderInterface interface Drupal\Core\Routing core/lib/Drupal/Core/Routing/RouteBuilderInterface.php Rebuilds the route information and dumps it. 2 8
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. 23
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 246
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
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 4 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 57
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. 3 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.
RouterListener class Drupal\Core\Http\EventListener core/lib/Drupal/Core/Http/EventListener/RouterListener.php Sets request attributes based on a matching route. 2
RouterPermissionTest class Drupal\Tests\system\Functional\Routing core/modules/system/tests/src/Functional/Routing/RouterPermissionTest.php Function Tests for the routing permission system.

Other projects

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