1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Entity
  7. \
  8. Query
  9. \
  10. Sql
  11. \
  12. Condition

Condition

class Condition extends ConditionBase (View source)

Implements entity query conditions for SQL databases.

Properties

protected array $conditions

Array of conditions.

 from  ConditionFundamentals
protected string $conjunction

The conjunction of this condition group.

 from  ConditionFundamentals
protected Query $query

The SQL entity query object this condition belongs to.
protected array $namespaces

List of potential namespaces of the classes belonging to this condition.

 from  ConditionFundamentals
protected bool $nestedInsideOrCondition

Whether this condition is nested inside an OR condition.

Methods

__construct(string $conjunction, QueryInterface $query, array $namespaces = [])

Constructs a Condition object.

from  ConditionFundamentals
getConjunction()

{@inheritdoc}

from  ConditionFundamentals
count()

{@inheritdoc}

from  ConditionFundamentals
conditions()

{@inheritdoc}

from  ConditionFundamentals
__clone()

Implements the magic __clone function.

from  ConditionFundamentals
$this
condition(string|ConditionInterface $field, mixed $value = NULL, string $operator = NULL, string $langcode = NULL)

Adds a condition.

from  ConditionBase
compile($conditionContainer)

Compiles this conditional clause.

$this
exists(string $field, string $langcode = NULL)

Queries for the existence of a field.

$this
notExists(string $field, string $langcode = NULL)

Queries for the nonexistence of a field.

static 
translateCondition(array $condition, SelectInterface $sql_query, bool|null $case_sensitive)

Translates the string operators to SQL equivalents.

Details

in ConditionFundamentals at line 52
__construct(string $conjunction, QueryInterface $query, array $namespaces = [])

Constructs a Condition object.

Parameters

string $conjunction

The operator to use to combine conditions: 'AND' or 'OR'.
QueryInterface $query

The entity query this condition belongs to.
array $namespaces

List of potential namespaces of the classes belonging to this condition.

in ConditionFundamentals at line 61
getConjunction()

{@inheritdoc}

in ConditionFundamentals at line 68
count()

{@inheritdoc}

in ConditionFundamentals at line 76
conditions()

{@inheritdoc}

in ConditionFundamentals at line 85
__clone()

Implements the magic __clone function.

Makes sure condition groups are cloned as well.

in ConditionBase at line 13
$this condition(string|ConditionInterface $field, mixed $value = NULL, string $operator = NULL, string $langcode = NULL)

Adds a condition.

Parameters

string|ConditionInterface $field

The field.
mixed $value

(optional) The value.
string $operator

(optional) The operator.
string $langcode

(optional) For which language the entity should be prepared, defaults to the current content language.

Return Value

$this

at line 31
compile($conditionContainer)

Compiles this conditional clause.

Parameters

$conditionContainer

at line 79
$this exists(string $field, string $langcode = NULL)

Queries for the existence of a field.

Parameters

string $field

The field to query for existence.
string $langcode

(optional) For which language the entity should be prepared, defaults to the current content language.

Return Value

$this

at line 86
$this notExists(string $field, string $langcode = NULL)

Queries for the nonexistence of a field.

Parameters

string $field

The field to query for nonexistence.
string $langcode

(optional) For which language the entity should be prepared, defaults to the current content language.

Return Value

$this

at line 103
static translateCondition(array $condition, SelectInterface $sql_query, bool|null $case_sensitive)

Translates the string operators to SQL equivalents.

Parameters

array $condition

The condition array.
SelectInterface $sql_query

Select query instance.
bool|null $case_sensitive

If the condition should be case sensitive or not, NULL if the field does not define it.

See also

ConditionInterface::condition