public function UserStorageController::baseFieldDefinitions

Defines the base properties of the entity type.

@todo: Define abstract once all entity types have been converted.

Overrides DatabaseStorageController::baseFieldDefinitions

File

drupal/core/modules/user/lib/Drupal/user/UserStorageController.php, line 254

Definition of Drupal\user\UserStorageController.

Class

UserStorageController

Controller class for users.

Namespace

Code

public function baseFieldDefinitions() {
  $properties['uid'] = array(
    'label' => t('User ID'),
    'description' => t('The user ID.'),
    'type' => 'integer_field',
    'read-only' => TRUE,
  );
  $properties['uuid'] = array(
    'label' => t('UUID'),
    'description' => t('The user UUID.'),
    'type' => 'string_field',
    'read-only' => TRUE,
  );
  $properties['langcode'] = array(
    'label' => t('Language code'),
    'description' => t('The user language code.'),
    'type' => 'language_field',
  );
  $properties['preferred_langcode'] = array(
    'label' => t('Language code'),
    'description' => t("The user's preferred langcode for receiving emails and viewing the site."),
    'type' => 'language_field',
  );
  $properties['preferred_admin_langcode'] = array(
    'label' => t('Language code'),
    'description' => t("The user's preferred langcode for viewing administration pages."),
    'type' => 'language_field',
  );
  $properties['name'] = array(
    'label' => t('Name'),
    'description' => t('The name of this user'),
    'type' => 'string_field',
  );
  $properties['pass'] = array(
    'label' => t('Name'),
    'description' => t('The password of this user (hashed)'),
    'type' => 'string_field',
  );
  $properties['mail'] = array(
    'label' => t('Name'),
    'description' => t('The e-mail of this user'),
    'type' => 'string_field',
  );
  $properties['signature'] = array(
    'label' => t('Name'),
    'description' => t('The signature of this user'),
    'type' => 'string_field',
  );
  $properties['signature_format'] = array(
    'label' => t('Name'),
    'description' => t('The signature format of this user'),
    'type' => 'string_field',
  );
  $properties['theme'] = array(
    'label' => t('Theme'),
    'description' => t('The default theme of this user'),
    'type' => 'string_field',
  );
  $properties['timezone'] = array(
    'label' => t('Timeone'),
    'description' => t('The timezone of this user'),
    'type' => 'string_field',
  );
  $properties['status'] = array(
    'label' => t('User status'),
    'description' => t('Whether the user is active (1) or blocked (0).'),
    'type' => 'boolean_field',
  );
  $properties['created'] = array(
    'label' => t('Created'),
    'description' => t('The time that the node was created.'),
    'type' => 'integer_field',
  );
  $properties['access'] = array(
    'label' => t('Last access'),
    'description' => t('The time that the user last accessed the site.'),
    'type' => 'integer_field',
  );
  $properties['login'] = array(
    'label' => t('Last login'),
    'description' => t('The time that the user last logged in.'),
    'type' => 'integer_field',
  );
  $properties['init'] = array(
    'label' => t('Init'),
    'description' => t('The email address used for initial account creation.'),
    'type' => 'string_field',
  );
  $properties['roles'] = array(
    'label' => t('Roles'),
    'description' => t('The roles the user has.'),
    'type' => 'string_field',
  );
  return $properties;
}