public function EntityFieldQuery::propertyCondition

cis7 entity.inc public EntityFieldQuery::propertyCondition($column, $value, $operator = NULL)
cle7 entity.inc public EntityFieldQuery::propertyCondition($column, $value, $operator = NULL)
elmsmedia7 entity.inc public EntityFieldQuery::propertyCondition($column, $value, $operator = NULL)
icor7 entity.inc public EntityFieldQuery::propertyCondition($column, $value, $operator = NULL)
meedjum_blog7 entity.inc public EntityFieldQuery::propertyCondition($column, $value, $operator = NULL)
mooc7 entity.inc public EntityFieldQuery::propertyCondition($column, $value, $operator = NULL)

Adds a condition on an entity-specific property.

An $entity_type must be specified by calling EntityFieldCondition::entityCondition('entity_type', $entity_type) before executing the query. Also, by default only entities stored in SQL are supported; however, EntityFieldQuery::executeCallback can be set to handle different entity storage.

Parameters

$column: A column defined in the hook_schema() of the base table of the entity.

$value: The value to test the field against. In most cases, this is a scalar. For more complex options, it is an array. The meaning of each element in the array is dependent on $operator.

$operator: Possible values:

  • '=', '<>', '>', '>=', '<', '<=', 'STARTS_WITH', 'CONTAINS': These operators expect $value to be a literal of the same type as the column.
  • 'IN', 'NOT IN': These operators expect $value to be an array of literals of the same type as the column.
  • 'BETWEEN': This operator expects $value to be an array of two literals of the same type as the column.

The operator can be omitted, and will default to 'IN' if the value is an array, or to '=' otherwise.

Return value

EntityFieldQuery The called object.

File

includes/entity.inc, line 815

Class

EntityFieldQuery
Retrieves entities matching a given set of conditions.

Code

public function propertyCondition($column, $value, $operator = NULL) {
  // The '!=' operator is deprecated in favour of the '<>' operator since the
  // latter is ANSI SQL compatible.
  if ($operator == '!=') {
    $operator = '<>';
  }
  $this->propertyConditions[] = array(
    'column' => $column,
    'value' => $value,
    'operator' => $operator,
  );
  return $this;
}