InOperator.php 14.1 KB
Newer Older
merlinofchaos's avatar
merlinofchaos committed
1 2 3 4
<?php

/**
 * @file
5
 * Definition of Drupal\views\Plugin\views\filter\InOperator.
merlinofchaos's avatar
merlinofchaos committed
6 7
 */

8
namespace Drupal\views\Plugin\views\filter;
9

10
use Drupal\Component\Utility\String as UtilityString;
11
use Drupal\Component\Utility\Unicode;
12
use Drupal\views\Plugin\views\display\DisplayPluginBase;
13
use Drupal\views\ViewExecutable;
dawehner's avatar
dawehner committed
14

merlinofchaos's avatar
merlinofchaos committed
15 16 17 18 19 20 21 22
/**
 * 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.
 *
 * @ingroup views_filter_handlers
23
 *
24
 * @ViewsFilter("in_operator")
dawehner's avatar
dawehner committed
25
 */
26
class InOperator extends FilterPluginBase {
27

28
  protected $valueFormType = 'checkboxes';
merlinofchaos's avatar
merlinofchaos committed
29 30 31 32 33 34 35

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

36
  /**
37
   * Overrides \Drupal\views\Plugin\views\filter\FilterPluginBase::init().
38
   */
39 40
  public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
    parent::init($view, $display, $options);
41

merlinofchaos's avatar
merlinofchaos committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
    $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.
   */
57
  public function getValueOptions() {
merlinofchaos's avatar
merlinofchaos committed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
    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;
  }

77 78
  public function defaultExposeOptions() {
    parent::defaultExposeOptions();
merlinofchaos's avatar
merlinofchaos committed
79 80 81
    $this->options['expose']['reduce'] = FALSE;
  }

82 83
  public function buildExposeForm(&$form, &$form_state) {
    parent::buildExposeForm($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
84 85 86 87 88 89 90 91
    $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']), // safety
    );
  }

92 93
  protected function defineOptions() {
    $options = parent::defineOptions();
merlinofchaos's avatar
merlinofchaos committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112

    $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('='),
113
        'method' => 'opSimple',
merlinofchaos's avatar
merlinofchaos committed
114 115 116 117 118 119
        'values' => 1,
      ),
      'not in' => array(
        'title' => t('Is not one of'),
        'short' => t('not in'),
        'short_single' => t('<>'),
120
        'method' => 'opSimple',
merlinofchaos's avatar
merlinofchaos committed
121 122 123 124 125 126 127 128
        '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)'),
129
          'method' => 'opEmpty',
merlinofchaos's avatar
merlinofchaos committed
130 131 132 133 134
          'short' => t('empty'),
          'values' => 0,
        ),
        'not empty' => array(
          'title' => t('Is not empty (NOT NULL)'),
135
          'method' => 'opEmpty',
merlinofchaos's avatar
merlinofchaos committed
136 137 138 139 140 141 142 143 144 145 146 147
          'short' => t('not empty'),
          'values' => 0,
        ),
      );
    }

    return $operators;
  }

  /**
   * Build strings from the operators() for 'select' options
   */
148
  public function operatorOptions($which = 'title') {
merlinofchaos's avatar
merlinofchaos committed
149 150 151 152 153 154 155 156
    $options = array();
    foreach ($this->operators() as $id => $info) {
      $options[$id] = $info[$which];
    }

    return $options;
  }

157
  protected function operatorValues($values = 1) {
merlinofchaos's avatar
merlinofchaos committed
158 159 160 161 162 163 164 165 166 167
    $options = array();
    foreach ($this->operators() as $id => $info) {
      if (isset($info['values']) && $info['values'] == $values) {
        $options[] = $id;
      }
    }

    return $options;
  }

168
  protected function valueForm(&$form, &$form_state) {
merlinofchaos's avatar
merlinofchaos committed
169 170 171 172 173 174 175 176
    $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'));
    }

177
    $this->getValueOptions();
merlinofchaos's avatar
merlinofchaos committed
178 179 180 181 182
    $options += $this->value_options;
    $default_value = (array) $this->value;

    $which = 'all';
    if (!empty($form['operator'])) {
183
      $source = ':input[name="options[operator]"]';
merlinofchaos's avatar
merlinofchaos committed
184 185 186 187 188 189
    }
    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.
190
        $which = in_array($this->operator, $this->operatorValues(1)) ? 'value' : 'none';
merlinofchaos's avatar
merlinofchaos committed
191 192
      }
      else {
193
        $source = ':input[name="' . $this->options['expose']['operator_id'] . '"]';
merlinofchaos's avatar
merlinofchaos committed
194 195 196
      }

      if (!empty($this->options['expose']['reduce'])) {
197
        $options = $this->reduceValueOptions();
merlinofchaos's avatar
merlinofchaos committed
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220

        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(
221
        '#type' => $this->valueFormType,
merlinofchaos's avatar
merlinofchaos committed
222 223 224 225 226 227 228 229 230 231 232 233
        '#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') {
234
        if (empty($form_state['exposed']) && (in_array($this->valueFormType, array('checkbox', 'checkboxes', 'radios', 'select')))) {
merlinofchaos's avatar
merlinofchaos committed
235 236 237
          $form['value']['#prefix'] = '<div id="edit-options-value-wrapper">';
          $form['value']['#suffix'] = '</div>';
        }
238
        // Setup #states for all operators with one value.
239
        foreach ($this->operatorValues(1) as $operator) {
240 241 242 243
          $form['value']['#states']['visible'][] = array(
            $source => array('value' => $operator),
          );
        }
merlinofchaos's avatar
merlinofchaos committed
244 245 246 247 248 249 250
      }
    }
  }

  /**
   * When using exposed filters, we may be required to reduce the set.
   */
251
  public function reduceValueOptions($input = NULL) {
merlinofchaos's avatar
merlinofchaos committed
252 253 254 255 256 257 258 259 260 261
    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)) {
262
        $options[$id] = $this->reduceValueOptions($option);
merlinofchaos's avatar
merlinofchaos committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
        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;
  }

279
  public function acceptExposedInput($input) {
merlinofchaos's avatar
merlinofchaos committed
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
    // 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;
      }
    }

295
    return parent::acceptExposedInput($input);
merlinofchaos's avatar
merlinofchaos committed
296 297
  }

298
  protected function valueSubmit($form, &$form_state) {
merlinofchaos's avatar
merlinofchaos committed
299 300 301 302 303 304 305 306 307 308 309 310
    // 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'];
  }

311 312
  public function adminSummary() {
    if ($this->isAGroup()) {
313 314
      return t('grouped');
    }
merlinofchaos's avatar
merlinofchaos committed
315 316 317 318 319
    if (!empty($this->options['exposed'])) {
      return t('exposed');
    }
    $info = $this->operators();

320
    $this->getValueOptions();
merlinofchaos's avatar
merlinofchaos committed
321 322 323 324 325

    if (!is_array($this->value)) {
      return;
    }

326
    $operator = UtilityString::checkPlain($info[$this->operator]['short']);
merlinofchaos's avatar
merlinofchaos committed
327
    $values = '';
328
    if (in_array($this->operator, $this->operatorValues(1))) {
merlinofchaos's avatar
merlinofchaos committed
329 330 331 332 333 334 335 336 337 338 339 340 341
      // 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'])) {
342
          $operator = UtilityString::checkPlain($info[$this->operator]['short_single']);
merlinofchaos's avatar
merlinofchaos committed
343 344 345 346 347
        }

        $keys = $this->value;
        $value = array_shift($keys);
        if (isset($this->value_options[$value])) {
348
          $values = UtilityString::checkPlain($this->value_options[$value]);
merlinofchaos's avatar
merlinofchaos committed
349 350 351 352 353 354 355 356 357 358 359
        }
        else {
          $values = '';
        }
      }
      else {
        foreach ($this->value as $value) {
          if ($values !== '') {
            $values .= ', ';
          }
          if (drupal_strlen($values) > 8) {
360
            $values = Unicode::truncate($values, 8, FALSE, TRUE);
merlinofchaos's avatar
merlinofchaos committed
361 362 363
            break;
          }
          if (isset($this->value_options[$value])) {
364
            $values .= UtilityString::checkPlain($this->value_options[$value]);
merlinofchaos's avatar
merlinofchaos committed
365 366 367 368 369 370 371 372
          }
        }
      }
    }

    return $operator . (($values !== '') ? ' ' . $values : '');
  }

373
  public function query() {
merlinofchaos's avatar
merlinofchaos committed
374 375 376 377 378 379
    $info = $this->operators();
    if (!empty($info[$this->operator]['method'])) {
      $this->{$info[$this->operator]['method']}();
    }
  }

380
  protected function opSimple() {
merlinofchaos's avatar
merlinofchaos committed
381 382 383
    if (empty($this->value)) {
      return;
    }
384
    $this->ensureMyTable();
merlinofchaos's avatar
merlinofchaos committed
385 386 387

    // We use array_values() because the checkboxes keep keys and that can cause
    // array addition problems.
388
    $this->query->addWhere($this->options['group'], "$this->tableAlias.$this->realField", array_values($this->value), $this->operator);
merlinofchaos's avatar
merlinofchaos committed
389 390
  }

391
  protected function opEmpty() {
392
    $this->ensureMyTable();
merlinofchaos's avatar
merlinofchaos committed
393 394 395 396 397 398 399
    if ($this->operator == 'empty') {
      $operator = "IS NULL";
    }
    else {
      $operator = "IS NOT NULL";
    }

400
    $this->query->addWhere($this->options['group'], "$this->tableAlias.$this->realField", NULL, $operator);
merlinofchaos's avatar
merlinofchaos committed
401 402
  }

403
  public function validate() {
404
    $this->getValueOptions();
merlinofchaos's avatar
merlinofchaos committed
405 406 407 408
    $errors = array();

    // If the operator is an operator which doesn't require a value, there is
    // no need for additional validation.
409
    if (in_array($this->operator, $this->operatorValues(0))) {
merlinofchaos's avatar
merlinofchaos committed
410 411 412
      return array();
    }

413
    if (!in_array($this->operator, $this->operatorValues(1))) {
414
      $errors[] = t('The operator is invalid on filter: @filter.', array('@filter' => $this->adminLabel(TRUE)));
merlinofchaos's avatar
merlinofchaos committed
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
    }
    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) {
437
        $errors[] = t('No valid values found on filter: @filter.', array('@filter' => $this->adminLabel(TRUE)));
merlinofchaos's avatar
merlinofchaos committed
438 439 440
      }
    }
    elseif (!empty($this->value) && ($this->operator == 'in' || $this->operator == 'not in')) {
441
      $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)));
merlinofchaos's avatar
merlinofchaos committed
442 443 444
    }
    return $errors;
  }
445

merlinofchaos's avatar
merlinofchaos committed
446
}