FilterTest.php in Views (for Drupal 7) 8.3

Definition of Drupal\views_test_data\Plugin\views\filter\FilterTest.

Namespace

Drupal\views_test_data\Plugin\views\filter

File

tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/filter/FilterTest.php

<?php

/**
 * @file
 * Definition of Drupal\views_test_data\Plugin\views\filter\FilterTest.
 */
namespace Drupal\views_test_data\Plugin\views\filter;

use Drupal\Core\Annotation\Plugin;
use Drupal\Core\Annotation\Translation;
use Drupal\views\Plugin\views\filter\FilterPluginBase;

/**
 * @Plugin(
 *   id = "test_filter",
 *   title = @Translation("Test filter plugin"),
 *   help = @Translation("Provides a generic filter test plugin."),
 *   base = "node",
 *   type = "type"
 * )
 */
class FilterTest extends FilterPluginBase {

  /**
   * Overrides Drupal\views\Plugin\views\row\RowPluginBase::defineOptions().
   *
   * @return array
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['test_enable'] = array(
      'default' => TRUE,
      'bool' => TRUE,
    );
    return $options;
  }

  /**
   * Overrides Drupal\views\Plugin\views\row\RowPluginBase::buildOptionsForm().
   *
   * @return array
   */
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['test_enable'] = array(
      '#type' => 'checkbox',
      '#title' => t('Controls whether the filter plugin should be active.'),
      '#default_value' => $this->options['test_enable'],
    );
  }

  /**
   * Overrides Drupal\views\Plugin\views\filter\FilterPluginBase::query().
   */
  public function query() {

    // Call the parent if this option is enabled.
    if ($this->options['test_enable']) {
      parent::query();
    }
  }

}

Classes

Name	Description
FilterTest	Plugin annotation @Plugin( id = "test_filter", title = @Translation("Test filter plugin"), help = @Translation("Provides a generic filter test plugin."), base = "node", type = "type" )