class UserName in Drupal 10

Validates whether a user name is valid.

Plugin annotation

@ViewsArgumentValidator(
  id = "user_name",
  title = @Translation("User name"),
  entity_type = "user"
)

Hierarchy

• class \Drupal\views\Plugin\views\argument_validator\Entity extends \Drupal\views\Plugin\views\argument_validator\ArgumentValidatorPluginBase
  • class \Drupal\user\Plugin\views\argument_validator\User
    • class \Drupal\user\Plugin\views\argument_validator\UserName

3 string references to 'UserName'

User::baseFieldDefinitions in core/modules/user/src/Entity/User.php

UserPasswordForm::validateForm in core/modules/user/src/Form/UserPasswordForm.php

Form validation handler.

user_validate_name in core/modules/user/user.module

Verify the syntax of the given name.

File

core/modules/user/src/Plugin/views/argument_validator/UserName.php, line 16

Namespace

Drupal\user\Plugin\views\argument_validator

class UserName extends User {

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $entity_type = $this->entityTypeManager
      ->getDefinition('user');
    $form['multiple']['#options'] = [
      0 => $this
        ->t('Single name', [
        '%type' => $entity_type
          ->getLabel(),
      ]),
      1 => $this
        ->t('One or more names separated by , or +', [
        '%type' => $entity_type
          ->getLabel(),
      ]),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function validateArgument($argument) {
    if ($this->multipleCapable && $this->options['multiple']) {

      // At this point only interested in individual IDs no matter what type,
      // just splitting by the allowed delimiters.
      $names = array_filter(preg_split('/[,+ ]/', $argument));
    }
    elseif ($argument) {
      $names = [
        $argument,
      ];
    }
    else {
      return FALSE;
    }
    $accounts = $this->userStorage
      ->loadByProperties([
      'name' => $names,
    ]);

    // If there are no accounts, return FALSE now. As we will not enter the
    // loop below otherwise.
    if (empty($accounts)) {
      return FALSE;
    }

    // Validate each account. If any fails break out and return false.
    foreach ($accounts as $account) {
      if (!in_array($account
        ->getAccountName(), $names) || !$this
        ->validateEntity($account)) {
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function processSummaryArguments(&$args) {

    // If the validation says the input is a username, we should reverse the
    // argument so it works for example for generation summary urls.
    $uids_arg_keys = array_flip($args);
    foreach ($this->userStorage
      ->loadMultiple($args) as $uid => $account) {
      $args[$uids_arg_keys[$uid]] = $account
        ->label();
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Entity::$entityTypeBundleInfo	protected	property	The entity bundle info.
Entity::$entityTypeManager	protected	property	The entity type manager.
Entity::$multipleCapable	protected	property	If this validator can handle multiple arguments.
Entity::create	public static	function
Entity::getContextDefinition	public	function
User::$userStorage	protected	property	The user storage.
User::calculateDependencies	public	function	Overrides Entity::calculateDependencies
User::defineOptions	protected	function	Overrides Entity::defineOptions
User::submitOptionsForm	public	function	Overrides Entity::submitOptionsForm
User::validateEntity	protected	function	Validates an individual entity against class access settings. Overrides Entity::validateEntity
User::__construct	public	function	Constructs a \Drupal\views\Plugin\views\argument_validator\Entity object. Overrides Entity::__construct
UserName::buildOptionsForm	public	function	Overrides User::buildOptionsForm
UserName::processSummaryArguments	public	function
UserName::validateArgument	public	function	Overrides Entity::validateArgument