class UserStorage
Same name in other branches
- 9 core/modules/user/src/UserStorage.php \Drupal\user\UserStorage
- 10 core/modules/user/src/UserStorage.php \Drupal\user\UserStorage
- 11.x core/modules/user/src/UserStorage.php \Drupal\user\UserStorage
Controller class for users.
This extends the Drupal\Core\Entity\Sql\SqlContentEntityStorage class, adding required special handling for user objects.
Hierarchy
- class \Drupal\Core\Entity\EntityHandlerBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\EntityStorageBase extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityStorageInterface, \Drupal\Core\Entity\EntityHandlerInterface
- class \Drupal\Core\Entity\ContentEntityStorageBase extends \Drupal\Core\Entity\EntityStorageBase implements \Drupal\Core\Entity\ContentEntityStorageInterface, \Drupal\Core\Entity\DynamicallyFieldableEntityStorageInterface uses \Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait
- class \Drupal\Core\Entity\Sql\SqlContentEntityStorage extends \Drupal\Core\Entity\ContentEntityStorageBase implements \Drupal\Core\Entity\Sql\SqlEntityStorageInterface, \Drupal\Core\Entity\Schema\DynamicallyFieldableEntityStorageSchemaInterface, \Drupal\Core\Entity\EntityBundleListenerInterface
- class \Drupal\user\UserStorage extends \Drupal\Core\Entity\Sql\SqlContentEntityStorage implements \Drupal\user\UserStorageInterface
- class \Drupal\Core\Entity\Sql\SqlContentEntityStorage extends \Drupal\Core\Entity\ContentEntityStorageBase implements \Drupal\Core\Entity\Sql\SqlEntityStorageInterface, \Drupal\Core\Entity\Schema\DynamicallyFieldableEntityStorageSchemaInterface, \Drupal\Core\Entity\EntityBundleListenerInterface
- class \Drupal\Core\Entity\ContentEntityStorageBase extends \Drupal\Core\Entity\EntityStorageBase implements \Drupal\Core\Entity\ContentEntityStorageInterface, \Drupal\Core\Entity\DynamicallyFieldableEntityStorageInterface uses \Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait
- class \Drupal\Core\Entity\EntityStorageBase extends \Drupal\Core\Entity\EntityHandlerBase implements \Drupal\Core\Entity\EntityStorageInterface, \Drupal\Core\Entity\EntityHandlerInterface
Expanded class hierarchy of UserStorage
File
-
core/
modules/ user/ src/ UserStorage.php, line 15
Namespace
Drupal\userView source
class UserStorage extends SqlContentEntityStorage implements UserStorageInterface {
/**
* {@inheritdoc}
*/
protected function doSaveFieldItems(ContentEntityInterface $entity, array $names = []) {
// The anonymous user account is saved with the fixed user ID of 0.
// Therefore we need to check for NULL explicitly.
if ($entity->id() === NULL) {
$entity->uid->value = $this->database
->nextId($this->database
->query('SELECT MAX(uid) FROM {' . $this->getBaseTable() . '}')
->fetchField());
$entity->enforceIsNew();
}
return parent::doSaveFieldItems($entity, $names);
}
/**
* {@inheritdoc}
*/
protected function isColumnSerial($table_name, $schema_name) {
// User storage does not use a serial column for the user id.
return $table_name == $this->revisionTable && $schema_name == $this->revisionKey;
}
/**
* {@inheritdoc}
*/
public function updateLastLoginTimestamp(UserInterface $account) {
$this->database
->update($this->getDataTable())
->fields([
'login' => $account->getLastLoginTime(),
])
->condition('uid', $account->id())
->execute();
// Ensure that the entity cache is cleared.
$this->resetCache([
$account->id(),
]);
}
/**
* {@inheritdoc}
*/
public function updateLastAccessTimestamp(AccountInterface $account, $timestamp) {
$this->database
->update($this->getDataTable())
->fields([
'access' => $timestamp,
])
->condition('uid', $account->id())
->execute();
// Ensure that the entity cache is cleared.
$this->resetCache([
$account->id(),
]);
}
/**
* {@inheritdoc}
*/
public function deleteRoleReferences(array $rids) {
// Remove the role from all users.
$this->database
->delete('user__roles')
->condition('roles_target_id', $rids)
->execute();
$this->resetCache();
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
ContentEntityStorageBase::$bundleKey | protected | property | The entity bundle key. | |||
ContentEntityStorageBase::$cacheBackend | protected | property | Cache backend. | |||
ContentEntityStorageBase::$deprecatedProperties | protected | property | ||||
ContentEntityStorageBase::$entityFieldManager | protected | property | The entity field manager service. | |||
ContentEntityStorageBase::$entityTypeBundleInfo | protected | property | The entity bundle info. | |||
ContentEntityStorageBase::$latestRevisionIds | protected | property | Stores the latest revision IDs for entities. | |||
ContentEntityStorageBase::cleanIds | protected | function | Ensures integer entity key values are valid. | |||
ContentEntityStorageBase::createRevision | public | function | Creates a new revision starting off from the specified entity object. | Overrides TranslatableRevisionableStorageInterface::createRevision | ||
ContentEntityStorageBase::createTranslation | public | function | Constructs a new entity translation object, without permanently saving it. | Overrides TranslatableStorageInterface::createTranslation | ||
ContentEntityStorageBase::createWithSampleValues | public | function | Creates an entity with sample field values. | Overrides ContentEntityStorageInterface::createWithSampleValues | 1 | |
ContentEntityStorageBase::deleteRevision | public | function | Delete a specific entity revision. | Overrides EntityStorageInterface::deleteRevision | 1 | |
ContentEntityStorageBase::doCreate | protected | function | Performs storage-specific creation of entities. | Overrides EntityStorageBase::doCreate | ||
ContentEntityStorageBase::doDelete | protected | function | Performs storage-specific entity deletion. | Overrides EntityStorageBase::doDelete | 1 | |
ContentEntityStorageBase::doPostSave | protected | function | Performs post save entity processing. | Overrides EntityStorageBase::doPostSave | ||
ContentEntityStorageBase::doPreSave | protected | function | Performs presave entity processing. | Overrides EntityStorageBase::doPreSave | ||
ContentEntityStorageBase::doSave | protected | function | Performs storage-specific saving of the entity. | Overrides EntityStorageBase::doSave | 1 | |
ContentEntityStorageBase::getFromPersistentCache | protected | function | Gets entities from the persistent cache backend. | |||
ContentEntityStorageBase::getLatestRevisionId | public | function | Returns the latest revision identifier for an entity. | Overrides RevisionableStorageInterface::getLatestRevisionId | ||
ContentEntityStorageBase::getLatestTranslationAffectedRevisionId | public | function | Returns the latest revision affecting the specified translation. | Overrides TranslatableRevisionableStorageInterface::getLatestTranslationAffectedRevisionId | ||
ContentEntityStorageBase::getRevisionTranslationMergeSkippedFieldNames | protected | function | Returns an array of field names to skip when merging revision translations. | |||
ContentEntityStorageBase::hasFieldValueChanged | protected | function | Checks whether the field values changed compared to the original entity. | |||
ContentEntityStorageBase::initFieldValues | protected | function | Initializes field values. | |||
ContentEntityStorageBase::invokeFieldMethod | protected | function | Invokes a method on the Field objects within an entity. | |||
ContentEntityStorageBase::invokeFieldPostSave | protected | function | Invokes the post save method on the Field objects within an entity. | |||
ContentEntityStorageBase::invokeHook | protected | function | Invokes a hook on behalf of the entity. | Overrides EntityStorageBase::invokeHook | 1 | |
ContentEntityStorageBase::invokeStorageLoadHook | protected | function | Invokes hook_entity_storage_load(). | |||
ContentEntityStorageBase::invokeTranslationHooks | protected | function | Checks translation statuses and invoke the related hooks if needed. | |||
ContentEntityStorageBase::isAnyRevisionTranslated | protected | function | Checks whether any entity revision is translated. | |||
ContentEntityStorageBase::isAnyStoredRevisionTranslated | protected | function | Checks whether any stored entity revision is translated. | |||
ContentEntityStorageBase::loadMultipleRevisions | public | function | Loads multiple entity revisions. | Overrides RevisionableStorageInterface::loadMultipleRevisions | 1 | |
ContentEntityStorageBase::loadRevision | public | function | Load a specific entity revision. | Overrides EntityStorageInterface::loadRevision | 1 | |
ContentEntityStorageBase::loadUnchanged | public | function | Loads an unchanged entity from the database. | Overrides EntityStorageBase::loadUnchanged | ||
ContentEntityStorageBase::onFieldDefinitionCreate | public | function | ||||
ContentEntityStorageBase::onFieldDefinitionUpdate | public | function | ||||
ContentEntityStorageBase::populateAffectedRevisionTranslations | protected | function | Populates the affected flag for all the revision translations. | |||
ContentEntityStorageBase::preLoad | protected | function | Gathers entities from a 'preload' step. | Overrides EntityStorageBase::preLoad | ||
ContentEntityStorageBase::purgeFieldData | public | function | ||||
ContentEntityStorageBase::resetCache | public | function | Resets the internal, static entity cache. | Overrides EntityStorageBase::resetCache | 1 | |
ContentEntityStorageBase::setPersistentCache | protected | function | Stores entities in the persistent cache backend. | |||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
DependencySerializationTrait::__sleep | public | function | 1 | |||
DependencySerializationTrait::__wakeup | public | function | 2 | |||
DeprecatedServicePropertyTrait::__get | public | function | Allows to access deprecated/removed properties. | |||
EntityHandlerBase::$moduleHandler | protected | property | The module handler to invoke hooks on. | 2 | ||
EntityHandlerBase::moduleHandler | protected | function | Gets the module handler. | 2 | ||
EntityHandlerBase::setModuleHandler | public | function | Sets the module handler for this handler. | |||
EntityStorageBase::$entityClass | protected | property | Name of the entity class. | |||
EntityStorageBase::$entityType | protected | property | Information about the entity type. | |||
EntityStorageBase::$entityTypeId | protected | property | Entity type ID for this storage. | |||
EntityStorageBase::$idKey | protected | property | Name of the entity's ID field in the entity database table. | |||
EntityStorageBase::$memoryCache | protected | property | The memory cache. | |||
EntityStorageBase::$memoryCacheTag | protected | property | The memory cache cache tag. | |||
EntityStorageBase::$uuidKey | protected | property | Name of entity's UUID database table field, if it supports UUIDs. | 1 | ||
EntityStorageBase::$uuidService | protected | property | The UUID service. | 1 | ||
EntityStorageBase::buildCacheId | protected | function | Builds the cache ID for the passed in entity ID. | 1 | ||
EntityStorageBase::create | public | function | Constructs a new entity object, without permanently saving it. | Overrides EntityStorageInterface::create | 1 | |
EntityStorageBase::getAggregateQuery | public | function | Gets an aggregated query instance. | Overrides EntityStorageInterface::getAggregateQuery | ||
EntityStorageBase::getEntityType | public | function | Gets the entity type definition. | Overrides EntityStorageInterface::getEntityType | ||
EntityStorageBase::getEntityTypeId | public | function | Gets the entity type ID. | Overrides EntityStorageInterface::getEntityTypeId | ||
EntityStorageBase::getFromStaticCache | protected | function | Gets entities from the static cache. | |||
EntityStorageBase::getQuery | public | function | Gets an entity query instance. | Overrides EntityStorageInterface::getQuery | ||
EntityStorageBase::hasData | public | function | Determines if the storage contains any data. | Overrides EntityStorageInterface::hasData | 3 | |
EntityStorageBase::load | public | function | Loads one entity. | Overrides EntityStorageInterface::load | 2 | |
EntityStorageBase::loadByProperties | public | function | Load entities by their property values. | Overrides EntityStorageInterface::loadByProperties | 3 | |
EntityStorageBase::loadMultiple | public | function | Loads one or more entities. | Overrides EntityStorageInterface::loadMultiple | 1 | |
EntityStorageBase::postLoad | protected | function | Attaches data to entities upon loading. | |||
EntityStorageBase::setStaticCache | protected | function | Stores entities in the static entity cache. | |||
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. | ||||
SqlContentEntityStorage::$baseTable | protected | property | The base table of the entity. | |||
SqlContentEntityStorage::$database | protected | property | Active database connection. | |||
SqlContentEntityStorage::$dataTable | protected | property | The table that stores properties, if the entity has multilingual support. | |||
SqlContentEntityStorage::$defaultLangcodeKey | protected | property | The default language entity key. | |||
SqlContentEntityStorage::$entityTypeManager | protected | property | The entity type manager. | |||
SqlContentEntityStorage::$fieldStorageDefinitions | protected | property | The entity type's field storage definitions. | |||
SqlContentEntityStorage::$langcodeKey | protected | property | The entity langcode key. | Overrides EntityStorageBase::$langcodeKey | ||
SqlContentEntityStorage::$languageManager | protected | property | The language manager. | |||
SqlContentEntityStorage::$revisionDataTable | protected | property | The table that stores revision field data if the entity supports revisions. | |||
SqlContentEntityStorage::$revisionKey | protected | property | Name of entity's revision database table field, if it supports revisions. | |||
SqlContentEntityStorage::$revisionTable | protected | property | The table that stores revisions, if the entity supports revisions. | |||
SqlContentEntityStorage::$storageSchema | protected | property | The entity type's storage schema object. | |||
SqlContentEntityStorage::$tableMapping | protected | property | The mapping of field columns to SQL tables. | |||
SqlContentEntityStorage::$temporary | protected | property | Whether this storage should use the temporary table mapping. | |||
SqlContentEntityStorage::buildPropertyQuery | protected | function | Builds an entity query. | Overrides EntityStorageBase::buildPropertyQuery | ||
SqlContentEntityStorage::buildQuery | protected | function | Builds the query to load the entity. | |||
SqlContentEntityStorage::countFieldData | public | function | ||||
SqlContentEntityStorage::createInstance | public static | function | Instantiates a new instance of this entity handler. | Overrides ContentEntityStorageBase::createInstance | 1 | |
SqlContentEntityStorage::delete | public | function | Deletes permanently saved entities. | Overrides EntityStorageBase::delete | ||
SqlContentEntityStorage::deleteFromDedicatedTables | protected | function | Deletes values of fields in dedicated tables for all revisions. | |||
SqlContentEntityStorage::deleteRevisionFromDedicatedTables | protected | function | Deletes values of fields in dedicated tables for all revisions. | |||
SqlContentEntityStorage::doDeleteFieldItems | protected | function | Deletes entity field values from the storage. | Overrides ContentEntityStorageBase::doDeleteFieldItems | ||
SqlContentEntityStorage::doDeleteRevisionFieldItems | protected | function | Deletes field values of an entity revision from the storage. | Overrides ContentEntityStorageBase::doDeleteRevisionFieldItems | ||
SqlContentEntityStorage::doLoadMultiple | protected | function | Performs storage-specific loading of entities. | Overrides EntityStorageBase::doLoadMultiple | ||
SqlContentEntityStorage::doLoadMultipleRevisionsFieldItems | protected | function | Actually loads revision field item values from the storage. | Overrides ContentEntityStorageBase::doLoadMultipleRevisionsFieldItems | ||
SqlContentEntityStorage::doLoadRevisionFieldItems | protected | function | Actually loads revision field item values from the storage. | Overrides ContentEntityStorageBase::doLoadRevisionFieldItems | ||
SqlContentEntityStorage::finalizePurge | public | function | Performs final cleanup after all data of a field has been purged. | Overrides ContentEntityStorageBase::finalizePurge | ||
SqlContentEntityStorage::getBaseTable | public | function | Gets the base table name. | |||
SqlContentEntityStorage::getCustomTableMapping | public | function | Gets a table mapping for the specified entity type and storage definitions. | |||
SqlContentEntityStorage::getDataTable | public | function | Gets the data table name. | |||
SqlContentEntityStorage::getFieldStorageDefinitions | Deprecated | public | function | Gets the base field definitions for a content entity type. | ||
SqlContentEntityStorage::getFromStorage | protected | function | Gets entities from the storage. | |||
SqlContentEntityStorage::getQueryServiceName | protected | function | Gets the name of the service for the query for this entity storage. | Overrides EntityStorageBase::getQueryServiceName | ||
SqlContentEntityStorage::getRevisionDataTable | public | function | Gets the revision data table name. | |||
SqlContentEntityStorage::getRevisionTable | public | function | Gets the revision table name. | |||
SqlContentEntityStorage::getStorageSchema | protected | function | Gets the entity type's storage schema object. | |||
SqlContentEntityStorage::getTableMapping | public | function | Gets a table mapping for the entity's SQL tables. | Overrides SqlEntityStorageInterface::getTableMapping | ||
SqlContentEntityStorage::has | protected | function | Determines if this entity already exists in storage. | Overrides EntityStorageBase::has | ||
SqlContentEntityStorage::initTableLayout | protected | function | Initializes table name variables. | |||
SqlContentEntityStorage::loadFromDedicatedTables | protected | function | Loads values of fields stored in dedicated tables for a group of entities. | |||
SqlContentEntityStorage::loadFromSharedTables | protected | function | Loads values for fields stored in the shared data tables. | |||
SqlContentEntityStorage::mapFromStorageRecords | protected | function | Maps from storage records to entity objects, and attaches fields. | Overrides EntityStorageBase::mapFromStorageRecords | ||
SqlContentEntityStorage::mapToDataStorageRecord | protected | function | Maps from an entity object to the storage record of the field data. | |||
SqlContentEntityStorage::mapToStorageRecord | protected | function | Maps from an entity object to the storage record. | |||
SqlContentEntityStorage::onBundleCreate | public | function | Reacts to a bundle being created. | Overrides EntityBundleListenerInterface::onBundleCreate | ||
SqlContentEntityStorage::onBundleDelete | public | function | Reacts to a bundle being deleted. | Overrides EntityBundleListenerInterface::onBundleDelete | ||
SqlContentEntityStorage::onEntityTypeCreate | public | function | Reacts to the creation of the entity type. | Overrides EntityTypeListenerInterface::onEntityTypeCreate | ||
SqlContentEntityStorage::onEntityTypeDelete | public | function | Reacts to the deletion of the entity type. | Overrides EntityTypeListenerInterface::onEntityTypeDelete | ||
SqlContentEntityStorage::onEntityTypeUpdate | public | function | Reacts to the update of the entity type. | Overrides EntityTypeListenerInterface::onEntityTypeUpdate | ||
SqlContentEntityStorage::onFieldableEntityTypeCreate | public | function | Reacts to the creation of the fieldable entity type. | Overrides EntityTypeListenerInterface::onFieldableEntityTypeCreate | ||
SqlContentEntityStorage::onFieldableEntityTypeUpdate | public | function | Reacts to the update of a fieldable entity type. | Overrides EntityTypeListenerInterface::onFieldableEntityTypeUpdate | ||
SqlContentEntityStorage::onFieldDefinitionDelete | public | function | Overrides ContentEntityStorageBase::onFieldDefinitionDelete | |||
SqlContentEntityStorage::onFieldStorageDefinitionCreate | public | function | Reacts to the creation of a field storage definition. | Overrides ContentEntityStorageBase::onFieldStorageDefinitionCreate | ||
SqlContentEntityStorage::onFieldStorageDefinitionDelete | public | function | Reacts to the deletion of a field storage definition. | Overrides ContentEntityStorageBase::onFieldStorageDefinitionDelete | ||
SqlContentEntityStorage::onFieldStorageDefinitionUpdate | public | function | Reacts to the update of a field storage definition. | Overrides ContentEntityStorageBase::onFieldStorageDefinitionUpdate | ||
SqlContentEntityStorage::purgeFieldItems | protected | function | Removes field items from storage per entity during purge. | Overrides ContentEntityStorageBase::purgeFieldItems | ||
SqlContentEntityStorage::readFieldItemsToPurge | protected | function | Reads values to be purged for a single field. | Overrides ContentEntityStorageBase::readFieldItemsToPurge | ||
SqlContentEntityStorage::requiresEntityDataMigration | public | function | Checks if existing data would be lost if the schema changes were applied. | Overrides EntityStorageSchemaInterface::requiresEntityDataMigration | ||
SqlContentEntityStorage::requiresEntityStorageSchemaChanges | public | function | Checks if the changes to the entity type requires storage schema changes. | Overrides EntityStorageSchemaInterface::requiresEntityStorageSchemaChanges | ||
SqlContentEntityStorage::requiresFieldDataMigration | public | function | Checks if existing data would be lost if the schema changes were applied. | Overrides DynamicallyFieldableEntityStorageSchemaInterface::requiresFieldDataMigration | ||
SqlContentEntityStorage::requiresFieldStorageSchemaChanges | public | function | Checks if the changes to the storage definition requires schema changes. | Overrides DynamicallyFieldableEntityStorageSchemaInterface::requiresFieldStorageSchemaChanges | ||
SqlContentEntityStorage::restore | public | function | Restores a previously saved entity. | Overrides EntityStorageBase::restore | ||
SqlContentEntityStorage::save | public | function | Saves the entity permanently. | Overrides EntityStorageBase::save | 1 | |
SqlContentEntityStorage::saveRevision | protected | function | Saves an entity revision. | |||
SqlContentEntityStorage::saveToDedicatedTables | protected | function | Saves values of fields that use dedicated tables. | 1 | ||
SqlContentEntityStorage::saveToSharedTables | protected | function | Saves fields that use the shared tables. | |||
SqlContentEntityStorage::setEntityType | public | function | Updates the wrapped entity type definition. | |||
SqlContentEntityStorage::setFieldStorageDefinitions | public | function | Updates the internal list of field storage definitions. | |||
SqlContentEntityStorage::setTableMapping | public | function | Sets the wrapped table mapping definition. | |||
SqlContentEntityStorage::setTemporary | public | function | Changes the temporary state of the storage. | |||
SqlContentEntityStorage::storageDefinitionIsDeleted | Deprecated | protected | function | Determines whether the passed field has been already deleted. | ||
SqlContentEntityStorage::wrapSchemaException | protected | function | Wraps a database schema exception into an entity storage exception. | |||
SqlContentEntityStorage::__construct | public | function | Constructs a SqlContentEntityStorage object. | Overrides ContentEntityStorageBase::__construct | 1 | |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | |||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | |||
UserStorage::deleteRoleReferences | public | function | Delete role references. | Overrides UserStorageInterface::deleteRoleReferences | ||
UserStorage::doSaveFieldItems | protected | function | Writes entity field values to the storage. | Overrides SqlContentEntityStorage::doSaveFieldItems | ||
UserStorage::isColumnSerial | protected | function | Checks whether a field column should be treated as serial. | Overrides SqlContentEntityStorage::isColumnSerial | ||
UserStorage::updateLastAccessTimestamp | public | function | Update the last access timestamp of the user. | Overrides UserStorageInterface::updateLastAccessTimestamp | ||
UserStorage::updateLastLoginTimestamp | public | function | Update the last login timestamp of the user. | Overrides UserStorageInterface::updateLastLoginTimestamp |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.