1. interface
  2. Drupal
  3. \
  4. user
  5. \
  6. UserStorageInterface

UserStorageInterface

interface UserStorageInterface implements ContentEntityStorageInterface (View source)

Defines an interface for user entity storage classes.

Methods

resetCache(array $ids = NULL)

Resets the internal entity cache.

from  EntityStorageInterface
EntityInterface[]
loadMultiple(array $ids = NULL)

Loads one or more entities.

from  EntityStorageInterface
EntityInterface|null
load(mixed $id)

Loads one entity.

from  EntityStorageInterface
EntityInterface|null
loadUnchanged(mixed $id)

Loads an unchanged entity from the database.

from  EntityStorageInterface
EntityInterface|null
loadRevision(int|string $revision_id)

Load a specific entity revision.

from  EntityStorageInterface
deleteRevision(int $revision_id)

Delete a specific entity revision.

from  EntityStorageInterface
EntityInterface[]
loadByProperties(array $values = [])

Load entities by their property values.

from  EntityStorageInterface
EntityInterface
create(array $values = [])

Constructs a new entity object, without permanently saving it.

from  EntityStorageInterface
delete(array $entities)

Deletes permanently saved entities.

from  EntityStorageInterface
SAVED_NEW
save(EntityInterface $entity)

Saves the entity permanently.

from  EntityStorageInterface
restore(EntityInterface $entity)

Restores a previously saved entity.

from  EntityStorageInterface
bool
hasData()

Determines if the storage contains any data.

from  EntityStorageInterface
QueryInterface
getQuery(string $conjunction = 'AND')

Gets an entity query instance.

from  EntityStorageInterface
QueryAggregateInterface
getAggregateQuery(string $conjunction = 'AND')

Gets an aggregated query instance.

from  EntityStorageInterface
string
getEntityTypeId()

Gets the entity type ID.

from  EntityStorageInterface
EntityTypeInterface
getEntityType()

Gets the entity type definition.

from  EntityStorageInterface
string
getEntityClass(string|null $bundle = NULL)

Retrieves the class name used to create the entity.

from  EntityStorageInterface
ContentEntityInterface
createTranslation(ContentEntityInterface $entity, string $langcode, array $values = [])

Constructs a new entity translation object, without permanently saving it.

from  TranslatableStorageInterface
RevisionableInterface
createRevision(RevisionableInterface $entity, bool $default = TRUE)

Creates a new revision starting off from the specified entity object.

from  RevisionableStorageInterface
RevisionableInterface[]
loadMultipleRevisions(array $revision_ids)

Loads multiple entity revisions.

from  RevisionableStorageInterface
int|string|null
getLatestRevisionId(int|string $entity_id)

Returns the latest revision identifier for an entity.

from  RevisionableStorageInterface
int|string|null
getLatestTranslationAffectedRevisionId(int|string $entity_id, string $langcode)

Returns the latest revision affecting the specified translation.

from  TranslatableRevisionableStorageInterface
FieldableEntityInterface
createWithSampleValues(string|bool $bundle = FALSE, array $values = [])

Creates an entity with sample field values.

from  ContentEntityStorageInterface
updateLastLoginTimestamp(UserInterface $account)

Update the last login timestamp of the user.

updateLastAccessTimestamp(AccountInterface $account, int $timestamp)

Update the last access timestamp of the user.

deleteRoleReferences(array $rids)

Delete role references.

Details

in EntityStorageInterface at line 35
resetCache(array $ids = NULL)

Resets the internal entity cache.

Parameters

array $ids

(optional) If specified, the cache is reset for the entities with the given ids only.

in EntityStorageInterface at line 47
EntityInterface[] loadMultiple(array $ids = NULL)

Loads one or more entities.

Parameters

array $ids

An array of entity IDs, or NULL to load all entities.

Return Value

EntityInterface[]

An array of entity objects indexed by their IDs. Returns an empty array if no matching entities are found.

in EntityStorageInterface at line 58
EntityInterface|null load(mixed $id)

Loads one entity.

Parameters

mixed $id

The ID of the entity to load.

Return Value

EntityInterface|null

An entity object. NULL if no matching entity is found.

in EntityStorageInterface at line 72
EntityInterface|null loadUnchanged(mixed $id)

Loads an unchanged entity from the database.

Remove this method once we have a reliable way to retrieve the unchanged entity from the entity object.

Parameters

mixed $id

The ID of the entity to load.

Return Value

EntityInterface|null

The unchanged entity, or NULL if the entity cannot be loaded.

in EntityStorageInterface at line 89
EntityInterface|null loadRevision(int|string $revision_id)

Load a specific entity revision.

Deprecated in Drupal 8.5.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Entity\RevisionableStorageInterface instead.

Parameters

int|string $revision_id

The revision id.

Return Value

EntityInterface|null

The specified entity revision or NULL if not found.

See also

https://www.drupal.org/node/2926958
https://www.drupal.org/node/2927226

in EntityStorageInterface at line 105
deleteRevision(int $revision_id)

Delete a specific entity revision.

A revision can only be deleted if it's not the currently active one.

Deprecated in Drupal 8.5.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Entity\RevisionableStorageInterface instead.

Parameters

int $revision_id

The revision id.

See also

https://www.drupal.org/node/2926958
https://www.drupal.org/node/2927226

in EntityStorageInterface at line 117
EntityInterface[] loadByProperties(array $values = [])

Load entities by their property values.

Parameters

array $values

An associative array where the keys are the property names and the values are the values those properties must have.

Return Value

EntityInterface[]

An array of entity objects indexed by their ids.

in EntityStorageInterface at line 129
EntityInterface create(array $values = [])

Constructs a new entity object, without permanently saving it.

Parameters

array $values

(optional) An array of values to set, keyed by property name. If the entity type has bundles, the bundle key has to be specified.

Return Value

EntityInterface

A new entity object.

in EntityStorageInterface at line 140
delete(array $entities)

Deletes permanently saved entities.

Parameters

array $entities

An array of entity objects to delete.

Exceptions

EntityStorageException

in EntityStorageInterface at line 155
SAVED_NEW save(EntityInterface $entity)

Saves the entity permanently.

Parameters

EntityInterface $entity

The entity to save.

Return Value

SAVED_NEW

or SAVED_UPDATED is returned depending on the operation performed.

Exceptions

EntityStorageException

in EntityStorageInterface at line 177
restore(EntityInterface $entity)

internal  This method should never be used to perform a regular entity save. Its only use-case is to assist updating entity types when there are complex schema changes, for example, to make them revisionable. Note that overriding this method to fix data prior to restoring is a likely sign that the current data is corrupt.
 

Restores a previously saved entity.

Note that the entity is assumed to be in a valid state for the storage, so the restore process does not invoke any hooks, nor does it perform any pre or post-save operations.

Parameters

EntityInterface $entity

The entity to restore.

Exceptions

EntityStorageException

in EntityStorageInterface at line 185
bool hasData()

Determines if the storage contains any data.

Return Value

bool

TRUE if the storage contains data, FALSE if not.

in EntityStorageInterface at line 200
QueryInterface getQuery(string $conjunction = 'AND')

Gets an entity query instance.

Parameters

string $conjunction

(optional) The logical operator for the query, either:

  • AND: all of the conditions on the query need to match.
  • OR: at least one of the conditions on the query need to match.

Return Value

QueryInterface

The query instance.

See also

EntityStorageBase::getQueryServiceName

in EntityStorageInterface at line 215
QueryAggregateInterface getAggregateQuery(string $conjunction = 'AND')

Gets an aggregated query instance.

Parameters

string $conjunction

(optional) The logical operator for the query, either:

  • AND: all of the conditions on the query need to match.
  • OR: at least one of the conditions on the query need to match.

Return Value

QueryAggregateInterface

The aggregated query object that can query the given entity type.

See also

EntityStorageBase::getQueryServiceName

in EntityStorageInterface at line 223
string getEntityTypeId()

Gets the entity type ID.

Return Value

string

The entity type ID.

in EntityStorageInterface at line 231
EntityTypeInterface getEntityType()

Gets the entity type definition.

Return Value

EntityTypeInterface

Entity type definition.

in EntityStorageInterface at line 243
string getEntityClass(string|null $bundle = NULL)

Retrieves the class name used to create the entity.

Parameters

string|null $bundle

(optional) A specific entity type bundle identifier. Can be omitted in the case of entity types without bundles, like User.

Return Value

string

The entity class name.

in TranslatableStorageInterface at line 28
ContentEntityInterface createTranslation(ContentEntityInterface $entity, string $langcode, array $values = [])

Constructs a new entity translation object, without permanently saving it.

Consider accepting \Drupal\Core\Entity\TranslatableInterface as first parameter. See https://www.drupal.org/project/drupal/issues/2932049.

Parameters

ContentEntityInterface $entity

The entity object being translated.
string $langcode

The translation language code.
array $values

(optional) An associative array of initial field values keyed by field name. If none is provided default values will be applied.

Return Value

ContentEntityInterface

Another instance of the specified entity object class with the specified active language and initial values.

in RevisionableStorageInterface at line 22
RevisionableInterface createRevision(RevisionableInterface $entity, bool $default = TRUE)

Creates a new revision starting off from the specified entity object.

Parameters

RevisionableInterface $entity

The revisionable entity object being modified.
bool $default

(optional) Whether the new revision should be marked as default. Defaults to TRUE.

Return Value

RevisionableInterface

A new entity revision object.

in RevisionableStorageInterface at line 45
RevisionableInterface[] loadMultipleRevisions(array $revision_ids)

Loads multiple entity revisions.

Parameters

array $revision_ids

An array of revision IDs to load.

Return Value

RevisionableInterface[]

An array of entity revisions keyed by their revision ID, or an empty array if none found.

in RevisionableStorageInterface at line 66
int|string|null getLatestRevisionId(int|string $entity_id)

Returns the latest revision identifier for an entity.

Parameters

int|string $entity_id

The entity identifier.

Return Value

int|string|null

The latest revision identifier or NULL if no revision could be found.

in TranslatableRevisionableStorageInterface at line 44
int|string|null getLatestTranslationAffectedRevisionId(int|string $entity_id, string $langcode)

Returns the latest revision affecting the specified translation.

Parameters

int|string $entity_id

The entity identifier.
string $langcode

The language code of the translation.

Return Value

int|string|null

A revision ID or NULL if no revision affecting the specified translation could be found.

in ContentEntityStorageInterface at line 24
FieldableEntityInterface createWithSampleValues(string|bool $bundle = FALSE, array $values = [])

Creates an entity with sample field values.

Parameters

string|bool $bundle

(optional) The entity bundle.
array $values

(optional) Any default values to use during generation.

Return Value

FieldableEntityInterface

A fieldable content entity.

Exceptions

EntityStorageException

at line 19
updateLastLoginTimestamp(UserInterface $account)

Update the last login timestamp of the user.

Parameters

UserInterface $account

The user account.

at line 29
updateLastAccessTimestamp(AccountInterface $account, int $timestamp)

Update the last access timestamp of the user.

Parameters

AccountInterface $account

The user object.
int $timestamp

The last access timestamp.

at line 38
deleteRoleReferences(array $rids)

Delete role references.

Parameters

array $rids

The list of role IDs being deleted. The storage should remove permission and user references to this role.