UserInterface

Provides an interface defining a user entity.

Hierarchy

Related topics

User accounts, permissions, and roles
API for user accounts, access checking, roles, and permissions.

File

core/modules/user/src/UserInterface.php, line 14

Namespace

Drupal\user

Members

Name Modifiers Type Description
AccessibleInterface::access public function Checks data value access.
AccountInterface::ANONYMOUS_ROLE constant Role ID for anonymous users.
AccountInterface::AUTHENTICATED_ROLE constant Role ID for authenticated users.
AccountInterface::getAccountName public function Returns the unaltered login name of this account.
AccountInterface::getDisplayName public function Returns the display name of this account.
AccountInterface::getEmail public function Returns the email address of this account.
AccountInterface::getLastAccessedTime public function The timestamp when the account last accessed the site.
AccountInterface::getPreferredAdminLangcode public function Returns the preferred administrative language code of the account.
AccountInterface::getPreferredLangcode public function Returns the preferred language code of the account.
AccountInterface::getRoles public function Returns a list of roles.
AccountInterface::getTimeZone public function Returns the timezone of this account.
AccountInterface::getUsername Deprecated public function Returns the unaltered login name of this account.
AccountInterface::hasPermission public function Checks whether a user has a certain permission.
AccountInterface::isAnonymous public function Returns TRUE if the account is anonymous.
AccountInterface::isAuthenticated public function Returns TRUE if the account is authenticated.
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object.
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached.
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object.
ContentEntityInterface::hasTranslationChanges public function Determines if the current translation of the entity has unsaved changes.
ContentEntityInterface::isRevisionTranslationAffected public function Checks whether the current translation is affected by the current revision.
ContentEntityInterface::setRevisionTranslationAffected public function Marks the current revision translation as affected.
EntityChangedInterface::getChangedTime public function Gets the timestamp of the last entity change for the current translation.
EntityChangedInterface::getChangedTimeAcrossTranslations public function Gets the timestamp of the last entity change across all translations.
EntityChangedInterface::setChangedTime public function Sets the timestamp of the last entity change for the current translation.
EntityInterface::bundle public function Gets the bundle of the entity.
EntityInterface::create public static function Constructs a new entity object, without permanently saving it.
EntityInterface::createDuplicate public function Creates a duplicate of the entity.
EntityInterface::delete public function Deletes an entity permanently.
EntityInterface::enforceIsNew public function Enforces an entity to be new.
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches.
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies.
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name.
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity.
EntityInterface::getEntityType public function Gets the entity type definition.
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity.
EntityInterface::getOriginalId public function Gets the original ID.
EntityInterface::getTypedData public function Gets a typed data object for this entity object.
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key.
EntityInterface::id public function Gets the identifier.
EntityInterface::isNew public function Determines whether the entity is new.
EntityInterface::label public function Gets the label of the entity.
EntityInterface::language public function Gets the language of the entity.
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink().
EntityInterface::load public static function Loads an entity.
EntityInterface::loadMultiple public static function Loads one or more entities.
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked.
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked.
EntityInterface::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked.
EntityInterface::preCreate public static function Changes the values of an entity before it is created.
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked.
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked.
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity.
EntityInterface::save public function Saves an entity permanently.
EntityInterface::setOriginalId public function Sets the original ID.
EntityInterface::toLink public function Generates the HTML for a link to this entity.
EntityInterface::toUrl public function Gets the URL object for the entity.
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity.
EntityInterface::url Deprecated public function Gets the public URL for this entity.
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity.
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier).
FieldableEntityInterface::baseFieldDefinitions public static function Provides base field definitions for an entity type.
FieldableEntityInterface::bundleFieldDefinitions public static function Provides field definitions for a specific bundle.
FieldableEntityInterface::get public function Gets a field item list.
FieldableEntityInterface::getFieldDefinition public function Gets the definition of a contained field.
FieldableEntityInterface::getFieldDefinitions public function Gets an array of field definitions of all contained fields.
FieldableEntityInterface::getFields public function Gets an array of all field item lists.
FieldableEntityInterface::getTranslatableFields public function Gets an array of field item lists for translatable fields.
FieldableEntityInterface::hasField public function Determines whether the entity has a field with the given name.
FieldableEntityInterface::isValidationRequired public function Checks whether entity validation is required before saving the entity.
FieldableEntityInterface::onChange public function Reacts to changes to a field.
FieldableEntityInterface::set public function Sets a field value.
FieldableEntityInterface::setValidationRequired public function Sets whether entity validation is required before saving the entity.
FieldableEntityInterface::toArray public function Gets an array of all field values. Overrides EntityInterface::toArray
FieldableEntityInterface::validate public function Validates the currently set values.
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata.
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts.
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags.
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age.
RevisionableInterface::getRevisionId public function Gets the revision identifier of the entity.
RevisionableInterface::isDefaultRevision public function Checks if this entity is the default revision.
RevisionableInterface::isNewRevision public function Determines whether a new revision should be created on save.
RevisionableInterface::preSaveRevision public function Acts on a revision before it gets saved.
RevisionableInterface::setNewRevision public function Enforces an entity to be saved as a new revision.
TranslatableInterface::addTranslation public function Adds a new translation to the translatable object.
TranslatableInterface::getTranslation public function Gets a translation of the data.
TranslatableInterface::getTranslationLanguages public function Returns the languages the data is translated to.
TranslatableInterface::getUntranslated public function Returns the translatable object referring to the original language.
TranslatableInterface::hasTranslation public function Returns TRUE there is a translation for the given language code.
TranslatableInterface::isDefaultTranslation public function Checks whether the translation is the default one.
TranslatableInterface::isNewTranslation public function Checks whether the translation is new.
TranslatableInterface::isTranslatable public function Returns the translation support status.
TranslatableInterface::removeTranslation public function Removes the translation identified by the given language code.
UserInterface::activate public function Activates the user.
UserInterface::addRole public function Add a role to a user.
UserInterface::block public function Blocks the user.
UserInterface::checkExistingPassword public function Checks the existing password if set.
UserInterface::getCreatedTime public function Returns the creation time of the user as a UNIX timestamp.
UserInterface::getInitialEmail public function Returns the email that was used when the user was registered.
UserInterface::getLastLoginTime public function Returns the UNIX timestamp when the user last logged in.
UserInterface::getPassword public function Returns the hashed password.
UserInterface::hasRole public function Whether a user has a certain role.
UserInterface::isActive public function Returns TRUE if the user is active.
UserInterface::isBlocked public function Returns TRUE if the user is blocked.
UserInterface::removeRole public function Remove a role from a user.
UserInterface::setEmail public function Sets the email address of the user.
UserInterface::setExistingPassword public function Sets the existing plain text password.
UserInterface::setLastAccessTime public function Sets the UNIX timestamp when the user last accessed the site..
UserInterface::setLastLoginTime public function Sets the UNIX timestamp when the user last logged in.
UserInterface::setPassword public function Sets the user password.
UserInterface::setUsername public function Sets the username of this account.
doc_Drupal
2016-10-29 09:52:33
Comments
Leave a Comment

Please login to continue.