Modules

abstract Database_Query_Builder_Where
extends Kohana_Database_Query_Builder_Where
extends Database_Query_Builder
extends Kohana_Database_Query_Builder
extends Database_Query
extends Kohana_Database_Query

Database query builder for WHERE statements. See Query Builder for usage and examples.

package: Kohana/Database
category: Query
author: Kohana Team
copyright: © 2008-2009 Kohana Team
license: https://kohana.top/license

Class declared in MODPATH/database/classes/Database/Query/Builder/Where.php on line 3.

Constants

None

Methods

and_where()
and_where_close()
and_where_open()
limit()
or_where()
or_where_close()
or_where_open()
order_by()
where()
where_close()
where_close_empty()
where_open()
reset()
__construct()
__toString()
as_assoc()
as_object()
bind()
cached()
compile()
execute()
param()
parameters()
type()
_compile_conditions()
_compile_group_by()
_compile_join()
_compile_order_by()
_compile_set()

Propertieslink to this

protected $_as_objectlink to this

Default value:

bool FALSE

protected $_force_executelink to this

Default value:

bool FALSE

protected $_lifetimelink to this

Default value:

NULL

protected $_limitlink to this

Default value:

NULL

protected $_object_paramslink to this

Default value:

array(0)

protected $_order_bylink to this

Default value:

array(0)

protected $_parameterslink to this

Default value:

array(0)

protected $_sqllink to this

Default value:

NULL

protected $_typelink to this

Default value:

NULL

protected $_wherelink to this

Default value:

array(0)

Methodslink to this

public and_where( mixed $column , string $op , mixed $value ) (defined in Kohana_Database_Query_Builder_Where) link to this

Creates a new "AND WHERE" condition for the query.

Parameters

mixed $column required - Column name or [$column, $alias] or object
string $op required - Logic operator
mixed $value required - Column value

Return Values

$this

Source Code

?
public function and_where($column, $op, $value)
{
    $this->_where[] = ['AND' => [$column, $op, $value]];
 
    return $this;
}

public and_where_close( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Closes an open "WHERE (...)" grouping.

Return Values

$this

Source Code

?
public function and_where_close()
{
    $this->_where[] = ['AND' => ')'];
 
    return $this;
}

public and_where_open( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Opens a new "AND WHERE (...)" grouping.

Return Values

$this

Source Code

?
public function and_where_open()
{
    $this->_where[] = ['AND' => '('];
 
    return $this;
}

public limit( integer $number ) (defined in Kohana_Database_Query_Builder_Where) link to this

Return up to "LIMIT ..." results

Parameters

integer $number required - Maximum results to return or null to reset

Return Values

$this

Source Code

?
public function limit($number)
{
    $this->_limit = ($number === null) ? null : (int) $number;
 
    return $this;
}

public or_where( mixed $column , string $op , mixed $value ) (defined in Kohana_Database_Query_Builder_Where) link to this

Creates a new "OR WHERE" condition for the query.

Parameters

mixed $column required - Column name or [$column, $alias] or object
string $op required - Logic operator
mixed $value required - Column value

Return Values

$this

Source Code

?
public function or_where($column, $op, $value)
{
    $this->_where[] = ['OR' => [$column, $op, $value]];
 
    return $this;
}

public or_where_close( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Closes an open "WHERE (...)" grouping.

Return Values

$this

Source Code

?
public function or_where_close()
{
    $this->_where[] = ['OR' => ')'];
 
    return $this;
}

public or_where_open( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Opens a new "OR WHERE (...)" grouping.

Return Values

$this

Source Code

?
public function or_where_open()
{
    $this->_where[] = ['OR' => '('];
 
    return $this;
}

public order_by( mixed $column [, string $direction = NULL ] ) (defined in Kohana_Database_Query_Builder_Where) link to this

Applies sorting with "ORDER BY ..."

Parameters

mixed $column required - Column name or [$column, $alias] or object
string $direction = NULL - Direction of sorting

Return Values

$this

Source Code

?
public function order_by($column, $direction = null)
{
    $this->_order_by[] = [$column, $direction];
 
    return $this;
}

public where( mixed $column , string $op , mixed $value ) (defined in Kohana_Database_Query_Builder_Where) link to this

Alias of and_where()

Parameters

mixed $column required - Column name or [$column, $alias] or object
string $op required - Logic operator
mixed $value required - Column value

Return Values

$this

Source Code

?
public function where($column, $op, $value)
{
    return $this->and_where($column, $op, $value);
}

public where_close( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Closes an open "WHERE (...)" grouping.

Return Values

$this

Source Code

?
public function where_close()
{
    return $this->and_where_close();
}

public where_close_empty( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Closes an open "WHERE (...)" grouping or removes the grouping when it is empty.

Return Values

$this

Source Code

?
public function where_close_empty()
{
    $group = end($this->_where);
 
    if ($group AND reset($group) === '(') {
        array_pop($this->_where);
 
        return $this;
    }
 
    return $this->where_close();
}

public where_open( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Alias of and_where_open()

Return Values

$this

Source Code

?
public function where_open()
{
    return $this->and_where_open();
}

abstract public reset( ) (defined in Kohana_Database_Query_Builder) link to this

Reset the current builder status.

Return Values

$this

Source Code

?
abstract public function reset();

public __construct( integer $type , string $sql ) (defined in Kohana_Database_Query) link to this

Creates a new SQL query of the specified type.

Parameters

integer $type required - Query type: Database::SELECT, Database::INSERT, etc
string $sql required - Query string

Return Values

void

Source Code

?
public function __construct($type, $sql)
{
    $this->_type = $type;
    $this->_sql = $sql;
}

public __toString( ) (defined in Kohana_Database_Query) link to this

Return the SQL query string.

Return Values

string

Source Code

?
public function __toString()
{
    try {
        // Return the SQL string
        return $this->compile(Database::instance());
    } catch (Exception $e) {
        return Kohana_Exception::text($e);
    }
}

public as_assoc( ) (defined in Kohana_Database_Query) link to this

Returns results as associative arrays

Return Values

$this

Source Code

?
public function as_assoc()
{
    $this->_as_object = false;
 
    $this->_object_params = [];
 
    return $this;
}

public as_object( [ string $class = bool TRUE , array $params = NULL ] ) (defined in Kohana_Database_Query) link to this

Returns results as objects

Parameters

string $class = bool TRUE - Classname or true for stdClass
array $params = NULL - $params

Return Values

$this

Source Code

?
public function as_object($class = true, array $params = null)
{
    $this->_as_object = $class;
 
    if ($params) {
        // Add object parameters
        $this->_object_params = $params;
    }
 
    return $this;
}

public bind( string $param , mixed & $var ) (defined in Kohana_Database_Query) link to this

Bind a variable to a parameter in the query.

Parameters

string $param required - Parameter key to replace
byref mixed $var required - Variable to use

Return Values

$this

Source Code

?
public function bind($param, & $var)
{
    // Bind a value to a variable
    $this->_parameters[$param] = & $var;
 
    return $this;
}

public cached( [ integer $lifetime = NULL , boolean $force = bool FALSE ] ) (defined in Kohana_Database_Query) link to this

Enables the query to be cached for a specified amount of time.

Parameters

integer $lifetime = NULL - Number of seconds to cache, 0 deletes it from the cache
boolean $force = bool FALSE - Whether or not to execute the query during a cache hit

Return Values

$this

Source Code

?
public function cached($lifetime = null, $force = false)
{
    if ($lifetime === null) {
        // Use the global setting
        $lifetime = Kohana::$cache_life;
    }
 
    $this->_force_execute = $force;
    $this->_lifetime = $lifetime;
 
    return $this;
}

public compile( [ mixed $db = NULL ] ) (defined in Kohana_Database_Query) link to this

Compile the SQL query and return it. Replaces any parameters with their given values.

Parameters

mixed $db = NULL - Database instance or name of instance

Return Values

string

Source Code

?
public function compile($db = null)
{
    if (!is_object($db)) {
        // Get the database instance
        $db = Database::instance($db);
    }
 
    // Import the SQL locally
    $sql = $this->_sql;
 
    if (!empty($this->_parameters)) {
        // Quote all of the values
        $values = array_map([$db, 'quote'], $this->_parameters);
 
        // Replace the values in the SQL
        $sql = strtr($sql, $values);
    }
 
    return $sql;
}

public execute( [ mixed $db = NULL , string $as_object = NULL , array $object_params = NULL ] ) (defined in Kohana_Database_Query) link to this

Execute the current query on the given database.

Parameters

mixed $db = NULL - Database instance or name of instance
string $as_object = NULL - Result object classname, true for stdClass or false for array
array $object_params = NULL - Result object constructor arguments

Return Values

object - Database_Result for SELECT queries
mixed - The insert id for INSERT queries
integer - Number of affected rows for all other queries

Source Code

?
public function execute($db = null, $as_object = null, $object_params = null)
{
    if (!is_object($db)) {
        // Get the database instance
        $db = Database::instance($db);
    }
 
    if ($as_object === null) {
        $as_object = $this->_as_object;
    }
 
    if ($object_params === null) {
        $object_params = $this->_object_params;
    }
 
    // Compile the SQL query
    $sql = $this->compile($db);
 
    if ($this->_lifetime !== null AND $this->_type === Database::SELECT) {
        // Set the cache key based on the database instance name and SQL
        $cache_key = 'Database::query("' . $db . '", "' . $sql . '")';
 
        // Read the cache first to delete a possible hit with lifetime <= 0
        if (($result = Kohana::cache($cache_key, null, $this->_lifetime)) !== null
            AND ! $this->_force_execute) {
            // Return a cached result
            return new Database_Result_Cached($result, $sql, $as_object, $object_params);
        }
    }
 
    // Execute the query
    $result = $db->query($this->_type, $sql, $as_object, $object_params);
 
    if (isset($cache_key) AND $this->_lifetime > 0) {
        // Cache the result array
        Kohana::cache($cache_key, $result->as_array(), $this->_lifetime);
    }
 
    return $result;
}

public param( string $param , mixed $value ) (defined in Kohana_Database_Query) link to this

Set the value of a parameter in the query.

Parameters

string $param required - Parameter key to replace
mixed $value required - Value to use

Return Values

$this

Source Code

?
public function param($param, $value)
{
    // Add or overload a new parameter
    $this->_parameters[$param] = $value;
 
    return $this;
}

public parameters( array $params ) (defined in Kohana_Database_Query) link to this

Add multiple parameters to the query.

Parameters

array $params required - List of parameters

Return Values

$this

Source Code

?
public function parameters(array $params)
{
    // Merge the new parameters in
    $this->_parameters = $params + $this->_parameters;
 
    return $this;
}

public type( ) (defined in Kohana_Database_Query) link to this

Get the type of the query.

Return Values

integer

Source Code

?
public function type()
{
    return $this->_type;
}

protected _compile_conditions( object $db , array $conditions ) (defined in Kohana_Database_Query_Builder) link to this

Compiles an array of conditions into an SQL partial. Used for WHERE and HAVING.

Parameters

object $db required - Database instance
array $conditions required - Condition statements

Return Values

string

Source Code

?
protected function _compile_conditions(Database $db, array $conditions)
{
    $last_condition = null;
 
    $sql = '';
    foreach ($conditions as $group) {
        // Process groups of conditions
        foreach ($group as $logic => $condition) {
            if ($condition === '(') {
                if (!empty($sql) AND $last_condition !== '(') {
                    // Include logic operator
                    $sql .= ' ' . $logic . ' ';
                }
 
                $sql .= '(';
            } elseif ($condition === ')') {
                $sql .= ')';
            } else {
                if (!empty($sql) AND $last_condition !== '(') {
                    // Add the logic operator
                    $sql .= ' ' . $logic . ' ';
                }
 
                // Split the condition
                list($column, $op, $value) = $condition;
 
                if ($value === null) {
                    if ($op === '=') {
                        // Convert "val = NULL" to "val IS NULL"
                        $op = 'IS';
                    } elseif ($op === '!=' OR $op === '<>') {
                        // Convert "val != NULL" to "valu IS NOT NULL"
                        $op = 'IS NOT';
                    }
                }
 
                // Database operators are always uppercase
                $op = strtoupper($op);
 
                if ($op === 'BETWEEN' AND is_array($value)) {
                    // BETWEEN always has exactly two arguments
                    list($min, $max) = $value;
 
                    if ((is_string($min) AND array_key_exists($min, $this->_parameters)) === false) {
                        // Quote the value, it is not a parameter
                        $min = $db->quote($min);
                    }
 
                    if ((is_string($max) AND array_key_exists($max, $this->_parameters)) === false) {
                        // Quote the value, it is not a parameter
                        $max = $db->quote($max);
                    }
 
                    // Quote the min and max value
                    $value = $min . ' AND ' . $max;
                } elseif ((is_string($value) AND array_key_exists($value, $this->_parameters)) === false) {
                    // Quote the value, it is not a parameter
                    $value = $db->quote($value);
                }
 
                if ($column) {
                    if (is_array($column)) {
                        // Use the column name
                        $column = $db->quote_identifier(reset($column));
                    } else {
                        // Apply proper quoting to the column
                        $column = $db->quote_column($column);
                    }
                }
 
                // Append the statement to the query
                $sql .= trim($column . ' ' . $op . ' ' . $value);
            }
 
            $last_condition = $condition;
        }
    }
 
    return $sql;
}

protected _compile_group_by( object $db , array $columns ) (defined in Kohana_Database_Query_Builder) link to this

Compiles an array of GROUP BY columns into an SQL partial.

Parameters

object $db required - Database instance
array $columns required - $columns

Return Values

string

Source Code

?
protected function _compile_group_by(Database $db, array $columns)
{
    $group = [];
 
    foreach ($columns as $column) {
        if (is_array($column)) {
            // Use the column alias
            $column = $db->quote_identifier(end($column));
        } else {
            // Apply proper quoting to the column
            $column = $db->quote_column($column);
        }
 
        $group[] = $column;
    }
 
    return 'GROUP BY ' . implode(', ', $group);
}

protected _compile_join( object $db , array $joins ) (defined in Kohana_Database_Query_Builder) link to this

Compiles an array of JOIN statements into an SQL partial.

Parameters

object $db required - Database instance
array $joins required - Join statements

Return Values

string

Source Code

?
protected function _compile_join(Database $db, array $joins)
{
    $statements = [];
 
    foreach ($joins as $join) {
        // Compile each of the join statements
        $statements[] = $join->compile($db);
    }
 
    return implode(' ', $statements);
}

protected _compile_order_by( object $db , array $columns ) (defined in Kohana_Database_Query_Builder) link to this

Compiles an array of ORDER BY statements into an SQL partial.

Parameters

object $db required - Database instance
array $columns required - Sorting columns

Return Values

string

Source Code

?
protected function _compile_order_by(Database $db, array $columns)
{
    $sort = [];
    foreach ($columns as $group) {
        list ($column, $direction) = $group;
 
        if (is_array($column)) {
            // Use the column alias
            $column = $db->quote_identifier(end($column));
        } else {
            // Apply proper quoting to the column
            $column = $db->quote_column($column);
        }
 
        if ($direction) {
            // Make the direction uppercase
            $direction = strtoupper($direction);
 
            if (!in_array($direction, ['ASC', 'DESC'])) {
                throw new Database_Exception('Order direction must be "ASC" or "DESC".');
            }
 
            $direction = ' ' . $direction;
        }
 
        $sort[] = $column . $direction;
    }
 
    return 'ORDER BY ' . implode(', ', $sort);
}

protected _compile_set( object $db , array $values ) (defined in Kohana_Database_Query_Builder) link to this

Compiles an array of set values into an SQL partial. Used for UPDATE.

Parameters

object $db required - Database instance
array $values required - Updated values

Return Values

string

Source Code

?
protected function _compile_set(Database $db, array $values)
{
    $set = [];
    foreach ($values as $group) {
        // Split the set
        list ($column, $value) = $group;
 
        // Quote the column name
        $column = $db->quote_column($column);
 
        if ((is_string($value) AND array_key_exists($value, $this->_parameters)) === false) {
            // Quote the value, it is not a parameter
            $value = $db->quote($value);
        }
 
        $set[$column] = $column . ' = ' . $value;
    }
 
    return implode(', ', $set);
}

Modules

abstract Database_Query_Builder_Where extends Kohana_Database_Query_Builder_Where extends Database_Query_Builder extends Kohana_Database_Query_Builder extends Database_Query extends Kohana_Database_Query

Constants

Properties

Methods

Propertieslink to this

protected $_as_objectlink to this

protected $_force_executelink to this

protected $_lifetimelink to this

protected $_limitlink to this

protected $_object_paramslink to this

protected $_order_bylink to this

protected $_parameterslink to this

protected $_sqllink to this

protected $_typelink to this

protected $_wherelink to this

Methodslink to this

public and_where( mixed $column , string $op , mixed $value ) (defined in Kohana_Database_Query_Builder_Where) link to this

Parameters

Return Values

Source Code

public and_where_close( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Return Values

Source Code

public and_where_open( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Return Values

Source Code

public limit( integer $number ) (defined in Kohana_Database_Query_Builder_Where) link to this

Parameters

Return Values

Source Code

public or_where( mixed $column , string $op , mixed $value ) (defined in Kohana_Database_Query_Builder_Where) link to this

Parameters

Return Values

Source Code

public or_where_close( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Return Values

Source Code

public or_where_open( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Return Values

Source Code

public order_by( mixed $column [, string $direction = NULL ] ) (defined in Kohana_Database_Query_Builder_Where) link to this

Parameters

Return Values

Source Code

public where( mixed $column , string $op , mixed $value ) (defined in Kohana_Database_Query_Builder_Where) link to this

Parameters

Return Values

Source Code

public where_close( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Return Values

Source Code

public where_close_empty( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Return Values

Source Code

public where_open( ) (defined in Kohana_Database_Query_Builder_Where) link to this

Return Values

Source Code

abstract public reset( ) (defined in Kohana_Database_Query_Builder) link to this

Return Values

Source Code

public __construct( integer $type , string $sql ) (defined in Kohana_Database_Query) link to this

Parameters

Return Values

Source Code

public __toString( ) (defined in Kohana_Database_Query) link to this

Return Values

Source Code

public as_assoc( ) (defined in Kohana_Database_Query) link to this

Return Values

Source Code

public as_object( [ string $class = bool TRUE , array $params = NULL ] ) (defined in Kohana_Database_Query) link to this

Parameters

Return Values

Source Code

public bind( string $param , mixed & $var ) (defined in Kohana_Database_Query) link to this

Parameters

Return Values

Source Code

public cached( [ integer $lifetime = NULL , boolean $force = bool FALSE ] ) (defined in Kohana_Database_Query) link to this

abstract Database_Query_Builder_Where
extends Kohana_Database_Query_Builder_Where
extends Database_Query_Builder
extends Kohana_Database_Query_Builder
extends Database_Query
extends Kohana_Database_Query