You are here

Home » API reference » Views (for Drupal 7) 8.3 » Name.php

class Name in Views (for Drupal 7) 8.3

Same name in this branch
  1. 8.3 lib/Views/user/Plugin/views/filter/Name.php \Views\user\Plugin\views\filter\Name
  2. 8.3 lib/Views/user/Plugin/views/field/Name.php \Views\user\Plugin\views\field\Name

Filter handler for usernames.

Plugin annotation


@Plugin(
  id = "user_name",
  module = "user"
)

Hierarchy

Expanded class hierarchy of Name

Related topics

Views filter handlers
Handlers to tell Views how to filter queries.
1 file declares its use of Name
UidRevision.php in lib/Views/node/Plugin/views/filter/UidRevision.php
Definition of Views\node\Plugin\views\filter\UidRevision.
7 string references to 'Name'
DisplayPluginBase::buildOptionsForm in lib/Drupal/views/Plugin/views/display/DisplayPluginBase.php
Provide the default form for setting options.
file_views_data in modules/file.views.inc
Implements hook_views_data().
taxonomy_views_data in modules/taxonomy.views.inc
Implements hook_views_data().
user_views_data in modules/user.views.inc
Implements hook_views_data().
views_token_info in ./views.tokens.inc
Implements hook_token_info().

... See full list

File

lib/Views/user/Plugin/views/filter/Name.php, line 23
Definition of Views\user\Plugin\views\filter\Name.

Namespace

Views\user\Plugin\views\filter
View source 
class Name extends InOperator {
  var $always_multiple = TRUE;
  function value_form(&$form, &$form_state) {
    $values = array();
    if ($this->value) {
      $result = entity_load_multiple_by_properties('user', array(
        'uid' => $this->value,
      ));
      foreach ($result as $account) {
        if ($account->uid) {
          $values[] = $account->name;
        }
        else {
          $values[] = 'Anonymous';

          // Intentionally NOT translated.
        }
      }
    }
    sort($values);
    $default_value = implode(', ', $values);
    $form['value'] = array(
      '#type' => 'textfield',
      '#title' => t('Usernames'),
      '#description' => t('Enter a comma separated list of user names.'),
      '#default_value' => $default_value,
      '#autocomplete_path' => 'admin/views/ajax/autocomplete/user',
    );
    if (!empty($form_state['exposed']) && !isset($form_state['input'][$this->options['expose']['identifier']])) {
      $form_state['input'][$this->options['expose']['identifier']] = $default_value;
    }
  }
  function value_validate($form, &$form_state) {
    $values = drupal_explode_tags($form_state['values']['options']['value']);
    $uids = $this
      ->validate_user_strings($form['value'], $values);
    if ($uids) {
      $form_state['values']['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, &$form_state) {
    if (empty($this->options['exposed'])) {
      return;
    }
    if (empty($this->options['expose']['identifier'])) {
      return;
    }
    $identifier = $this->options['expose']['identifier'];
    $input = $form_state['values'][$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'];
    }
    $values = drupal_explode_tags($input);
    if (!$this->options['is_grouped'] || $this->options['is_grouped'] && $input != 'All') {
      $uids = $this
        ->validate_user_strings($form[$identifier], $values);
    }
    else {
      $uids = FALSE;
    }
    if ($uids) {
      $this->validated_exposed_input = $uids;
    }
  }

  /**
   * Validate the user string. Since this can come from either the form
   * or the exposed filter, this is abstracted out a bit so it can
   * handle the multiple input sources.
   */
  function validate_user_strings(&$form, $values) {
    $uids = array();
    $placeholders = array();
    $args = array();
    $results = array();
    foreach ($values as $value) {
      if (strtolower($value) == 'anonymous') {
        $uids[] = 0;
      }
      else {
        $missing[strtolower($value)] = TRUE;
        $args[] = $value;
        $placeholders[] = "'%s'";
      }
    }
    if (!$args) {
      return $uids;
    }
    $result = entity_load_multiple_by_properties('user', array(
      'name' => $args,
    ));
    foreach ($result as $account) {
      unset($missing[strtolower($account->name)]);
      $uids[] = $account->uid;
    }
    if ($missing) {
      form_error($form, format_plural(count($missing), 'Unable to find user: @users', 'Unable to find users: @users', array(
        '@users' => implode(', ', array_keys($missing)),
      )));
    }
    return $uids;
  }
  function value_submit($form, &$form_state) {

    // prevent array filter from removing our anonymous user.
  }

  // Override to do nothing.
  function get_value_options() {
  }
  public function adminSummary() {

    // set up $this->value_options for the parent summary
    $this->value_options = array();
    if ($this->value) {
      $result = entity_load_multiple_by_properties('user', array(
        'uid' => $this->value,
      ));
      foreach ($result as $account) {
        if ($account->uid) {
          $this->value_options[$account->uid] = $account->name;
        }
        else {
          $this->value_options[$account->uid] = 'Anonymous';

          // Intentionally NOT translated.
        }
      }
    }
    return parent::adminSummary();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
FilterPluginBase::$always_required property Disable the possibility to allow a exposed input to be optional.
FilterPluginBase::$group_info property Contains the information of the selected item in a gruped filter.
FilterPluginBase::$no_operator property Disable the possibility to use operators. 2
FilterPluginBase::$operator property Contains the operator which is used on the query.
FilterPluginBase::$value property Contains the actual value of the field,either configured in the views ui or entered in the exposed filters.
FilterPluginBase::buildExposedForm public function Render our chunk of the exposed filter form when selecting Overrides HandlerBase::buildExposedForm
FilterPluginBase::buildOptionsForm public function Provide the basic form which calls through to subforms. If overridden, it is best to call through to the parent, or to at least make sure all of the functions in this form are called. Overrides HandlerBase::buildOptionsForm 3
FilterPluginBase::build_group_form function Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group'
FilterPluginBase::build_group_options function Provide default options for exposed filters.
FilterPluginBase::build_group_submit function Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::build_group_validate function Validate the build group options form. 1
FilterPluginBase::canExpose public function Determine if a filter can be exposed. Overrides HandlerBase::canExpose 4
FilterPluginBase::can_build_group function Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups.
FilterPluginBase::can_group function Can this filter be used in OR groups? 1
FilterPluginBase::convert_exposed_input function
FilterPluginBase::exposedInfo public function Tell the renderer about our exposed form. This only needs to be overridden for particularly complex forms. And maybe not even then. Overrides HandlerBase::exposedInfo
FilterPluginBase::exposed_translate function Make some translations to a form item to make it more suitable to exposing.
FilterPluginBase::group_form function Build a form containing a group of operator | values to apply as a single filter.
FilterPluginBase::group_multiple_exposed_input function Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected.
FilterPluginBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase::isAGroup
FilterPluginBase::multipleExposedInput public function Returns TRUE if users can select multiple groups items of a grouped exposed filter. Overrides HandlerBase::multipleExposedInput
FilterPluginBase::operator_form function Options form subform for setting the operator. 6
FilterPluginBase::operator_submit function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
FilterPluginBase::operator_validate function Validate the operator form.
FilterPluginBase::prepare_filter_select_options function Sanitizes the HTML select element's options.
FilterPluginBase::showExposeButton public function Shortcut to display the expose/hide button. Overrides HandlerBase::showExposeButton
FilterPluginBase::show_build_group_button function Shortcut to display the build_group/hide button.
FilterPluginBase::show_build_group_form function Shortcut to display the exposed options form.
FilterPluginBase::show_operator_form function Shortcut to display the operator form.
FilterPluginBase::show_value_form function Shortcut to display the value form.
FilterPluginBase::storeExposedInput public function If set to remember exposed input in the session, store it there. Overrides HandlerBase::storeExposedInput
FilterPluginBase::store_group_input function If set to remember exposed input in the session, store it there. This function is similar to storeExposedInput but modified to work properly when the filter is a group.
FilterPluginBase::submitOptionsForm public function Simple submit handler Overrides HandlerBase::submitOptionsForm
FilterPluginBase::validateExposeForm public function Validate the options form. Overrides HandlerBase::validateExposeForm
FilterPluginBase::validateOptionsForm public function Simple validate handler Overrides HandlerBase::validateOptionsForm 1
HandlerBase::$actualField public property When a field has been moved this property is set.
HandlerBase::$actualTable public property When a table has been moved this property is set.
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$query public property Where the $query object will reside: 1
HandlerBase::$realField public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::access public function Check whether current user has access to this handler. 7
HandlerBase::adminLabel public function Return a string representing this handler's name in the UI. 9
HandlerBase::breakPhrase public static function Breaks x,y,z and x+y+z into an array. Numeric only.
HandlerBase::breakPhraseString public static function Breaks x,y,z and x+y+z into an array. Works for strings.
HandlerBase::broken public function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. 6
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::ensureMyTable public function Ensure the main table for this handler is in the query. This is used a lot. 8
HandlerBase::getField public function Shortcut to get a handler's raw field value.
HandlerBase::getJoin public function Get the join object that should be used for this handler.
HandlerBase::getSQLDateField public function Creates cross-database SQL dates.
HandlerBase::getSQLFormat public function Creates cross-database SQL date formatting.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache.
HandlerBase::getTimezone public static function Figure out what timezone we're in; needed for some date manipulations.
HandlerBase::hasExtraOptions public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
HandlerBase::isExposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached.
HandlerBase::preQuery public function Run before the view is built. 1
HandlerBase::sanitizeValue protected function Sanitize the value for output.
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
HandlerBase::showExposeForm public function Shortcut to display the exposed options form.
HandlerBase::submitExposed public function Submit the exposed handler form
HandlerBase::submitExposeForm public function Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitExtraOptionsForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
HandlerBase::submitGroupByForm public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 1
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
HandlerBase::validateExtraOptionsForm public function Validate the options form.
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct
InOperator::$value_form_type property 1
InOperator::$value_options property Stores all operations which are available on the form.
InOperator::buildExposeForm public function Options form subform for exposed filter options. Overrides FilterPluginBase::buildExposeForm 1
InOperator::defaultExposeOptions public function Provide default options for exposed filters. Overrides FilterPluginBase::defaultExposeOptions
InOperator::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides FilterPluginBase::defineOptions 1
InOperator::init public function Overrides Drupal\views\Plugin\views\filter\FilterPluginBase::init(). Overrides FilterPluginBase::init 1
InOperator::operators function This kind of construct makes it relatively easy for a child class to add or remove functionality by overriding this function and adding/removing items from this array. 1
InOperator::operator_options function Build strings from the operators() for 'select' options Overrides FilterPluginBase::operator_options 1
InOperator::operator_values function
InOperator::op_empty function
InOperator::op_simple function
InOperator::query public function Add this filter to the query. Overrides FilterPluginBase::query 2
InOperator::reduce_value_options function When using exposed filters, we may be required to reduce the set.
InOperator::validate public function Validates the handler against the complete View. Overrides HandlerBase::validate
Name::$always_multiple property Disable the possibility to force a single value. Overrides FilterPluginBase::$always_multiple
Name::acceptExposedInput public function Check to see if input from the exposed filters should change the behavior of this filter. Overrides InOperator::acceptExposedInput
Name::adminSummary public function Display the filter on the administrative summary Overrides InOperator::adminSummary
Name::get_value_options function Child classes should be used to override this function and set the 'value options', unless 'options callback' is defined as a valid function or static public method to generate these values. Overrides InOperator::get_value_options
Name::validateExposed public function Validate the exposed handler form Overrides HandlerBase::validateExposed
Name::validate_user_strings function Validate the user string. Since this can come from either the form or the exposed filter, this is abstracted out a bit so it can handle the multiple input sources.
Name::value_form function Options form subform for setting options. Overrides InOperator::value_form
Name::value_submit function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides InOperator::value_submit
Name::value_validate function Validate the options form. Overrides FilterPluginBase::value_validate
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. 2
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::setOptionDefaults protected function
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions public function Returns the usesOptions property. 8