Condition.php

Same filename in this branch
  1. 8.9.x core/lib/Drupal/Core/Config/Entity/Query/Condition.php
  2. 8.9.x core/lib/Drupal/Core/Database/Query/Condition.php
  3. 8.9.x core/lib/Drupal/Core/Entity/Query/Sql/pgsql/Condition.php
  4. 8.9.x core/lib/Drupal/Core/Entity/Query/Null/Condition.php
  5. 8.9.x core/lib/Drupal/Core/Entity/KeyValueStore/Query/Condition.php
  6. 8.9.x core/lib/Drupal/Core/Condition/Annotation/Condition.php
Same filename in other branches
  1. 9 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Condition.php
  2. 9 core/lib/Drupal/Core/Config/Entity/Query/Condition.php
  3. 9 core/lib/Drupal/Core/Database/Query/Condition.php
  4. 9 core/lib/Drupal/Core/Entity/Query/Sql/Condition.php
  5. 9 core/lib/Drupal/Core/Entity/Query/Sql/pgsql/Condition.php
  6. 9 core/lib/Drupal/Core/Entity/Query/Null/Condition.php
  7. 9 core/lib/Drupal/Core/Entity/KeyValueStore/Query/Condition.php
  8. 9 core/lib/Drupal/Core/Condition/Annotation/Condition.php
  9. 10 core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Condition.php
  10. 10 core/lib/Drupal/Core/Config/Entity/Query/Condition.php
  11. 10 core/lib/Drupal/Core/Database/Query/Condition.php
  12. 10 core/lib/Drupal/Core/Entity/Query/Sql/Condition.php
  13. 10 core/lib/Drupal/Core/Entity/Query/Sql/pgsql/Condition.php
  14. 10 core/lib/Drupal/Core/Entity/Query/Null/Condition.php
  15. 10 core/lib/Drupal/Core/Entity/KeyValueStore/Query/Condition.php
  16. 10 core/lib/Drupal/Core/Condition/Attribute/Condition.php
  17. 10 core/lib/Drupal/Core/Condition/Annotation/Condition.php
  18. 11.x core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Condition.php
  19. 11.x core/lib/Drupal/Core/Config/Entity/Query/Condition.php
  20. 11.x core/lib/Drupal/Core/Database/Query/Condition.php
  21. 11.x core/lib/Drupal/Core/Entity/Query/Sql/Condition.php
  22. 11.x core/lib/Drupal/Core/Entity/Query/Sql/pgsql/Condition.php
  23. 11.x core/lib/Drupal/Core/Entity/Query/Null/Condition.php
  24. 11.x core/lib/Drupal/Core/Entity/KeyValueStore/Query/Condition.php
  25. 11.x core/lib/Drupal/Core/Condition/Attribute/Condition.php
  26. 11.x core/lib/Drupal/Core/Condition/Annotation/Condition.php

Namespace

Drupal\Core\Entity\Query\Sql

File

core/lib/Drupal/Core/Entity/Query/Sql/Condition.php

View source
<?php

namespace Drupal\Core\Entity\Query\Sql;

use Drupal\Core\Database\Query\SelectInterface;
use Drupal\Core\Database\Query\Condition as SqlCondition;
use Drupal\Core\Entity\Query\ConditionBase;
use Drupal\Core\Entity\Query\ConditionInterface;

/**
 * Implements entity query conditions for SQL databases.
 */
class Condition extends ConditionBase {
    
    /**
     * Whether this condition is nested inside an OR condition.
     *
     * @var bool
     */
    protected $nestedInsideOrCondition = FALSE;
    
    /**
     * The SQL entity query object this condition belongs to.
     *
     * @var \Drupal\Core\Entity\Query\Sql\Query
     */
    protected $query;
    
    /**
     * {@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 : $conditionContainer->sqlQuery;
        $tables = $this->query
            ->getTables($sql_query);
        foreach ($this->conditions as $condition) {
            if ($condition['field'] instanceof ConditionInterface) {
                $sql_condition = new SqlCondition($condition['field']->getConjunction());
                // Add the SQL query to the object before calling this method again.
                $sql_condition->sqlQuery = $sql_query;
                $condition['field']->nestedInsideOrCondition = $this->nestedInsideOrCondition || strtoupper($this->conjunction) === 'OR';
                $condition['field']->compile($sql_condition);
                $conditionContainer->condition($sql_condition);
            }
            else {
                $type = $this->nestedInsideOrCondition || strtoupper($this->conjunction) === 'OR' || $condition['operator'] === 'IS NULL' ? 'LEFT' : 'INNER';
                $field = $tables->addField($condition['field'], $type, $condition['langcode']);
                $condition['real_field'] = $field;
                static::translateCondition($condition, $sql_query, $tables->isFieldCaseSensitive($condition['field']));
                // Add the translated conditions back to the condition container.
                if (isset($condition['where']) && isset($condition['where_args'])) {
                    $conditionContainer->where($condition['where'], $condition['where_args']);
                }
                else {
                    $conditionContainer->condition($field, $condition['value'], $condition['operator']);
                }
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function exists($field, $langcode = NULL) {
        return $this->condition($field, NULL, 'IS NOT NULL', $langcode);
    }
    
    /**
     * {@inheritdoc}
     */
    public function notExists($field, $langcode = NULL) {
        return $this->condition($field, NULL, 'IS NULL', $langcode);
    }
    
    /**
     * Translates the string operators to SQL equivalents.
     *
     * @param array $condition
     *   The condition array.
     * @param \Drupal\Core\Database\Query\SelectInterface $sql_query
     *   Select query instance.
     * @param bool|null $case_sensitive
     *   If the condition should be case sensitive or not, NULL if the field does
     *   not define it.
     *
     * @see \Drupal\Core\Database\Query\ConditionInterface::condition()
     */
    public static function translateCondition(&$condition, SelectInterface $sql_query, $case_sensitive) {
        // // There is nothing we can do for IN ().
        if (is_array($condition['value'])) {
            return;
        }
        // Ensure that the default operator is set to simplify the cases below.
        if (empty($condition['operator'])) {
            $condition['operator'] = '=';
        }
        switch ($condition['operator']) {
            case '=':
                // If a field explicitly requests that queries should not be case
                // sensitive, use the LIKE operator, otherwise keep =.
                if ($case_sensitive === FALSE) {
                    $condition['value'] = $sql_query->escapeLike($condition['value']);
                    $condition['operator'] = 'LIKE';
                }
                break;
            case '<>':
                // If a field explicitly requests that queries should not be case
                // sensitive, use the NOT LIKE operator, otherwise keep <>.
                if ($case_sensitive === FALSE) {
                    $condition['value'] = $sql_query->escapeLike($condition['value']);
                    $condition['operator'] = 'NOT LIKE';
                }
                break;
            case 'STARTS_WITH':
                if ($case_sensitive) {
                    $condition['operator'] = 'LIKE BINARY';
                }
                else {
                    $condition['operator'] = 'LIKE';
                }
                $condition['value'] = $sql_query->escapeLike($condition['value']) . '%';
                break;
            case 'CONTAINS':
                if ($case_sensitive) {
                    $condition['operator'] = 'LIKE BINARY';
                }
                else {
                    $condition['operator'] = 'LIKE';
                }
                $condition['value'] = '%' . $sql_query->escapeLike($condition['value']) . '%';
                break;
            case 'ENDS_WITH':
                if ($case_sensitive) {
                    $condition['operator'] = 'LIKE BINARY';
                }
                else {
                    $condition['operator'] = 'LIKE';
                }
                $condition['value'] = '%' . $sql_query->escapeLike($condition['value']);
                break;
        }
    }

}

Classes

Title Deprecated Summary
Condition Implements entity query conditions for SQL databases.

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