class QueryTest in Drupal 10

Defines a query test plugin.

Plugin annotation

@ViewsQuery(
  id = "query_test",
  title = @Translation("Query test"),
  help = @Translation("Defines a query test plugin.")
)

Hierarchy

• class \Drupal\views_test_data\Plugin\views\query\QueryTest extends \Drupal\views\Plugin\views\query\QueryPluginBase

1 file declares its use of QueryTest

QueryTest.php in core/modules/views/tests/src/Kernel/Plugin/QueryTest.php

1 string reference to 'QueryTest'

QueryTest::calculateDependencies in core/modules/views/tests/modules/views_test_data/src/Plugin/views/query/QueryTest.php

File

core/modules/views/tests/modules/views_test_data/src/Plugin/views/query/QueryTest.php, line 20

Namespace

Drupal\views_test_data\Plugin\views\query

class QueryTest extends QueryPluginBase {
  protected $conditions = [];
  protected $fields = [];
  protected $allItems = [];
  protected $orderBy = [];

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['test_setting'] = [
      'default' => '',
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['test_setting'] = [
      '#title' => $this
        ->t('Test setting'),
      '#type' => 'textfield',
      '#default_value' => $this->options['test_setting'],
    ];
  }

  /**
   * Sets the allItems property.
   *
   * @param array $allItems
   *   An array of stdClasses.
   */
  public function setAllItems($allItems) {
    $this->allItems = $allItems;
  }
  public function addWhere($group, $field, $value = NULL, $operator = NULL) {
    $this->conditions[] = [
      'field' => $field,
      'value' => $value,
      'operator' => $operator,
    ];
  }
  public function addField($table, $field, $alias = '', $params = []) {
    $this->fields[$field] = $field;
    return $field;
  }
  public function addOrderBy($table, $field = NULL, $order = 'ASC', $alias = '', $params = []) {
    $this->orderBy = [
      'field' => $field,
      'order' => $order,
    ];
  }
  public function ensureTable($table, $relationship = NULL, JoinPluginBase $join = NULL) {

    // There is no concept of joins.
  }

  /**
   * Implements Drupal\views\Plugin\views\query\QueryPluginBase::build().
   *
   * @param \Drupal\views\ViewExecutable $view
   *   The view executable.
   */
  public function build(ViewExecutable $view) {
    $this->view = $view;

    // @todo Support pagers for know, a php based one would probably match.
    // @todo You could add a string representation of the query.
    $this->view->build_info['query'] = "";
    $this->view->build_info['count_query'] = "";
  }

  /**
   * {@inheritdoc}
   */
  public function execute(ViewExecutable $view) {
    $result = [];
    foreach ($this->allItems as $element) {

      // Run all conditions on the element, and add it to the result if they
      // match.
      $match = TRUE;
      foreach ($this->conditions as $condition) {
        $match &= $this
          ->match($element, $condition);
      }
      if ($match) {

        // If the query explicit defines fields to use, filter all others out.
        // Filter out fields
        if ($this->fields) {
          $element = array_intersect_key($element, $this->fields);
        }
        $result[] = new ResultRow($element);
      }
    }
    $this->view->result = $result;
  }

  /**
   * Check a single condition for a single element.
   *
   * @param array $element
   *   The element which should be checked.
   * @param array $condition
   *   An associative array containing:
   *   - field: The field to by, for example id.
   *   - value: The expected value of the element.
   *   - operator: The operator to compare the element value with the expected
   *     value.
   *
   * @return bool
   *   Returns whether the condition matches with the element.
   */
  public function match($element, $condition) {
    $value = $element[$condition['field']];
    switch ($condition['operator']) {
      case '=':
        return $value == $condition['value'];
      case 'IN':
        return in_array($value, $condition['value']);
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return parent::calculateDependencies() + [
      'content' => [
        'QueryTest',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function setFieldTimezoneOffset(&$field, $offset) {
  }

}

Members

Name	Modifiers	Type	Description	Overrides
QueryTest::$allItems	protected	property
QueryTest::$conditions	protected	property
QueryTest::$fields	protected	property
QueryTest::$orderBy	protected	property
QueryTest::addField	public	function
QueryTest::addOrderBy	public	function
QueryTest::addWhere	public	function
QueryTest::build	public	function	Implements Drupal\views\Plugin\views\query\QueryPluginBase::build().
QueryTest::buildOptionsForm	public	function
QueryTest::calculateDependencies	public	function
QueryTest::defineOptions	protected	function
QueryTest::ensureTable	public	function
QueryTest::execute	public	function
QueryTest::match	public	function	Check a single condition for a single element.
QueryTest::setAllItems	public	function	Sets the allItems property.
QueryTest::setFieldTimezoneOffset	public	function