Name.php

Same filename in other branches
  1. 9 core/modules/user/src/Plugin/views/filter/Name.php
  2. 10 core/modules/user/src/Plugin/views/filter/Name.php
  3. 11.x core/modules/user/src/Plugin/views/filter/Name.php

Namespace

Drupal\user\Plugin\views\filter

File

core/modules/user/src/Plugin/views/filter/Name.php

View source
<?php

namespace Drupal\user\Plugin\views\filter;

use Drupal\Core\Entity\Element\EntityAutocomplete;
use Drupal\Core\Form\FormStateInterface;
use Drupal\user\Entity\User;
use Drupal\views\Plugin\views\filter\InOperator;

/**
 * Filter handler for usernames.
 *
 * @ingroup views_filter_handlers
 *
 * @ViewsFilter("user_name")
 */
class Name extends InOperator {
    protected $alwaysMultiple = TRUE;
    protected function valueForm(&$form, FormStateInterface $form_state) {
        $users = $this->value ? User::loadMultiple($this->value) : [];
        $default_value = EntityAutocomplete::getEntityLabels($users);
        $form['value'] = [
            '#type' => 'entity_autocomplete',
            '#title' => $this->t('Usernames'),
            '#description' => $this->t('Enter a comma separated list of user names.'),
            '#target_type' => 'user',
            '#tags' => TRUE,
            '#default_value' => $default_value,
            '#process_default_value' => $this->isExposed(),
        ];
        $user_input = $form_state->getUserInput();
        if ($form_state->get('exposed') && !isset($user_input[$this->options['expose']['identifier']])) {
            $user_input[$this->options['expose']['identifier']] = $default_value;
            $form_state->setUserInput($user_input);
        }
    }
    protected function valueValidate($form, FormStateInterface $form_state) {
        $uids = [];
        if ($values = $form_state->getValue([
            'options',
            'value',
        ])) {
            foreach ($values as $value) {
                $uids[] = $value['target_id'];
            }
            sort($uids);
        }
        $form_state->setValue([
            'options',
            'value',
        ], $uids);
    }
    public function acceptExposedInput($input) {
        $rc = parent::acceptExposedInput($input);
        if ($rc) {
            // If we have previously validated input, override.
            if (isset($this->validated_exposed_input)) {
                $this->value = $this->validated_exposed_input;
            }
        }
        return $rc;
    }
    public function validateExposed(&$form, FormStateInterface $form_state) {
        if (empty($this->options['exposed'])) {
            return;
        }
        if (empty($this->options['expose']['identifier'])) {
            return;
        }
        $identifier = $this->options['expose']['identifier'];
        $input = $form_state->getValue($identifier);
        if ($this->options['is_grouped'] && isset($this->options['group_info']['group_items'][$input])) {
            $this->operator = $this->options['group_info']['group_items'][$input]['operator'];
            $input = $this->options['group_info']['group_items'][$input]['value'];
        }
        $uids = [];
        $values = $form_state->getValue($identifier);
        if ($values && (!$this->options['is_grouped'] || $this->options['is_grouped'] && $input != 'All')) {
            foreach ($values as $value) {
                $uids[] = $value['target_id'];
            }
        }
        if ($uids) {
            $this->validated_exposed_input = $uids;
        }
    }
    protected function valueSubmit($form, FormStateInterface $form_state) {
        // prevent array filter from removing our anonymous user.
    }
    
    /**
     * {@inheritdoc}
     */
    public function getValueOptions() {
        return $this->valueOptions;
    }
    public function adminSummary() {
        // set up $this->valueOptions for the parent summary
        $this->valueOptions = [];
        if ($this->value) {
            $result = \Drupal::entityTypeManager()->getStorage('user')
                ->loadByProperties([
                'uid' => $this->value,
            ]);
            foreach ($result as $account) {
                if ($account->id()) {
                    $this->valueOptions[$account->id()] = $account->label();
                }
                else {
                    // Intentionally NOT translated.
                    $this->valueOptions[$account->id()] = 'Anonymous';
                }
            }
        }
        return parent::adminSummary();
    }

}

Classes

Title Deprecated Summary
Name Filter handler for usernames.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.