Classes, traits, and interfaces - main - drupal

Primary tabs

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
RoleAccessCheckTest class Drupal\Tests\Core\Route core/tests/Drupal/Tests/Core/Route/RoleAccessCheckTest.php Tests Drupal\user\Access\RoleAccessCheck.
RoleAccessControlHandler class Drupal\user core/modules/user/src/RoleAccessControlHandler.php Defines the access control handler for the user role entity type. 1
RoleExistsConstraint class Drupal\user\Plugin\Validation\Constraint core/modules/user/src/Plugin/Validation/Constraint/RoleExistsConstraint.php Checks if a role exists. 1
RoleExistsConstraintValidator class Drupal\user\Plugin\Validation\Constraint core/modules/user/src/Plugin/Validation/Constraint/RoleExistsConstraintValidator.php Validates that a role exists. 1
RoleExistsConstraintValidatorTest class Drupal\Tests\user\Kernel\Plugin\Validation\Constraint core/modules/user/tests/src/Kernel/Plugin/Validation/Constraint/RoleExistsConstraintValidatorTest.php Tests Role Exists Constraint Validator.
RoleForm class Drupal\user core/modules/user/src/RoleForm.php Form controller for the role entity edit forms. 1
RoleInterface interface Drupal\user core/modules/user/src/RoleInterface.php Provides an interface defining a user role entity. 1 129
RoleJsonAnonTest class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleJsonAnonTest.php Tests Role Json Anon.
RoleJsonBasicAuthTest class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleJsonBasicAuthTest.php Tests Role Json Basic Auth.
RoleJsonCookieTest class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleJsonCookieTest.php Tests Role Json Cookie.
RoleListBuilder class Drupal\user core/modules/user/src/RoleListBuilder.php Defines a class to build a listing of user role entities. 1
RoleResourceTestBase abstract class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleResourceTestBase.php Resource test base for the UserRole entity. 6
Roles class Drupal\user\Plugin\views\field core/modules/user/src/Plugin/views/field/Roles.php Field handler to provide a list of roles.
Roles class Drupal\user\Plugin\views\filter core/modules/user/src/Plugin/views/filter/Roles.php Filter handler for user roles.
RoleSettingsForm class Drupal\user\Form core/modules/user/src/Form/RoleSettingsForm.php Configure administrator role settings for this site.
RolesLookup

in drupal:11.3.0 and is removed from drupal:12.0.0. There is no replacement.

class Drupal\block\Plugin\migrate\process core/modules/block/src/Plugin/migrate/process/RolesLookup.php Gets the destination roles ID for an array of source roles IDs.
RolesRid class Drupal\user\Plugin\views\argument core/modules/user/src/Plugin/views/argument/RolesRid.php Allow role ID(s) as argument. 1
RolesRidArgumentTest class Drupal\Tests\user\Functional\Views core/modules/user/tests/src/Functional/Views/RolesRidArgumentTest.php Tests the handler of the user: roles argument.
RolesRidTest class Drupal\Tests\user\Unit\Views\Argument core/modules/user/tests/src/Unit/Views/Argument/RolesRidTest.php Tests Drupal\user\Plugin\views\argument\RolesRid.
RoleStorage class Drupal\user core/modules/user/src/RoleStorage.php Defines the storage handler class for user roles. 1
RoleStorageInterface interface Drupal\user core/modules/user/src/RoleStorageInterface.php Defines an interface for role entity storage classes. 1 8
RoleTest class Drupal\Tests\jsonapi\Functional core/modules/jsonapi/tests/src/Functional/RoleTest.php JSON:API integration test for the "Role" config entity type.
RoleTest class Drupal\Tests\user\Kernel\Plugin\migrate\source\d6 core/modules/user/tests/src/Kernel/Plugin/migrate/source/d6/RoleTest.php Tests the d6_user_role source plugin.
RoleTest class Drupal\Tests\user\Kernel\Plugin\migrate\source\d7 core/modules/user/tests/src/Kernel/Plugin/migrate/source/d7/RoleTest.php Tests the d7_user_role source plugin.
RoleUserTestBase abstract class Drupal\Tests\user\Unit\Plugin\Action core/modules/user/tests/src/Unit/Plugin/Action/RoleUserTestBase.php Provides a base class for user role action tests. 2
RoleValidationTest class Drupal\Tests\user\Kernel core/modules/user/tests/src/Kernel/RoleValidationTest.php Tests validation of user_role entities.
RoleXmlAnonTest class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleXmlAnonTest.php Tests Role Xml Anon.
RoleXmlBasicAuthTest class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleXmlBasicAuthTest.php Tests Role Xml Basic Auth.
RoleXmlCookieTest class Drupal\Tests\user\Functional\Rest core/modules/user/tests/src/Functional/Rest/RoleXmlCookieTest.php Tests Role Xml Cookie.
RollbackAwareInterface interface Drupal\migrate\Event core/modules/migrate/src/Event/RollbackAwareInterface.php Interface for plugins that react to pre- or post-rollback events. 1 2
RollbackFieldInstanceTest class Drupal\Tests\field\Kernel\Migrate\d7 core/modules/field/tests/src/Kernel/Migrate/d7/RollbackFieldInstanceTest.php Migrates and rolls back Drupal 7 fields.
RollbackFieldTest class Drupal\Tests\field\Kernel\Migrate\d7 core/modules/field/tests/src/Kernel/Migrate/d7/RollbackFieldTest.php Migrates and rolls back Drupal 7 fields.
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
Route class Drupal\Core\Routing\Attribute core/lib/Drupal/Core/Routing/Attribute/Route.php Adds Drupal-specific properties to the Symfony Route attribute. 17
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 9
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.

Other projects


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