class ConditionAggregate

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Entity/Query/Sql/ConditionAggregate.php \Drupal\Core\Entity\Query\Sql\ConditionAggregate
  2. 10 core/lib/Drupal/Core/Entity/Query/Sql/ConditionAggregate.php \Drupal\Core\Entity\Query\Sql\ConditionAggregate
  3. 11.x core/lib/Drupal/Core/Entity/Query/Sql/ConditionAggregate.php \Drupal\Core\Entity\Query\Sql\ConditionAggregate

Defines the aggregate condition for sql based storage.

Hierarchy

Expanded class hierarchy of ConditionAggregate

1 file declares its use of ConditionAggregate
Query.php in core/lib/Drupal/Core/Entity/Query/Null/Query.php
1 string reference to 'ConditionAggregate'
QueryAggregate::conditionAggregateGroupFactory in core/lib/Drupal/Core/Entity/Query/Sql/QueryAggregate.php
Creates an object holding a group of conditions.

File

core/lib/Drupal/Core/Entity/Query/Sql/ConditionAggregate.php, line 13

Namespace

Drupal\Core\Entity\Query\Sql
View source
class ConditionAggregate extends ConditionAggregateBase {
    
    /**
     * The current SQL query, set by parent condition compile() method calls.
     *
     * @var \Drupal\Core\Database\Query\SelectInterface
     */
    protected $sqlQuery;
    
    /**
     * {@inheritdoc}
     */
    public function compile($conditionContainer) {
        // If this is not the top level condition group then the sql query is
        // added to the $conditionContainer object by this function itself. The
        // SQL query object is only necessary to pass to Query::addField() so it
        // can join tables as necessary. On the other hand, conditions need to be
        // added to the $conditionContainer object to keep grouping.
        $sql_query = $conditionContainer instanceof SelectInterface ? $conditionContainer : $this->sqlQuery;
        $tables = new Tables($sql_query);
        foreach ($this->conditions as $condition) {
            if ($condition['field'] instanceof ConditionAggregateInterface) {
                $sql_condition = $sql_query->getConnection()
                    ->condition($condition['field']->getConjunction());
                // Add the SQL query to the object before calling this method again.
                $condition['field']->sqlQuery = $sql_query;
                $condition['field']->compile($sql_condition);
                $sql_query->condition($sql_condition);
            }
            else {
                $type = strtoupper($this->conjunction) == 'OR' || $condition['operator'] == 'IS NULL' ? 'LEFT' : 'INNER';
                $field = $tables->addField($condition['field'], $type, $condition['langcode']);
                $condition_class = QueryBase::getClass($this->namespaces, 'Condition');
                $condition_class::translateCondition($condition, $sql_query, $tables->isFieldCaseSensitive($condition['field']));
                $function = $condition['function'];
                $placeholder = ':db_placeholder_' . $conditionContainer->nextPlaceholder();
                $sql_field_escaped = '[' . str_replace('.', '].[', $field) . ']';
                $conditionContainer->having("{$function}({$sql_field_escaped}) {$condition['operator']} {$placeholder}", [
                    $placeholder => $condition['value'],
                ]);
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function exists($field, $function, $langcode = NULL) {
        return $this->condition($field, $function, NULL, 'IS NOT NULL', $langcode);
    }
    
    /**
     * {@inheritdoc}
     */
    public function notExists($field, $function, $langcode = NULL) {
        return $this->condition($field, $function, NULL, 'IS NULL', $langcode);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConditionAggregate::$sqlQuery protected property The current SQL query, set by parent condition compile() method calls.
ConditionAggregate::compile public function Compiles this conditional clause. Overrides ConditionAggregateInterface::compile
ConditionAggregate::exists public function Queries for the existence of a field. Overrides ConditionAggregateInterface::exists
ConditionAggregate::notExists public function Queries for the nonexistence of a field. Overrides ConditionAggregateInterface::notExists
ConditionAggregateBase::condition public function Adds a condition. Overrides ConditionAggregateInterface::condition
ConditionFundamentals::$conditions protected property Array of conditions.
ConditionFundamentals::$conjunction protected property The conjunction of this condition group.
ConditionFundamentals::$namespaces protected property List of potential namespaces of the classes belonging to this condition.
ConditionFundamentals::$query protected property The query this condition belongs to. 1
ConditionFundamentals::conditions public function
ConditionFundamentals::count public function
ConditionFundamentals::getConjunction public function
ConditionFundamentals::__clone public function Implements the magic __clone function.
ConditionFundamentals::__construct public function Constructs a Condition object.

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