function ConditionInterface::conditions

Same name in this branch
  1. 10 core/lib/Drupal/Core/Entity/Query/ConditionInterface.php \Drupal\Core\Entity\Query\ConditionInterface::conditions()
Same name in other branches
  1. 9 core/lib/Drupal/Core/Database/Query/ConditionInterface.php \Drupal\Core\Database\Query\ConditionInterface::conditions()
  2. 9 core/lib/Drupal/Core/Entity/Query/ConditionInterface.php \Drupal\Core\Entity\Query\ConditionInterface::conditions()
  3. 8.9.x core/lib/Drupal/Core/Database/Query/ConditionInterface.php \Drupal\Core\Database\Query\ConditionInterface::conditions()
  4. 8.9.x core/lib/Drupal/Core/Entity/Query/ConditionInterface.php \Drupal\Core\Entity\Query\ConditionInterface::conditions()
  5. 11.x core/lib/Drupal/Core/Database/Query/ConditionInterface.php \Drupal\Core\Database\Query\ConditionInterface::conditions()
  6. 11.x core/lib/Drupal/Core/Entity/Query/ConditionInterface.php \Drupal\Core\Entity\Query\ConditionInterface::conditions()

Gets the, possibly nested, list of conditions in this conditional clause.

This method returns by reference. That allows alter hooks to access the data structure directly and manipulate it before it gets compiled.

The data structure that is returned is an indexed array of entries, where each entry looks like the following:

[
    'field' => $field,
    'value' => $value,
    'operator' => $operator,
];

In the special case that $operator is NULL, the $field is taken as a raw SQL snippet (possibly containing a function) and $value is an associative array of placeholders for the snippet.

There will also be a single array entry of #conjunction, which is the conjunction that will be applied to the array, such as AND.

Return value

array The, possibly nested, list of all conditions (by reference).

2 methods override ConditionInterface::conditions()
Condition::conditions in core/lib/Drupal/Core/Database/Query/Condition.php
Gets the, possibly nested, list of conditions in this conditional clause.
SelectExtender::conditions in core/lib/Drupal/Core/Database/Query/SelectExtender.php
Gets the, possibly nested, list of conditions in this conditional clause.

File

core/lib/Drupal/Core/Database/Query/ConditionInterface.php, line 168

Class

ConditionInterface
Interface for a conditional clause in a query.

Namespace

Drupal\Core\Database\Query

Code

public function &conditions();

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.