class UserViewsData in Drupal 9

Same name and namespace in other branches

8 core/modules/user/src/UserViewsData.php \Drupal\user\UserViewsData

Provides the views data for the user entity type.

Hierarchy

class \Drupal\views\EntityViewsData implements EntityHandlerInterface, EntityViewsDataInterface uses StringTranslationTrait
- class \Drupal\user\UserViewsData

Expanded class hierarchy of UserViewsData

File

core/modules/user/src/UserViewsData.php, line 10

Namespace

Drupal\user

View source

class UserViewsData extends EntityViewsData {

  /**
   * {@inheritdoc}
   */
  public function getViewsData() {
    $data = parent::getViewsData();
    $data['users_field_data']['table']['base']['help'] = $this
      ->t('Users who have created accounts on your site.');
    $data['users_field_data']['table']['base']['access query tag'] = 'user_access';
    $data['users_field_data']['table']['wizard_id'] = 'user';
    $data['users_field_data']['uid']['argument']['id'] = 'user_uid';
    $data['users_field_data']['uid']['argument'] += [
      'name table' => 'users_field_data',
      'name field' => 'name',
      'empty field name' => \Drupal::config('user.settings')
        ->get('anonymous'),
    ];
    $data['users_field_data']['uid']['filter']['id'] = 'user_name';
    $data['users_field_data']['uid']['filter']['title'] = $this
      ->t('Name (autocomplete)');
    $data['users_field_data']['uid']['filter']['help'] = $this
      ->t('The user or author name. Uses an autocomplete widget to find a user name, the actual filter uses the resulting user ID.');
    $data['users_field_data']['uid']['relationship'] = [
      'title' => $this
        ->t('Content authored'),
      'help' => $this
        ->t('Relate content to the user who created it. This relationship will create one record for each content item created by the user.'),
      'id' => 'standard',
      'base' => 'node_field_data',
      'base field' => 'uid',
      'field' => 'uid',
      'label' => $this
        ->t('nodes'),
    ];
    $data['users_field_data']['uid_raw'] = [
      'help' => $this
        ->t('The raw numeric user ID.'),
      'real field' => 'uid',
      'filter' => [
        'title' => $this
          ->t('The user ID'),
        'id' => 'numeric',
      ],
    ];
    $data['users_field_data']['uid_representative'] = [
      'relationship' => [
        'title' => $this
          ->t('Representative node'),
        'label' => $this
          ->t('Representative node'),
        'help' => $this
          ->t('Obtains a single representative node for each user, according to a chosen sort criterion.'),
        'id' => 'groupwise_max',
        'relationship field' => 'uid',
        'outer field' => 'users_field_data.uid',
        'argument table' => 'users_field_data',
        'argument field' => 'uid',
        'base' => 'node_field_data',
        'field' => 'nid',
        'relationship' => 'node_field_data:uid',
      ],
    ];
    $data['users']['uid_current'] = [
      'real field' => 'uid',
      'title' => $this
        ->t('Current'),
      'help' => $this
        ->t('Filter the view to the currently logged in user.'),
      'filter' => [
        'id' => 'user_current',
        'type' => 'yes-no',
      ],
    ];
    $data['users_field_data']['name']['help'] = $this
      ->t('The user or author name.');
    $data['users_field_data']['name']['field']['default_formatter'] = 'user_name';
    $data['users_field_data']['name']['filter']['title'] = $this
      ->t('Name (raw)');
    $data['users_field_data']['name']['filter']['help'] = $this
      ->t('The user or author name. This filter does not check if the user exists and allows partial matching. Does not use autocomplete.');

    // Note that this field implements field level access control.
    $data['users_field_data']['mail']['help'] = $this
      ->t('Email address for a given user. This field is normally not shown to users, so be cautious when using it.');
    $data['users_field_data']['langcode']['help'] = $this
      ->t('Original language of the user information');
    $data['users_field_data']['langcode']['help'] = $this
      ->t('Language of the translation of user information');
    $data['users_field_data']['preferred_langcode']['title'] = $this
      ->t('Preferred language');
    $data['users_field_data']['preferred_langcode']['help'] = $this
      ->t('Preferred language of the user');
    $data['users_field_data']['preferred_admin_langcode']['title'] = $this
      ->t('Preferred admin language');
    $data['users_field_data']['preferred_admin_langcode']['help'] = $this
      ->t('Preferred administrative language of the user');
    $data['users_field_data']['created_fulldate'] = [
      'title' => $this
        ->t('Created date'),
      'help' => $this
        ->t('Date in the form of CCYYMMDD.'),
      'argument' => [
        'field' => 'created',
        'id' => 'date_fulldate',
      ],
    ];
    $data['users_field_data']['created_year_month'] = [
      'title' => $this
        ->t('Created year + month'),
      'help' => $this
        ->t('Date in the form of YYYYMM.'),
      'argument' => [
        'field' => 'created',
        'id' => 'date_year_month',
      ],
    ];
    $data['users_field_data']['created_year'] = [
      'title' => $this
        ->t('Created year'),
      'help' => $this
        ->t('Date in the form of YYYY.'),
      'argument' => [
        'field' => 'created',
        'id' => 'date_year',
      ],
    ];
    $data['users_field_data']['created_month'] = [
      'title' => $this
        ->t('Created month'),
      'help' => $this
        ->t('Date in the form of MM (01 - 12).'),
      'argument' => [
        'field' => 'created',
        'id' => 'date_month',
      ],
    ];
    $data['users_field_data']['created_day'] = [
      'title' => $this
        ->t('Created day'),
      'help' => $this
        ->t('Date in the form of DD (01 - 31).'),
      'argument' => [
        'field' => 'created',
        'id' => 'date_day',
      ],
    ];
    $data['users_field_data']['created_week'] = [
      'title' => $this
        ->t('Created week'),
      'help' => $this
        ->t('Date in the form of WW (01 - 53).'),
      'argument' => [
        'field' => 'created',
        'id' => 'date_week',
      ],
    ];
    $data['users_field_data']['status']['filter']['label'] = $this
      ->t('Active');
    $data['users_field_data']['status']['filter']['type'] = 'yes-no';
    $data['users_field_data']['changed']['title'] = $this
      ->t('Updated date');
    $data['users_field_data']['changed_fulldate'] = [
      'title' => $this
        ->t('Updated date'),
      'help' => $this
        ->t('Date in the form of CCYYMMDD.'),
      'argument' => [
        'field' => 'changed',
        'id' => 'date_fulldate',
      ],
    ];
    $data['users_field_data']['changed_year_month'] = [
      'title' => $this
        ->t('Updated year + month'),
      'help' => $this
        ->t('Date in the form of YYYYMM.'),
      'argument' => [
        'field' => 'changed',
        'id' => 'date_year_month',
      ],
    ];
    $data['users_field_data']['changed_year'] = [
      'title' => $this
        ->t('Updated year'),
      'help' => $this
        ->t('Date in the form of YYYY.'),
      'argument' => [
        'field' => 'changed',
        'id' => 'date_year',
      ],
    ];
    $data['users_field_data']['changed_month'] = [
      'title' => $this
        ->t('Updated month'),
      'help' => $this
        ->t('Date in the form of MM (01 - 12).'),
      'argument' => [
        'field' => 'changed',
        'id' => 'date_month',
      ],
    ];
    $data['users_field_data']['changed_day'] = [
      'title' => $this
        ->t('Updated day'),
      'help' => $this
        ->t('Date in the form of DD (01 - 31).'),
      'argument' => [
        'field' => 'changed',
        'id' => 'date_day',
      ],
    ];
    $data['users_field_data']['changed_week'] = [
      'title' => $this
        ->t('Updated week'),
      'help' => $this
        ->t('Date in the form of WW (01 - 53).'),
      'argument' => [
        'field' => 'changed',
        'id' => 'date_week',
      ],
    ];
    $data['users']['data'] = [
      'title' => $this
        ->t('Data'),
      'help' => $this
        ->t('Provides access to the user data service.'),
      'real field' => 'uid',
      'field' => [
        'id' => 'user_data',
      ],
    ];
    $data['users']['user_bulk_form'] = [
      'title' => $this
        ->t('Bulk update'),
      'help' => $this
        ->t('Add a form element that lets you run operations on multiple users.'),
      'field' => [
        'id' => 'user_bulk_form',
      ],
    ];

    // Alter the user roles target_id column.
    $data['user__roles']['roles_target_id']['field']['id'] = 'user_roles';
    $data['user__roles']['roles_target_id']['field']['no group by'] = TRUE;
    $data['user__roles']['roles_target_id']['filter']['id'] = 'user_roles';
    $data['user__roles']['roles_target_id']['filter']['allow empty'] = TRUE;
    $data['user__roles']['roles_target_id']['argument'] = [
      'id' => 'user__roles_rid',
      'name table' => 'role',
      'name field' => 'name',
      'empty field name' => $this
        ->t('No role'),
      'zero is null' => TRUE,
      'numeric' => TRUE,
    ];
    $data['user__roles']['permission'] = [
      'title' => $this
        ->t('Permission'),
      'help' => $this
        ->t('The user permissions.'),
      'field' => [
        'id' => 'user_permissions',
        'no group by' => TRUE,
      ],
      'filter' => [
        'id' => 'user_permissions',
        'real field' => 'roles_target_id',
      ],
    ];

    // Unset the "pass" field because the access control handler for the user
    // entity type allows editing the password, but not viewing it.
    unset($data['users_field_data']['pass']);
    return $data;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityViewsData::$entityFieldManager	protected	property	The entity field manager.
EntityViewsData::$entityType	protected	property	Entity type for this views data handler instance.
EntityViewsData::$entityTypeManager	protected	property	The entity type manager.
EntityViewsData::$fieldStorageDefinitions	protected	property	The field storage definitions for all base fields of the entity type.
EntityViewsData::$moduleHandler	protected	property	The module handler.
EntityViewsData::$storage	protected	property	The storage used for this entity type.
EntityViewsData::$translationManager	protected	property	The translation manager.
EntityViewsData::addEntityLinks	protected	function	Sets the entity links in case corresponding link templates exist.
EntityViewsData::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
EntityViewsData::getFieldStorageDefinitions	protected	function	Gets the field storage definitions.
EntityViewsData::getViewsTableForEntityType	public	function	Gets the table of an entity type to be used as base table in views. Overrides EntityViewsDataInterface::getViewsTableForEntityType
EntityViewsData::mapFieldDefinition	protected	function	Puts the views data for a single field onto the views data.
EntityViewsData::mapSingleFieldViewsData	protected	function	Provides the views data for a given data type and schema field.
EntityViewsData::processViewsDataForEntityReference	protected	function	Processes the views data for an entity reference field.
EntityViewsData::processViewsDataForLanguage	protected	function	Processes the views data for a language field.
EntityViewsData::processViewsDataForTextLong	protected	function	Processes the views data for a text field with formatting.
EntityViewsData::processViewsDataForUuid	protected	function	Processes the views data for a UUID field.
EntityViewsData::__construct	public	function	Constructs an EntityViewsData object.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.
UserViewsData::getViewsData	public	function	Returns views data for the entity type. Overrides EntityViewsData::getViewsData

You are here

class UserViewsData in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation