View source
<?php
namespace Drupal\user\Entity;
use Drupal\Core\Entity\ContentEntityBase;
use Drupal\Core\Entity\EntityChangedTrait;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Language\LanguageInterface;
use Drupal\user\RoleInterface;
use Drupal\user\StatusItem;
use Drupal\user\TimeZoneItem;
use Drupal\user\UserInterface;
class User extends ContentEntityBase implements UserInterface {
use EntityChangedTrait;
protected static $anonymousUser;
public function isNew() {
return !empty($this->enforceIsNew) || $this
->id() === NULL;
}
public function label() {
return $this
->getDisplayName();
}
public function preSave(EntityStorageInterface $storage) {
parent::preSave($storage);
foreach ($this
->get('roles') as $index => $item) {
if (in_array($item->target_id, [
RoleInterface::ANONYMOUS_ID,
RoleInterface::AUTHENTICATED_ID,
])) {
$this
->get('roles')
->offsetUnset($index);
}
}
foreach ([
'user_cancel_method',
'user_cancel_notify',
] as $key) {
if (isset($this->{$key})) {
\Drupal::service('user.data')
->set('user', $this
->id(), substr($key, 5), $this->{$key});
}
}
}
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
if ($update) {
$session_manager = \Drupal::service('session_manager');
if ($this->pass->value != $this->original->pass->value) {
$session_manager
->delete($this
->id());
if ($this
->id() == \Drupal::currentUser()
->id()) {
\Drupal::service('session')
->migrate();
}
}
if ($this->original->status->value != $this->status->value && $this->status->value == 0) {
$session_manager
->delete($this
->id());
}
if ($this->status->value != $this->original->status->value) {
$op = $this->status->value == 1 ? 'status_activated' : 'status_blocked';
_user_mail_notify($op, $this);
}
}
}
public static function postDelete(EntityStorageInterface $storage, array $entities) {
parent::postDelete($storage, $entities);
$uids = array_keys($entities);
\Drupal::service('user.data')
->delete(NULL, $uids);
}
public function getRoles($exclude_locked_roles = FALSE) {
$roles = [];
if (!$exclude_locked_roles) {
if ($this
->isAuthenticated()) {
$roles[] = RoleInterface::AUTHENTICATED_ID;
}
else {
$roles[] = RoleInterface::ANONYMOUS_ID;
}
}
foreach ($this
->get('roles') as $role) {
if ($role->target_id) {
$roles[] = $role->target_id;
}
}
return $roles;
}
public function hasRole($rid) {
return in_array($rid, $this
->getRoles());
}
public function addRole($rid) {
if (in_array($rid, [
RoleInterface::AUTHENTICATED_ID,
RoleInterface::ANONYMOUS_ID,
])) {
throw new \InvalidArgumentException('Anonymous or authenticated role ID must not be assigned manually.');
}
$roles = $this
->getRoles(TRUE);
$roles[] = $rid;
$this
->set('roles', array_unique($roles));
}
public function removeRole($rid) {
$this
->set('roles', array_diff($this
->getRoles(TRUE), [
$rid,
]));
}
public function hasPermission($permission) {
if ((int) $this
->id() === 1) {
return TRUE;
}
return $this
->getRoleStorage()
->isPermissionInRoles($permission, $this
->getRoles());
}
public function getPassword() {
return $this
->get('pass')->value;
}
public function setPassword($password) {
$this
->get('pass')->value = $password;
return $this;
}
public function getEmail() {
return $this
->get('mail')->value;
}
public function setEmail($mail) {
$this
->get('mail')->value = $mail;
return $this;
}
public function getCreatedTime() {
return $this
->get('created')->value;
}
public function getLastAccessedTime() {
return $this
->get('access')->value;
}
public function setLastAccessTime($timestamp) {
$this
->get('access')->value = $timestamp;
return $this;
}
public function getLastLoginTime() {
return $this
->get('login')->value;
}
public function setLastLoginTime($timestamp) {
$this
->get('login')->value = $timestamp;
return $this;
}
public function isActive() {
return $this
->get('status')->value == 1;
}
public function isBlocked() {
return $this
->get('status')->value == 0;
}
public function activate() {
$this
->get('status')->value = 1;
return $this;
}
public function block() {
$this
->get('status')->value = 0;
return $this;
}
public function getTimeZone() {
return $this
->get('timezone')->value;
}
public function getPreferredLangcode($fallback_to_default = TRUE) {
$language_list = $this
->languageManager()
->getLanguages();
$preferred_langcode = $this
->get('preferred_langcode')->value;
if (!empty($preferred_langcode) && isset($language_list[$preferred_langcode])) {
return $language_list[$preferred_langcode]
->getId();
}
else {
return $fallback_to_default ? $this
->languageManager()
->getDefaultLanguage()
->getId() : '';
}
}
public function getPreferredAdminLangcode($fallback_to_default = TRUE) {
$language_list = $this
->languageManager()
->getLanguages();
$preferred_langcode = $this
->get('preferred_admin_langcode')->value;
if (!empty($preferred_langcode) && isset($language_list[$preferred_langcode])) {
return $language_list[$preferred_langcode]
->getId();
}
else {
return $fallback_to_default ? $this
->languageManager()
->getDefaultLanguage()
->getId() : '';
}
}
public function getInitialEmail() {
return $this
->get('init')->value;
}
public function isAuthenticated() {
return $this
->id() > 0;
}
public function isAnonymous() {
return $this
->id() == 0;
}
public function getUsername() {
@trigger_error('\\Drupal\\Core\\Session\\AccountInterface::getUsername() is deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0. Use \\Drupal\\Core\\Session\\AccountInterface::getAccountName() or \\Drupal\\user\\UserInterface::getDisplayName() instead. See https://www.drupal.org/node/2572493', E_USER_DEPRECATED);
return $this
->getAccountName();
}
public function getAccountName() {
return $this
->get('name')->value ?: '';
}
public function getDisplayName() {
$name = $this
->getAccountName() ?: \Drupal::config('user.settings')
->get('anonymous');
\Drupal::moduleHandler()
->alter('user_format_name', $name, $this);
return $name;
}
public function setUsername($username) {
$this
->set('name', $username);
return $this;
}
public function setExistingPassword($password) {
$this
->get('pass')->existing = $password;
}
public function checkExistingPassword(UserInterface $account_unchanged) {
return strlen($this
->get('pass')->existing) > 0 && \Drupal::service('password')
->check(trim($this
->get('pass')->existing), $account_unchanged
->getPassword());
}
public static function getAnonymousUser() {
if (!isset(static::$anonymousUser)) {
$entity_type_manager = \Drupal::entityTypeManager();
$entity_type = $entity_type_manager
->getDefinition('user');
$class = $entity_type
->getClass();
static::$anonymousUser = new $class([
'uid' => [
LanguageInterface::LANGCODE_DEFAULT => 0,
],
'name' => [
LanguageInterface::LANGCODE_DEFAULT => '',
],
'langcode' => [
LanguageInterface::LANGCODE_DEFAULT => LanguageInterface::LANGCODE_NOT_SPECIFIED,
],
], $entity_type
->id());
}
return clone static::$anonymousUser;
}
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields = parent::baseFieldDefinitions($entity_type);
$fields['uid']
->setLabel(t('User ID'))
->setDescription(t('The user ID.'));
$fields['uuid']
->setDescription(t('The user UUID.'));
$fields['langcode']
->setLabel(t('Language code'))
->setDescription(t('The user language code.'))
->setDisplayOptions('form', [
'region' => 'hidden',
]);
$fields['preferred_langcode'] = BaseFieldDefinition::create('language')
->setLabel(t('Preferred language code'))
->setDescription(t("The user's preferred language code for receiving emails and viewing the site."))
->addPropertyConstraints('value', [
'AllowedValues' => [
'callback' => __CLASS__ . '::getAllowedConfigurableLanguageCodes',
],
]);
$fields['preferred_admin_langcode'] = BaseFieldDefinition::create('language')
->setLabel(t('Preferred admin language code'))
->setDescription(t("The user's preferred language code for viewing administration pages."))
->setDefaultValue([
0 => [
'value' => NULL,
],
])
->addPropertyConstraints('value', [
'AllowedValues' => [
'callback' => __CLASS__ . '::getAllowedConfigurableLanguageCodes',
],
]);
$fields['name'] = BaseFieldDefinition::create('string')
->setLabel(t('Name'))
->setDescription(t('The name of this user.'))
->setRequired(TRUE)
->setConstraints([
'UserName' => [],
'UserNameUnique' => [],
]);
$fields['name']
->getItemDefinition()
->setClass('\\Drupal\\user\\UserNameItem');
$fields['pass'] = BaseFieldDefinition::create('password')
->setLabel(t('Password'))
->setDescription(t('The password of this user (hashed).'))
->addConstraint('ProtectedUserField');
$fields['mail'] = BaseFieldDefinition::create('email')
->setLabel(t('Email'))
->setDescription(t('The email of this user.'))
->setDefaultValue('')
->addConstraint('UserMailUnique')
->addConstraint('UserMailRequired')
->addConstraint('ProtectedUserField');
$fields['timezone'] = BaseFieldDefinition::create('string')
->setLabel(t('Timezone'))
->setDescription(t('The timezone of this user.'))
->setSetting('max_length', 32)
->addPropertyConstraints('value', [
'AllowedValues' => [
'callback' => __CLASS__ . '::getAllowedTimezones',
],
]);
$fields['timezone']
->getItemDefinition()
->setClass(TimeZoneItem::class);
$fields['status'] = BaseFieldDefinition::create('boolean')
->setLabel(t('User status'))
->setDescription(t('Whether the user is active or blocked.'))
->setDefaultValue(FALSE);
$fields['status']
->getItemDefinition()
->setClass(StatusItem::class);
$fields['created'] = BaseFieldDefinition::create('created')
->setLabel(t('Created'))
->setDescription(t('The time that the user was created.'));
$fields['changed'] = BaseFieldDefinition::create('changed')
->setLabel(t('Changed'))
->setDescription(t('The time that the user was last edited.'))
->setTranslatable(TRUE);
$fields['access'] = BaseFieldDefinition::create('timestamp')
->setLabel(t('Last access'))
->setDescription(t('The time that the user last accessed the site.'))
->setDefaultValue(0);
$fields['login'] = BaseFieldDefinition::create('timestamp')
->setLabel(t('Last login'))
->setDescription(t('The time that the user last logged in.'))
->setDefaultValue(0);
$fields['init'] = BaseFieldDefinition::create('email')
->setLabel(t('Initial email'))
->setDescription(t('The email address used for initial account creation.'))
->setDefaultValue('');
$fields['roles'] = BaseFieldDefinition::create('entity_reference')
->setLabel(t('Roles'))
->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
->setDescription(t('The roles the user has.'))
->setSetting('target_type', 'user_role');
return $fields;
}
protected function getRoleStorage() {
return \Drupal::entityTypeManager()
->getStorage('user_role');
}
public static function getAllowedTimezones() {
return array_keys(system_time_zones());
}
public static function getAllowedConfigurableLanguageCodes() {
return array_keys(\Drupal::languageManager()
->getLanguages(LanguageInterface::STATE_CONFIGURABLE));
}
}