class QueryTest

Same name in this branch

Defines a query test plugin.

Plugin annotation


@Plugin(
  id = "query_test",
  title = @Translation("Query test")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements PluginInspectionInterface
- class \Drupal\Core\Plugin\ContainerFactoryPluginBase implements ContainerFactoryPluginInterface
  - class \Drupal\views\Plugin\views\PluginBase
    class \Drupal\views\Plugin\views\query\QueryPluginBase implements QueryInterface
    class \Drupal\views_test_data\Plugin\views\query\QueryTest

Expanded class hierarchy of QueryTest

2 files declare their use of QueryTest

File

drupal/core/modules/views/tests/views_test_data/lib/Drupal/views_test_data/Plugin/views/query/QueryTest.php, line 24: Definition of Drupal\views_test_data\Plugin\views\query\QueryTest.

Namespace

Drupal\views_test_data\Plugin\views\query

View source

class QueryTest extends QueryPluginBase {
  protected $conditions = array();
  protected $fields = array();
  protected $allItems = array();
  protected $orderBy = array();

  /**
   * Implements \Drupal\views\Plugin\views\query\QueryPluginBase::defineOptions().
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['test_setting'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Implements \Drupal\views\Plugin\views\query\QueryPluginBase::buildOptionsForm().
   */
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['test_setting'] = array(
      '#title' => 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[] = array(
      'field' => $field,
      'value' => $value,
      'operator' => $operator,
    );
  }
  public function addField($table, $field, $alias = '', $params = array()) {
    $this->fields[$field] = $field;
    return $field;
  }
  public function addOrderBy($table, $field = NULL, $order = 'ASC', $alias = '', $params = array()) {
    $this->orderBy = array(
      'field' => $field,
      'order' => $order,
    );
  }
  public function ensure_table($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
   */
  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 representatin of the query.
    $this->view->build_info['query'] = "";
    $this->view->build_info['count_query'] = "";
  }

  /**
   * Implements Drupal\views\Plugin\views\query\QueryPluginBase::execute().
   */
  public function execute(ViewExecutable $view) {
    $result = array();
    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[] = (object) $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;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerFactoryPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	11
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$definition	public	property	Plugins's definition
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form.	8
PluginBase::$view	public	property	The top object of a view.	1
PluginBase::destroy	public	function	Clears a plugin.	2
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements.
PluginBase::getPluginDefinition	public	function	Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced.
PluginBase::init	public	function	Initialize the plugin.	8
PluginBase::pluginTitle	public	function	Return the human readable name of the display.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style.	1
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions	public	function	Returns the usesOptions property.	8
PluginBase::validate	public	function	Validate that the plugin is correct and can be saved.	4
PluginBase::__construct	public	function	Constructs a Plugin object. Overrides PluginBase::__construct
QueryPluginBase::$limit	protected	property	Stores the limit of items that should be requested in the query.
QueryPluginBase::$pager		property	A pager plugin that should be provided by the display.
QueryPluginBase::addSignature	public	function	Add a signature to the query, if such a thing is feasible.	1
QueryPluginBase::alter		function	Let modules modify the query just prior to finalizing it.	1
QueryPluginBase::getAggregationInfo	public	function	Get aggregation info for group by queries.	1
QueryPluginBase::getDateField	public	function	Returns a Unix timestamp to database native timestamp expression.	1
QueryPluginBase::getDateFormat	public	function	Creates cross-database date formatting.	1
QueryPluginBase::getLimit	public	function	Returns the limit of the query.
QueryPluginBase::loadEntities		function	Loads all entities contained in the passed-in $results. . If the entity belongs to the base table, then it gets stored in $result->_entity. Otherwise, it gets stored in $result->_relationship_entities[$relationship_id];	1
QueryPluginBase::query	public	function	Generate a query and a countquery from all of the information supplied to the object. Overrides PluginBase::query	1
QueryPluginBase::setGroupOperator	public	function	Control how all WHERE and HAVING groups are put together.
QueryPluginBase::setLimit	public	function	Set a LIMIT on the query, specifying a maximum number of results.
QueryPluginBase::setOffset	public	function	Set an OFFSET on the query, specifying a number of results to skip
QueryPluginBase::setupTimezone	public	function	Set the database to the current user timezone,	1
QueryPluginBase::setWhereGroup	public	function	Create a new grouping for the WHERE or HAVING clause.
QueryPluginBase::submitOptionsForm	public	function	Handle any special handling on the validate form. Overrides PluginBase::submitOptionsForm	1
QueryPluginBase::summaryTitle	public	function	Returns the summary of the settings in the display. Overrides PluginBase::summaryTitle
QueryPluginBase::validateOptionsForm	public	function	Validate the options form. Overrides PluginBase::validateOptionsForm
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(). Overrides QueryPluginBase::build
QueryTest::buildOptionsForm	public	function	Implements \Drupal\views\Plugin\views\query\QueryPluginBase::buildOptionsForm(). Overrides PluginBase::buildOptionsForm
QueryTest::defineOptions	protected	function	Implements \Drupal\views\Plugin\views\query\QueryPluginBase::defineOptions(). Overrides PluginBase::defineOptions
QueryTest::ensure_table	public	function
QueryTest::execute	public	function	Implements Drupal\views\Plugin\views\query\QueryPluginBase::execute(). Overrides QueryPluginBase::execute
QueryTest::match	public	function	Check a single condition for a single element.
QueryTest::setAllItems	public	function	Sets the allItems property.

Main menu

Search Drupal 8.x

API Navigation

class QueryTest

Plugin annotation

Hierarchy

File

Namespace

Members

Main menu

You are here

Search Drupal 8.x

API Navigation

class QueryTest

Plugin annotation

Hierarchy

File

Namespace

Members