annotate core/modules/user/src/RoleStorageInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\user;
Chris@0 4
Chris@0 5 use Drupal\Core\Config\Entity\ConfigEntityStorageInterface;
Chris@0 6
Chris@0 7 /**
Chris@0 8 * Defines an interface for role entity storage classes.
Chris@0 9 */
Chris@0 10 interface RoleStorageInterface extends ConfigEntityStorageInterface {
Chris@0 11
Chris@0 12 /**
Chris@0 13 * Returns whether a permission is in one of the passed in roles.
Chris@0 14 *
Chris@0 15 * @param string $permission
Chris@0 16 * The permission.
Chris@0 17 * @param array $rids
Chris@0 18 * The list of role IDs to check.
Chris@0 19 *
Chris@0 20 * @return bool
Chris@0 21 * TRUE is the permission is in at least one of the roles. FALSE otherwise.
Chris@0 22 */
Chris@0 23 public function isPermissionInRoles($permission, array $rids);
Chris@0 24
Chris@0 25 }