interface RoleStorageInterface

Same name in other branches
  1. 8.9.x core/modules/user/src/RoleStorageInterface.php \Drupal\user\RoleStorageInterface
  2. 10 core/modules/user/src/RoleStorageInterface.php \Drupal\user\RoleStorageInterface
  3. 11.x core/modules/user/src/RoleStorageInterface.php \Drupal\user\RoleStorageInterface

Defines an interface for role entity storage classes.

Hierarchy

Expanded class hierarchy of RoleStorageInterface

All classes that implement RoleStorageInterface

6 files declare their use of RoleStorageInterface
EntityPermissionsForm.php in core/modules/user/src/Form/EntityPermissionsForm.php
EntityPermissionsFormTest.php in core/modules/user/tests/src/Unit/Form/EntityPermissionsFormTest.php
Role.php in core/modules/user/src/Plugin/views/access/Role.php
Roles.php in core/modules/user/src/Plugin/views/filter/Roles.php
RoleSettingsForm.php in core/modules/user/src/Form/RoleSettingsForm.php

... See full list

File

core/modules/user/src/RoleStorageInterface.php, line 10

Namespace

Drupal\user
View source 
interface RoleStorageInterface extends ConfigEntityStorageInterface {
    
    /**
     * Returns whether a permission is in one of the passed in roles.
     *
     * @param string $permission
     *   The permission.
     * @param array $rids
     *   The list of role IDs to check.
     *
     * @return bool
     *   TRUE is the permission is in at least one of the roles. FALSE otherwise.
     */
    public function isPermissionInRoles($permission, array $rids);

}

Members

Title Modifiers Object type Summary Overrides
ConfigEntityStorageInterface::createFromStorageRecord public function Creates a configuration entity from storage values. 1
ConfigEntityStorageInterface::getIDFromConfigName public static function Extracts the configuration entity ID from the full configuration name. 1
ConfigEntityStorageInterface::loadMultipleOverrideFree public function Loads one or more entities in their original form without overrides. 1
ConfigEntityStorageInterface::loadOverrideFree public function Loads one entity in their original form without overrides. 1
ConfigEntityStorageInterface::updateFromStorageRecord public function Updates a configuration entity from storage values. 1
EntityStorageInterface::create public function Constructs a new entity object, without permanently saving it. 1
EntityStorageInterface::delete public function Deletes permanently saved entities. 1
EntityStorageInterface::deleteRevision public function Delete a specific entity revision. 4
EntityStorageInterface::FIELD_LOAD_CURRENT constant Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION constant Load the version of an entity's field data specified in the entity.
EntityStorageInterface::getAggregateQuery public function Gets an aggregated query instance. 1
EntityStorageInterface::getEntityClass public function Retrieves the class name used to create the entity. 1
EntityStorageInterface::getEntityType public function Gets the entity type definition. 1
EntityStorageInterface::getEntityTypeId public function Gets the entity type ID. 1
EntityStorageInterface::getQuery public function Gets an entity query instance. 1
EntityStorageInterface::hasData public function Determines if the storage contains any data. 1
EntityStorageInterface::load public function Loads one entity. 1
EntityStorageInterface::loadByProperties public function Load entities by their property values without any access checks. 1
EntityStorageInterface::loadMultiple public function Loads one or more entities. 1
EntityStorageInterface::loadRevision public function Load a specific entity revision. 4
EntityStorageInterface::loadUnchanged public function Loads an unchanged entity from the database. 1
EntityStorageInterface::resetCache public function Resets the internal entity cache. 1
EntityStorageInterface::restore public function Restores a previously saved entity. 1
EntityStorageInterface::save public function Saves the entity permanently. 1
RoleStorageInterface::isPermissionInRoles public function Returns whether a permission is in one of the passed in roles. 1

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