interface UserInterface

Provides an interface defining a user entity.

Hierarchy

Expanded class hierarchy of UserInterface

All classes that implement UserInterface

8 files declare their use of UserInterface
Entity.php in drupal/core/lib/Drupal/Core/Entity/Entity.php
Contains \Drupal\Core\Entity\Entity.
EntityApiTest.php in drupal/core/modules/system/lib/Drupal/system/Tests/Entity/EntityApiTest.php
Definition of Drupal\system\Tests\Entity\EntityApiTest.
EntityTranslationWorkflowsTest.php in drupal/core/modules/translation_entity/lib/Drupal/translation_entity/Tests/EntityTranslationWorkflowsTest.php
Contains \Drupal\entity\Tests\EntityTranslationWorkflowsTest.
MessageFormController.php in drupal/core/modules/contact/lib/Drupal/contact/MessageFormController.php
Definition of Drupal\contact\MessageFormController.
node.module in drupal/core/modules/node/node.module
The core module that allows content to be submitted to the site.

... See full list

File

drupal/core/modules/user/lib/Drupal/user/UserInterface.php, line 16
Contains \Drupal\user\UserInterface.

Namespace

Drupal\user
View source
interface UserInterface extends EntityInterface, AccountInterface {

  /**
   * Returns a list of roles.
   *
   * @return array
   *   List of role IDs.
   */
  public function getRoles();

  /**
   * Whether a user has a certain role.
   *
   * @param string $rid
   *   The role ID to check.
   *
   * @return bool
   *   Returns TRUE if the user has the role, otherwise FALSE.
   */
  public function hasRole($rid);

  /**
   * Add a role to a user.
   *
   * @param string $rid
   *   The role ID to add.
   */
  public function addRole($rid);

  /**
   * Remove a role from a user.
   *
   * @param string $rid
   *   The role ID to remove.
   */
  public function removeRole($rid);

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 5
AccountInterface::getSecureSessionId public function Returns the secure session ID. 3
AccountInterface::getSessionData public function Returns the session data. 3
AccountInterface::getSessionId public function Returns the session ID. 3
ComplexDataInterface::get public function Gets a property object. 7
ComplexDataInterface::getProperties public function Gets an array of property objects. 7
ComplexDataInterface::getPropertyDefinition public function Gets the definition of a contained property. 7
ComplexDataInterface::getPropertyDefinitions public function Gets an array of property definitions of contained properties. 7
ComplexDataInterface::getPropertyValues public function Gets an array of property values. 7
ComplexDataInterface::isEmpty public function Determines whether the data structure is empty. 7
ComplexDataInterface::onChange public function React to changes to a child property. 7
ComplexDataInterface::set public function Sets a property value. 7
ComplexDataInterface::setPropertyValues public function Sets multiple property values. 7
EntityInterface::bundle public function Returns the bundle of the entity. 3
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 3
EntityInterface::delete public function Deletes an entity permanently. 3
EntityInterface::enforceIsNew public function Enforces an entity to be new. 3
EntityInterface::entityInfo public function Returns the info of the type of the entity. 3
EntityInterface::entityType public function Returns the type of the entity. 3
EntityInterface::getBCEntity public function Gets a backward compatibility decorator entity. 3
EntityInterface::getExportProperties public function Retrieves the exportable properties of the entity. 3
EntityInterface::getNGEntity public function Removes any possible (backward compatibility) decorator in use. 3
EntityInterface::getRevisionId public function Returns the revision identifier of the entity. 3
EntityInterface::id public function Returns the entity identifier (the entity's machine name or numeric ID). 3
EntityInterface::isDefaultRevision public function Checks if this entity is the default revision. 3
EntityInterface::isNew public function Returns whether the entity is new. 3
EntityInterface::isNewRevision public function Returns whether a new revision should be created on save. 3
EntityInterface::isTranslatable public function Returns the translation support status. 3
EntityInterface::label public function Returns the label of the entity. 3
EntityInterface::save public function Saves an entity permanently. 3
EntityInterface::setNewRevision public function Enforces an entity to be saved as a new revision. 3
EntityInterface::uri public function Returns the URI elements of the entity. 3
EntityInterface::uriRelationships public function Returns a list of URI relationships supported by this entity. 3
EntityInterface::uuid public function Returns the entity UUID (Universally Unique Identifier). 3
TranslatableInterface::getTranslation public function Gets a translation of the data. 3
TranslatableInterface::getTranslationLanguages public function Returns the languages the data is translated to. 3
TranslatableInterface::language public function Returns the default language. 3
TypedDataInterface::getConstraints public function Gets a list of validation constraints. 4
TypedDataInterface::getDefinition public function Gets the data definition. 4
TypedDataInterface::getName public function Returns the name of a property or item. 4
TypedDataInterface::getParent public function Returns the parent data structure; i.e. either complex data or a list. 4
TypedDataInterface::getPropertyPath public function Returns the property path of the data. 4
TypedDataInterface::getRoot public function Returns the root of the typed data tree. 4
TypedDataInterface::getString public function Returns a string representation of the data. 4
TypedDataInterface::getType public function Gets the data type. 5
TypedDataInterface::getValue public function Gets the data value. 4
TypedDataInterface::setContext public function Sets the context of a property or item via a context aware parent. 4
TypedDataInterface::setValue public function Sets the data value. 4
TypedDataInterface::validate public function Validates the currently set data value. 4
UserInterface::addRole public function Add a role to a user. 2
UserInterface::getRoles public function Returns a list of roles. Overrides AccountInterface::getRoles 2
UserInterface::hasRole public function Whether a user has a certain role. 2
UserInterface::removeRole public function Remove a role from a user. 2