Null.php in Views (for Drupal 7) 8.3

Definition of Drupal\views\Plugin\views\argument\Null.

Namespace

Drupal\views\Plugin\views\argument

File

lib/Drupal/views/Plugin/views/argument/Null.php

<?php

/**
 * @file
 * Definition of Drupal\views\Plugin\views\argument\Null.
 */
namespace Drupal\views\Plugin\views\argument;

use Drupal\Core\Annotation\Plugin;

/**
 * Argument handler that ignores the argument.
 *
 * @ingroup views_argument_handlers
 *
 * @Plugin(
 *   id = "null"
 * )
 */
class Null extends ArgumentPluginBase {
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['must_not_be'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    return $options;
  }

  /**
   * Override buildOptionsForm() so that only the relevant options
   * are displayed to the user.
   */
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['must_not_be'] = array(
      '#type' => 'checkbox',
      '#title' => t('Fail basic validation if any argument is given'),
      '#default_value' => !empty($this->options['must_not_be']),
      '#description' => t('By checking this field, you can use this to make sure views with more arguments than necessary fail validation.'),
      '#fieldset' => 'more',
    );
    unset($form['exception']);
  }

  /**
   * Override default_actions() to remove actions that don't
   * make sense for a null argument.
   */
  function default_actions($which = NULL) {
    if ($which) {
      if (in_array($which, array(
        'ignore',
        'not found',
        'empty',
        'default',
      ))) {
        return parent::default_actions($which);
      }
      return;
    }
    $actions = parent::default_actions();
    unset($actions['summary asc']);
    unset($actions['summary desc']);
    return $actions;
  }

  /**
   * Override the behavior of query() to prevent the query
   * from being changed in any way.
   */
  public function query($group_by = FALSE) {
  }

}

Classes

Name	Description
Null	Argument handler that ignores the argument.