function views_plugin_query_default::add_where

Same name in other branches
  1. 6.x-3.x plugins/views_plugin_query_default.inc \views_plugin_query_default::add_where()

Add a simple WHERE clause to the query.

The caller is responsible for ensuring that all fields are fully qualified (TABLE.FIELD) and that the table already exists in the query.

$this->query
    ->add_where($this->options['group'], db_or()->condition($field, $value, 'NOT IN')
    ->condition($field, $value, 'IS NULL'));

Parameters

string $group: The WHERE group to add these to; groups are used to create AND/OR sections. Groups cannot be nested. Use 0 as the default group. If the group does not yet exist it will be created as an AND group.

string $field: The name of the field to check.

string $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 the $operator.

string $operator: The comparison operator, such as =, <, or >=. It also accepts more complex options such as IN, LIKE, or BETWEEN. Defaults to IN if $value is an array = otherwise. If $field is a string you have to use 'formula' here.

The $field, $value and $operator arguments can also be passed in with a single DatabaseCondition object, like this:

See also

QueryConditionInterface::condition()

DatabaseCondition

File

plugins/views_plugin_query_default.inc, line 900

Class

views_plugin_query_default
Object used to create a SELECT query.

Code

public function add_where($group, $field, $value = NULL, $operator = NULL) {
    // Ensure all variants of 0 are actually 0. Thus '', 0 and NULL are all the
    // default group.
    if (empty($group)) {
        $group = 0;
    }
    // Check for a group.
    if (!isset($this->where[$group])) {
        $this->set_where_group('AND', $group);
    }
    $this->where[$group]['conditions'][] = array(
        'field' => $field,
        'value' => $value,
        'operator' => $operator,
    );
}