public __construct([ mixed $table = NULL ] ) (defined in Kohana_Database_Query_Builder_Update)

Parameters

• mixed $table = NULL - Table name or array($table, $alias) or object

Return Values

• void

public function __construct($table = NULL)
{
	if ($table)
	{
		// Set the inital table name
		$this->_table = $table;
	}

	// Start the query with no SQL
	return parent::__construct(Database::UPDATE, '');
}

public compile([ mixed $db = NULL ] ) (defined in Kohana_Database_Query_Builder_Update)

Parameters

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

Return Values

• string

public function compile($db = NULL)
{
	if ( ! is_object($db))
	{
		// Get the database instance
		$db = Database::instance($db);
	}

	// Start an update query
	$query = 'UPDATE '.$db->quote_table($this->_table);

	// Add the columns to update
	$query .= ' SET '.$this->_compile_set($db, $this->_set);

	if ( ! empty($this->_where))
	{
		// Add selection conditions
		$query .= ' WHERE '.$this->_compile_conditions($db, $this->_where);
	}

	if ( ! empty($this->_order_by))
	{
		// Add sorting
		$query .= ' '.$this->_compile_order_by($db, $this->_order_by);
	}

	if ($this->_limit !== NULL)
	{
		// Add limiting
		$query .= ' LIMIT '.$this->_limit;
	}

	$this->_sql = $query;

	return parent::compile($db);
}

public reset() (defined in Kohana_Database_Query_Builder_Update)

Return Values

• $this

public function reset()
{
	$this->_table = NULL;

	$this->_set   =
	$this->_where = [];

	$this->_limit = NULL;

	$this->_parameters = [];

	$this->_sql = NULL;

	return $this;
}

public set(array $pairs ) (defined in Kohana_Database_Query_Builder_Update)

Parameters

• array $pairs required - Associative (column => value) list

Return Values

• $this

public function set(array $pairs)
{
	foreach ($pairs as $column => $value)
	{
		$this->_set[] = [$column, $value];
	}

	return $this;
}

public table(mixed $table ) (defined in Kohana_Database_Query_Builder_Update)

Parameters

• mixed $table required - Table name or array($table, $alias) or object

Return Values

• $this

public function table($table)
{
	$this->_table = $table;

	return $this;
}

public value(mixed $column , mixed $value ) (defined in Kohana_Database_Query_Builder_Update)

Parameters

• mixed $column required - Table name or array($table, $alias) or object
• mixed $value required - Column value

Return Values

• $this

public function value($column, $value)
{
	$this->_set[] = [$column, $value];

	return $this;
}

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

Parameters

• mixed $column required - Column name or array($column, $alias) or object
• string $op required - Logic operator
• mixed $value required - Column value

Return Values

• $this

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)

Return Values

• $this

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

	return $this;
}

public and_where_open() (defined in Kohana_Database_Query_Builder_Where)

Return Values

• $this

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

	return $this;
}

public limit(integer $number ) (defined in Kohana_Database_Query_Builder_Where)

Parameters

• integer $number required - Maximum results to return or NULL to reset

Return Values

• $this

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)

Parameters

• mixed $column required - Column name or array($column, $alias) or object
• string $op required - Logic operator
• mixed $value required - Column value

Return Values

• $this

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)

Return Values

• $this

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

	return $this;
}

public or_where_open() (defined in Kohana_Database_Query_Builder_Where)

Return Values

• $this

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)

Parameters

• mixed $column required - Column name or array($column, $alias) or object
• string $direction = NULL - Direction of sorting

Return Values

• $this

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)

Parameters

• mixed $column required - Column name or array($column, $alias) or object
• string $op required - Logic operator
• mixed $value required - Column value

Return Values

• $this

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

public where_close() (defined in Kohana_Database_Query_Builder_Where)

Return Values

• $this

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

public where_close_empty() (defined in Kohana_Database_Query_Builder_Where)

Return Values

• $this

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)

Return Values

• $this

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

public __toString() (defined in Kohana_Database_Query)

Return Values

• string

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)

Return Values

• $this

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)

Parameters

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

Return Values

• $this

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)

Parameters

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

Return Values

• $this

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)

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

Tags

• Uses - Kohana::$cache_life

Return Values

• $this

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 execute([ mixed $db = NULL , string $as_object = NULL , array $object_params = NULL ] ) (defined in Kohana_Database_Query)

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

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)

Parameters

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

Return Values

• $this

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)

Parameters

• array $params required - List of parameters

Return Values

• $this

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

	return $this;
}

public type() (defined in Kohana_Database_Query)

Return Values

• integer

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

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

Parameters

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

Return Values

• string

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 ($op === 'IN' AND is_array($value) AND count($value) === 0)
				{
					$value = '(NULL)';
				}
				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)

Parameters

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

Return Values

• string

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)

Parameters

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

Return Values

• string

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(Database $db , array $columns ) (defined in Kohana_Database_Query_Builder)

Parameters

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

Tags

• Throws - Database_Exception

Return Values

• string

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

			// Make sure direction is either ASC or DESC to prevent injections
			if ( ! in_array($direction, [' ASC', ' DESC'])) {
				throw new Database_Exception('Invalid sorting direction: ' . $direction);
			}
		}

		$sort[] = $column.$direction;
	}

	return 'ORDER BY '.implode(', ', $sort);
}

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

Parameters

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

Return Values

• string

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