class InOperator

Simple filter to handle matching of multiple options selectable via checkboxes

Definition items:

  • options callback: The function to call in order to generate the value options. If omitted, the options 'Yes' and 'No' will be used.
  • options arguments: An array of arguments to pass to the options callback.

Plugin annotation


@Plugin(
  id = "in_operator"
)

Hierarchy

Expanded class hierarchy of InOperator

Related topics

Views filter handlers
Handlers to tell Views how to filter queries.
8 files declare their use of InOperator
HandlerAllTest.php in drupal/core/modules/views/lib/Drupal/views/Tests/Handler/HandlerAllTest.php
Definition of Drupal\views\Tests\Handler\HandlerAllTest.
LanguageFilter.php in drupal/core/modules/language/lib/Drupal/language/Plugin/views/filter/LanguageFilter.php
Contains Drupal\language\Plugin\views\filter\LanguageFilter.
Name.php in drupal/core/modules/user/lib/Drupal/user/Plugin/views/filter/Name.php
Definition of Drupal\user\Plugin\views\filter\Name.
NodeComment.php in drupal/core/modules/comment/lib/Drupal/comment/Plugin/views/filter/NodeComment.php
Definition of Drupal\comment\Plugin\views\filter\NodeComment.
Status.php in drupal/core/modules/file/lib/Drupal/file/Plugin/views/filter/Status.php
Definition of Drupal\file\Plugin\views\filter\Status.

... See full list

File

drupal/core/modules/views/lib/Drupal/views/Plugin/views/filter/InOperator.php, line 26
Definition of Drupal\views\Plugin\views\filter\InOperator.

Namespace

Drupal\views\Plugin\views\filter
View source
class InOperator extends FilterPluginBase {
  var $value_form_type = 'checkboxes';

  /**
   * @var array
   * Stores all operations which are available on the form.
   */
  var $value_options = NULL;

  /**
   * Overrides Drupal\views\Plugin\views\filter\FilterPluginBase::init().
   */
  public function init(ViewExecutable $view, &$options) {
    parent::init($view, $options);
    $this->value_title = t('Options');
    $this->value_options = NULL;
  }

  /**
   * 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.
   *
   * This can use a guard to be used to reduce database hits as much as
   * possible.
   *
   * @return
   *   Return the stored values in $this->value_options if someone expects it.
   */
  function get_value_options() {
    if (isset($this->value_options)) {
      return;
    }
    if (isset($this->definition['options callback']) && is_callable($this->definition['options callback'])) {
      if (isset($this->definition['options arguments']) && is_array($this->definition['options arguments'])) {
        $this->value_options = call_user_func_array($this->definition['options callback'], $this->definition['options arguments']);
      }
      else {
        $this->value_options = call_user_func($this->definition['options callback']);
      }
    }
    else {
      $this->value_options = array(
        t('Yes'),
        t('No'),
      );
    }
    return $this->value_options;
  }
  public function defaultExposeOptions() {
    parent::defaultExposeOptions();
    $this->options['expose']['reduce'] = FALSE;
  }
  public function buildExposeForm(&$form, &$form_state) {
    parent::buildExposeForm($form, $form_state);
    $form['expose']['reduce'] = array(
      '#type' => 'checkbox',
      '#title' => t('Limit list to selected items'),
      '#description' => t('If checked, the only items presented to the user will be the ones selected here.'),
      '#default_value' => !empty($this->options['expose']['reduce']),
    );
  }
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['operator']['default'] = 'in';
    $options['value']['default'] = array();
    $options['expose']['contains']['reduce'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    return $options;
  }

  /**
   * 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.
   */
  function operators() {
    $operators = array(
      'in' => array(
        'title' => t('Is one of'),
        'short' => t('in'),
        'short_single' => t('='),
        'method' => 'op_simple',
        'values' => 1,
      ),
      'not in' => array(
        'title' => t('Is not one of'),
        'short' => t('not in'),
        'short_single' => t('<>'),
        'method' => 'op_simple',
        'values' => 1,
      ),
    );

    // if the definition allows for the empty operator, add it.
    if (!empty($this->definition['allow empty'])) {
      $operators += array(
        'empty' => array(
          'title' => t('Is empty (NULL)'),
          'method' => 'op_empty',
          'short' => t('empty'),
          'values' => 0,
        ),
        'not empty' => array(
          'title' => t('Is not empty (NOT NULL)'),
          'method' => 'op_empty',
          'short' => t('not empty'),
          'values' => 0,
        ),
      );
    }
    return $operators;
  }

  /**
   * Build strings from the operators() for 'select' options
   */
  function operator_options($which = 'title') {
    $options = array();
    foreach ($this
      ->operators() as $id => $info) {
      $options[$id] = $info[$which];
    }
    return $options;
  }
  function operator_values($values = 1) {
    $options = array();
    foreach ($this
      ->operators() as $id => $info) {
      if (isset($info['values']) && $info['values'] == $values) {
        $options[] = $id;
      }
    }
    return $options;
  }
  function value_form(&$form, &$form_state) {
    $form['value'] = array();
    $options = array();
    if (empty($form_state['exposed'])) {

      // Add a select all option to the value form.
      $options = array(
        'all' => t('Select all'),
      );
    }
    $this
      ->get_value_options();
    $options += $this->value_options;
    $default_value = (array) $this->value;
    $which = 'all';
    if (!empty($form['operator'])) {
      $source = ':input[name="options[operator]"]';
    }
    if (!empty($form_state['exposed'])) {
      $identifier = $this->options['expose']['identifier'];
      if (empty($this->options['expose']['use_operator']) || empty($this->options['expose']['operator_id'])) {

        // exposed and locked.
        $which = in_array($this->operator, $this
          ->operator_values(1)) ? 'value' : 'none';
      }
      else {
        $source = ':input[name="' . $this->options['expose']['operator_id'] . '"]';
      }
      if (!empty($this->options['expose']['reduce'])) {
        $options = $this
          ->reduce_value_options();
        if (!empty($this->options['expose']['multiple']) && empty($this->options['expose']['required'])) {
          $default_value = array();
        }
      }
      if (empty($this->options['expose']['multiple'])) {
        if (empty($this->options['expose']['required']) && (empty($default_value) || !empty($this->options['expose']['reduce']))) {
          $default_value = 'All';
        }
        elseif (empty($default_value)) {
          $keys = array_keys($options);
          $default_value = array_shift($keys);
        }
        else {
          $copy = $default_value;
          $default_value = array_shift($copy);
        }
      }
    }
    if ($which == 'all' || $which == 'value') {
      $form['value'] = array(
        '#type' => $this->value_form_type,
        '#title' => $this->value_title,
        '#options' => $options,
        '#default_value' => $default_value,
        // These are only valid for 'select' type, but do no harm to checkboxes.
        '#multiple' => TRUE,
        '#size' => count($options) > 8 ? 8 : count($options),
      );
      if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier])) {
        $form_state['input'][$identifier] = $default_value;
      }
      if ($which == 'all') {
        if (empty($form_state['exposed']) && in_array($this->value_form_type, array(
          'checkbox',
          'checkboxes',
          'radios',
          'select',
        ))) {
          $form['value']['#prefix'] = '<div id="edit-options-value-wrapper">';
          $form['value']['#suffix'] = '</div>';
        }

        // Setup #states for all operators with one value.
        foreach ($this
          ->operator_values(1) as $operator) {
          $form['value']['#states']['visible'][] = array(
            $source => array(
              'value' => $operator,
            ),
          );
        }
      }
    }
  }

  /**
   * When using exposed filters, we may be required to reduce the set.
   */
  function reduce_value_options($input = NULL) {
    if (!isset($input)) {
      $input = $this->value_options;
    }

    // Because options may be an array of strings, or an array of mixed arrays
    // and strings (optgroups) or an array of objects, we have to
    // step through and handle each one individually.
    $options = array();
    foreach ($input as $id => $option) {
      if (is_array($option)) {
        $options[$id] = $this
          ->reduce_value_options($option);
        continue;
      }
      elseif (is_object($option)) {
        $keys = array_keys($option->option);
        $key = array_shift($keys);
        if (isset($this->options['value'][$key])) {
          $options[$id] = $option;
        }
      }
      elseif (isset($this->options['value'][$id])) {
        $options[$id] = $option;
      }
    }
    return $options;
  }
  public function acceptExposedInput($input) {

    // A very special override because the All state for this type of
    // filter could have a default:
    if (empty($this->options['exposed'])) {
      return TRUE;
    }

    // If this is non-multiple and non-required, then this filter will
    // participate, but using the default settings, *if* 'limit is true.
    if (empty($this->options['expose']['multiple']) && empty($this->options['expose']['required']) && !empty($this->options['expose']['limit'])) {
      $identifier = $this->options['expose']['identifier'];
      if ($input[$identifier] == 'All') {
        return TRUE;
      }
    }
    return parent::acceptExposedInput($input);
  }
  function value_submit($form, &$form_state) {

    // Drupal's FAPI system automatically puts '0' in for any checkbox that
    // was not set, and the key to the checkbox if it is set.
    // Unfortunately, this means that if the key to that checkbox is 0,
    // we are unable to tell if that checkbox was set or not.
    // Luckily, the '#value' on the checkboxes form actually contains
    // *only* a list of checkboxes that were set, and we can use that
    // instead.
    $form_state['values']['options']['value'] = $form['value']['#value'];
  }
  public function adminSummary() {
    if ($this
      ->isAGroup()) {
      return t('grouped');
    }
    if (!empty($this->options['exposed'])) {
      return t('exposed');
    }
    $info = $this
      ->operators();
    $this
      ->get_value_options();
    if (!is_array($this->value)) {
      return;
    }
    $operator = check_plain($info[$this->operator]['short']);
    $values = '';
    if (in_array($this->operator, $this
      ->operator_values(1))) {

      // Remove every element which is not known.
      foreach ($this->value as $value) {
        if (!isset($this->value_options[$value])) {
          unset($this->value[$value]);
        }
      }

      // Choose different kind of ouput for 0, a single and multiple values.
      if (count($this->value) == 0) {
        $values = t('Unknown');
      }
      else {
        if (count($this->value) == 1) {

          // If any, use the 'single' short name of the operator instead.
          if (isset($info[$this->operator]['short_single'])) {
            $operator = check_plain($info[$this->operator]['short_single']);
          }
          $keys = $this->value;
          $value = array_shift($keys);
          if (isset($this->value_options[$value])) {
            $values = check_plain($this->value_options[$value]);
          }
          else {
            $values = '';
          }
        }
        else {
          foreach ($this->value as $value) {
            if ($values !== '') {
              $values .= ', ';
            }
            if (drupal_strlen($values) > 8) {
              $values .= '...';
              break;
            }
            if (isset($this->value_options[$value])) {
              $values .= check_plain($this->value_options[$value]);
            }
          }
        }
      }
    }
    return $operator . ($values !== '' ? ' ' . $values : '');
  }
  public function query() {
    $info = $this
      ->operators();
    if (!empty($info[$this->operator]['method'])) {
      $this
        ->{$info[$this->operator]['method']}();
    }
  }
  function op_simple() {
    if (empty($this->value)) {
      return;
    }
    $this
      ->ensureMyTable();

    // We use array_values() because the checkboxes keep keys and that can cause
    // array addition problems.
    $this->query
      ->add_where($this->options['group'], "{$this->tableAlias}.{$this->realField}", array_values($this->value), $this->operator);
  }
  function op_empty() {
    $this
      ->ensureMyTable();
    if ($this->operator == 'empty') {
      $operator = "IS NULL";
    }
    else {
      $operator = "IS NOT NULL";
    }
    $this->query
      ->add_where($this->options['group'], "{$this->tableAlias}.{$this->realField}", NULL, $operator);
  }
  public function validate() {
    $this
      ->get_value_options();
    $errors = array();

    // If the operator is an operator which doesn't require a value, there is
    // no need for additional validation.
    if (in_array($this->operator, $this
      ->operator_values(0))) {
      return array();
    }
    if (!in_array($this->operator, $this
      ->operator_values(1))) {
      $errors[] = t('The operator is invalid on filter: @filter.', array(
        '@filter' => $this
          ->adminLabel(TRUE),
      ));
    }
    if (is_array($this->value)) {
      if (!isset($this->value_options)) {

        // Don't validate if there are none value options provided, for example for special handlers.
        return $errors;
      }
      if ($this->options['exposed'] && !$this->options['expose']['required'] && empty($this->value)) {

        // Don't validate if the field is exposed and no default value is provided.
        return $errors;
      }

      // Some filter_in_operator usage uses optgroups forms, so flatten it.
      $flat_options = form_options_flatten($this->value_options, TRUE);

      // Remove every element which is not known.
      foreach ($this->value as $value) {
        if (!isset($flat_options[$value])) {
          unset($this->value[$value]);
        }
      }

      // Choose different kind of ouput for 0, a single and multiple values.
      if (count($this->value) == 0) {
        $errors[] = t('No valid values found on filter: @filter.', array(
          '@filter' => $this
            ->adminLabel(TRUE),
        ));
      }
    }
    elseif (!empty($this->value) && ($this->operator == 'in' || $this->operator == 'not in')) {
      $errors[] = t('The value @value is not an array for @operator on filter: @filter', array(
        '@value' => var_export($this->value),
        '@operator' => $this->operator,
        '@filter' => $this
          ->adminLabel(TRUE),
      ));
    }
    return $errors;
  }

}

Members

Name Modifiers Type Descriptionsort descending Overrides
InOperator::operator_values function
InOperator::op_simple function
InOperator::op_empty function
FilterPluginBase::convert_exposed_input function
PluginBase::setOptionDefaults protected function
InOperator::$value_form_type property 1
InOperator::query public function Add this filter to the query. Overrides FilterPluginBase::query 2
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form.
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.
FilterPluginBase::group_form function Build a form containing a group of operator | values to apply as a single filter.
InOperator::operator_options function Build strings from the operators() for 'select' options Overrides FilterPluginBase::operator_options 1
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'
HandlerBase::setRelationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
FilterPluginBase::can_group function Can this filter be used in OR groups? 1
InOperator::acceptExposedInput public function Check to see if input from the exposed filters should change the behavior of this filter. Overrides FilterPluginBase::acceptExposedInput 2
HandlerBase::access public function Check whether current user has access to this handler. 6
InOperator::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. 11
PluginBase::destroy public function Clears a plugin. 2
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
HandlerBase::__construct public function Constructs a Handler object. Overrides PluginBase::__construct
FilterPluginBase::$value property Contains the actual value of the field,either configured in the views ui or entered in the exposed filters.
FilterPluginBase::$group_info property Contains the information of the selected item in a gruped filter.
FilterPluginBase::$operator property Contains the operator which is used on the query.
HandlerBase::getSQLFormat public function Creates cross-database SQL date formatting.
HandlerBase::getSQLDateField public function Creates cross-database SQL dates.
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
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::canExpose public function Determine if a filter can be exposed. Overrides HandlerBase::canExpose 2
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::isExposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
HandlerBase::getEntityType public function Determines the entity type used by this handler.
FilterPluginBase::$always_required property Disable the possibility to allow a exposed input to be optional.
FilterPluginBase::$always_multiple property Disable the possibility to force a single value. 6
FilterPluginBase::$no_operator property Disable the possibility to use operators. 2
InOperator::adminSummary public function Display the filter on the administrative summary Overrides FilterPluginBase::adminSummary 2
HandlerBase::ensureMyTable public function Ensure the main table for this handler is in the query. This is used a lot. 8
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::getJoin public function Get the join object that should be used for this handler.
HandlerBase::hasExtraOptions public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
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::storeExposedInput public function If set to remember exposed input in the session, store it there. Overrides HandlerBase::storeExposedInput
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId public function Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
InOperator::defineOptions protected function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides FilterPluginBase::defineOptions 1
FilterPluginBase::exposed_translate function Make some translations to a form item to make it more suitable to exposing.
PluginBase::$options public property Options for this plugin will be held here.
InOperator::buildExposeForm public function Options form subform for exposed filter options. Overrides FilterPluginBase::buildExposeForm 1
InOperator::value_form function Options form subform for setting options. Overrides FilterPluginBase::value_form 2
FilterPluginBase::operator_form function Options form subform for setting the operator. 4
InOperator::init public function Overrides Drupal\views\Plugin\views\filter\FilterPluginBase::init(). Overrides FilterPluginBase::init 1
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.
InOperator::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 FilterPluginBase::value_submit 2
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.
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::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.
PluginBase::$definition public property Plugins's definition
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. 1
PluginBase::additionalThemeFunctions public function Provide a list of additional theme functions for the theme information page
InOperator::defaultExposeOptions public function Provide default options for exposed filters. Overrides FilterPluginBase::defaultExposeOptions
FilterPluginBase::build_group_options function Provide default options for exposed filters.
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
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
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::usesGroupBy public function Provides the handler some groupby. 2
FilterPluginBase::buildExposedForm public function Render our chunk of the exposed filter form when selecting Overrides HandlerBase::buildExposedForm
HandlerBase::adminLabel public function Return a string representing this handler's name in the UI. 9
PluginBase::pluginTitle public function Return the human readable name of the display.
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced.
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements.
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.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. 6
PluginBase::usesOptions public function Returns the usesOptions property. 8
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
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.
FilterPluginBase::prepare_filter_select_options function Sanitizes the HTML select element's options.
FilterPluginBase::build_group_submit function Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::show_build_group_button function Shortcut to display the build_group/hide button.
FilterPluginBase::showExposeButton public function Shortcut to display the expose/hide button. Overrides HandlerBase::showExposeButton
FilterPluginBase::show_build_group_form function Shortcut to display the exposed options form.
HandlerBase::showExposeForm public 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.
HandlerBase::getField public function Shortcut to get a handler's raw field value.
FilterPluginBase::submitOptionsForm public function Simple submit handler Overrides HandlerBase::submitOptionsForm
FilterPluginBase::validateOptionsForm public function Simple validate handler Overrides HandlerBase::validateOptionsForm 1
InOperator::$value_options property Stores all operations which are available on the form.
HandlerBase::submitExposed public function Submit the exposed handler form
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
HandlerBase::$realField public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
PluginBase::$discovery protected property The discovery object.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$plugin_id protected property The plugin_id.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
PluginBase::$view public property The top object of a view. 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
HandlerBase::caseTransform protected function Transform a string by a certain method.
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
FilterPluginBase::build_group_validate function Validate the build group options form. 1
HandlerBase::validateExposed public function Validate the exposed handler form 4
FilterPluginBase::operator_validate function Validate the operator form.
FilterPluginBase::value_validate function Validate the options form. 3
FilterPluginBase::validateExposeForm public function Validate the options form. Overrides HandlerBase::validateExposeForm
HandlerBase::validateExtraOptionsForm public function Validate the options form.
InOperator::validate public function Validates the handler against the complete View. Overrides HandlerBase::validate
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.
InOperator::reduce_value_options function When using exposed filters, we may be required to reduce the set.
HandlerBase::$query public property Where the $query object will reside: 1
HandlerBase::$field public property With field you can override the realField if the real field is not set.