interface UserStorageInterface

Same name and namespace in other branches
  1. 9 core/modules/user/src/UserStorageInterface.php \Drupal\user\UserStorageInterface
  2. 8.9.x core/modules/user/src/UserStorageInterface.php \Drupal\user\UserStorageInterface
  3. 11.x core/modules/user/src/UserStorageInterface.php \Drupal\user\UserStorageInterface

Defines an interface for user entity storage classes.

Hierarchy

Expanded class hierarchy of UserStorageInterface

All classes that implement UserStorageInterface

9 files declare their use of UserStorageInterface
CommentNameConstraintValidator.php in core/modules/comment/src/Plugin/Validation/Constraint/CommentNameConstraintValidator.php
ProtectedUserFieldConstraintValidator.php in core/modules/user/src/Plugin/Validation/Constraint/ProtectedUserFieldConstraintValidator.php
SiteConfigureForm.php in core/lib/Drupal/Core/Installer/Form/SiteConfigureForm.php
UserAuthenticationController.php in core/modules/user/src/Controller/UserAuthenticationController.php
UserController.php in core/modules/user/src/Controller/UserController.php

... See full list

File

core/modules/user/src/UserStorageInterface.php, line 11

Namespace

Drupal\user
View source 
interface UserStorageInterface extends ContentEntityStorageInterface {
    
    /**
     * Update the last login timestamp of the user.
     *
     * @param \Drupal\user\UserInterface $account
     *   The user account.
     */
    public function updateLastLoginTimestamp(UserInterface $account);
    
    /**
     * Update the last access timestamp of the user.
     *
     * @param \Drupal\Core\Session\AccountInterface $account
     *   The user object.
     * @param int $timestamp
     *   The last access timestamp.
     */
    public function updateLastAccessTimestamp(AccountInterface $account, $timestamp);
    
    /**
     * Delete role references.
     *
     * @param array $rids
     *   The list of role IDs being deleted. The storage should
     *   remove permission and user references to this role.
     */
    public function deleteRoleReferences(array $rids);

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ContentEntityStorageInterface::createWithSampleValues public function Creates an entity with sample field values. 2
EntityStorageInterface::create public function Constructs a new entity object, without permanently saving it. 1
EntityStorageInterface::delete public function Deletes permanently saved entities. 1
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::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
RevisionableStorageInterface::deleteRevision public function Deletes a specific entity revision. Overrides EntityStorageInterface::deleteRevision
RevisionableStorageInterface::getLatestRevisionId public function Returns the latest revision identifier for an entity. 2
RevisionableStorageInterface::loadMultipleRevisions public function Loads multiple entity revisions. 2
RevisionableStorageInterface::loadRevision public function Loads a specific entity revision. Overrides EntityStorageInterface::loadRevision
TranslatableRevisionableStorageInterface::createRevision public function Creates a new revision starting off from the specified entity object. Overrides RevisionableStorageInterface::createRevision 2
TranslatableRevisionableStorageInterface::getLatestTranslationAffectedRevisionId public function Returns the latest revision affecting the specified translation. 2
TranslatableStorageInterface::createTranslation public function Constructs a new entity translation object, without permanently saving it. 2
UserStorageInterface::deleteRoleReferences public function Delete role references. 1
UserStorageInterface::updateLastAccessTimestamp public function Update the last access timestamp of the user. 1
UserStorageInterface::updateLastLoginTimestamp public function Update the last login timestamp of the user. 1

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