public function EntityFieldQuery::propertyCondition

You are here

7 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;
}

Comments

<?php
// Initialize EntityFieldQuery
 
$entity_type = 'node';
 
$efq = new EntityFieldQuery();
 
$efq->entityCondition('entity_type', $entity_type);

 

// Query condition Using LIKE wildcard
 
$efq->propertyCondition('title', "%".$form_state['values']['title']."%","LIKE"); 

 

// Execute query and collect results
 
$result = $efq->execute(); 
?>

This is perfectly safe as the $value parameter gets replaced with a placeholder when the query is built.

Hi,
is there a way to use "%" and LIKE operator with an array of values ?

Is it just me or is it really the same syntax as db_select ... condition has?

For string comparisons, such as:

<?php
  $query
= new EntityFieldQuery();
 
$query->entityCondition('entity_type', 'example')
        ->
propertyCondition('name', $name);
 
$result = $query->execute();
?>

The value of $name can be "CaSe INsensitivE" and it will match an entity name such as "Case insensitive".

The case sensitivity depends on the entity table collation (which is usually the default database collation). In other words, if your entity table (e.g. node) collation ends in "_ci" (i.e. case-insensitive), such as utf8_general_ci, the query will be case-insensitive.

In general, the collation of tables for a Drupal install defaults to the collation of the database created when first installing the site.

If your installation uses a database that doesn't offer collation, such as Mongo, you may not be able to achieve a case-insensitive EFQ without regex — which is computationally expensive.

In our experience with Mongo, if you're doing a simple query, such as seeing if a username exists, it's simpler and safer to just use a db_query() on the SQL database, instead of using an Entity Field Query.

"The case sensitivity depends on the entity table collation"

Regardless of the table collation, I am finding that property conditions are handled case-insensitively. I have tried utf8_bin and latin1_general_cs, but the results are still case-insensitive.

In my case, I'm using MySQL 5.5.35.

Changing the table collation with an "alter table" query didn't work for me, but changing the collation per query works, as explained here: http://drupal.stackexchange.com/a/77788
Note Alice Heaton's comment re: utf8_bin.

'!=' should be listed among the possible values for $operator.