Class Core_QueryBuilder_Selection

Consist of WHERE, ORDER BY, and LIMIT

Core_QueryBuilder_Selection

Direct known subclasses

Core_QueryBuilder_Delete, Core_QueryBuilder_Select, Core_QueryBuilder_Update

Indirect known subclasses

Search_Sphinx_QueryBuilder_Select

Abstract
Package: HostCMS\Core\Querybuilder
Copyright: © 2005-2021 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru
Author: Hostmake LLC
Version: 6.x
Located at core/querybuilder/selection.php

Methods summary

`public`	# `__construct( array $args = array() )` Constructor. Constructor. Parameters `$args` list of arguments Overrides `Core_QueryBuilder_Statement::__construct`
`public Core_QueryBuilder_Selection`	# `asObject( mixed $className = NULL )` Set result type as an object with className Set result type as an object with className Parameters `$className` Object class name Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `asAssoc( )` Set result type as an array Set result type as an array Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `setDefaultOperator( )` Set operator as a default operator Set operator as a default operator Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `setOperator( string $operator )` Set operator as a default operator Set operator as a default operator Parameters `$operator` Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `setAnd( )` Set operator as AND Set operator as AND Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `setOr( )` Set operator as OR Set operator as OR Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `open( )` Open bracket in WHERE Open bracket in WHERE Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `close( )` Close bracket in WHERE Close bracket in WHERE Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Select`	# `partition( $tableName, array $partitions )` Set PARTITION Set PARTITION // FROM\|JOIN `tableName` PARTITION (`p0`, `p1`) $oCore_QueryBuilder_Select = $Core_QueryBuilder_Select->from('tableName')->partition('tableName', array('p0', 'p1')); Returns `Core_QueryBuilder_Select`
`public Core_QueryBuilder_Selection`	# `indexHint( string $tableName, array $options )` Add Index Hints https://dev.mysql.com/doc/refman/5.7/en/index-hints.html Add Index Hints https://dev.mysql.com/doc/refman/5.7/en/index-hints.html // USE INDEX (`col1_index`) $Core_QueryBuilder_Select->indexHint('table1', array('USE INDEX', 'col1_index')); // USE INDEX FOR JOIN (`col1_index`, `col2_index`) $Core_QueryBuilder_Select->indexHint('table1', array('USE INDEX', 'FOR JOIN', array('col1_index', 'col2_index'))); Parameters `$tableName` table name `$options` [$action, $index_list] or [$action, $for, $index_list] Returns `Core_QueryBuilder_Selection`
`protected string`	# `_buildIndexHint( array $aTableIndexHints )` Build INDEX expression Build INDEX expression Parameters `$aTableIndexHints` Returns string The SQL query
`public array`	# `quoteTable( array $tableName )` Quote columns Quote columns Parameters `$tableName` $array Returns array
`protected array`	# `_quoteTables( array $array )` Quote columns Quote columns Parameters `$array` Returns array
`protected Core_QueryBuilder_Selection`	# `_join( string $type, string $table, string\|null $column = NULL, string\|null $expression = NULL, string\|null $value = NULL, string\|null $additionalConditions = NULL, $mode = NULL )` http://dev.mysql.com/doc/refman/5.7/en/join.html http://dev.mysql.com/doc/refman/5.7/en/join.html Parameters `$type` join type `$table` table name `$column` column name `$expression` expression `$value` value `$additionalConditions` additional conditions `$mode` Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `join( string $table, string $column, string\|null $expression = NULL, string\|null $value = NULL, string\|null $additionalConditions = NULL )` INNER JOIN INNER JOIN // INNER JOIN `join1` USING (`join_field`) $Core_QueryBuilder_Select->join('join1', 'join_field'); // INNER JOIN `jointable`.`join1` ON `join_field` = `join_field2` $Core_QueryBuilder_Select->join('jointable.join1', 'join_field1', '=', 'join_field2'); // INNER JOIN `jointable`.`join1` ON `join_field` = `join_field2` AND `A` = '123' AND `B` = 'xyz' $Core_QueryBuilder_Select->join('jointable.join1', 'join_field1', '=', 'join_field2', array( array('AND' => array('A', '=', '123')), array('AND' => array('B', '=', 'xyz')) )); Parameters `$table` table name `$column` column name `$expression` expression `$value` value `$additionalConditions` additional conditions Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `firstJoin( string $table, string $column, string\|null $expression = NULL, string\|null $value = NULL, string\|null $additionalConditions = NULL )` Add INNER JOIN first Add INNER JOIN first Parameters `$table` table name `$column` column name `$expression` expression `$value` value `$additionalConditions` additional conditions Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `leftJoin( string $table, string $column, string\|null $expression = NULL, string\|null $value = NULL, string\|null $additionalConditions = NULL )` LEFT OUTER JOIN LEFT OUTER JOIN // LEFT OUTER JOIN `join1` USING (`join_field2`) $Core_QueryBuilder_Select->leftJoin('join1', 'join_field2'); // LEFT OUTER JOIN `jointable`.`join1` ON `join_field` = `join_field2` $Core_QueryBuilder_Select->leftJoin('jointable.join1', 'join_field', '=', 'join_field2'); Parameters `$table` table name `$column` column name `$expression` expression `$value` value `$additionalConditions` additional conditions Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `firstLeftJoin( string $table, string $column, string\|null $expression = NULL, string\|null $value = NULL, string\|null $additionalConditions = NULL )` Add LEFT OUTER JOIN first Add LEFT OUTER JOIN first Parameters `$table` table name `$column` column name `$expression` expression `$value` value `$additionalConditions` additional conditions Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `rightJoin( string $table, string $column, string $expression = NULL, string $value = NULL, string $additionalConditions = NULL )` RIGHT OUTER JOIN RIGHT OUTER JOIN // RIGHT OUTER JOIN `join1` USING (`join_field2`) $Core_QueryBuilder_Select->rightJoin('join1', 'join_field2'); // RIGHT OUTER JOIN `jointable`.`join1` ON `join_field` = `join_field2` $Core_QueryBuilder_Select->rightJoin('jointable.join1', 'join_field', '=', 'join_field2'); Parameters `$table` table name `$column` column name `$expression` expression `$value` value `$additionalConditions` additional conditions Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `rightJoinFirst( string $table, string $column, string $expression = NULL, string $value = NULL, string $additionalConditions = NULL )` Add RIGHT OUTER JOIN first Add RIGHT OUTER JOIN first Parameters `$table` table name `$column` column name `$expression` expression `$value` value `$additionalConditions` additional conditions Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `crossJoin( string $table )` In MySQL, CROSS JOIN is a syntactic equivalent to INNER JOIN (they can replace each other). In standard SQL, they are not equivalent. INNER JOIN is used with an ON clause, CROSS JOIN is used otherwise. In MySQL, CROSS JOIN is a syntactic equivalent to INNER JOIN (they can replace each other). In standard SQL, they are not equivalent. INNER JOIN is used with an ON clause, CROSS JOIN is used otherwise. // CROSS JOIN `join1` $Core_QueryBuilder_Select->crossJoin('join1'); Parameters `$table` table name Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `naturalJoin( string $table )` // NATURAL JOIN `join1` $Core_QueryBuilder_Select->naturalJoin('join1'); Parameters `$table` table name Returns `Core_QueryBuilder_Selection`
`protected string`	# `_buildJoin( array $aJoins )` Build JOIN expression Build JOIN expression Parameters `$aJoins` Returns string The SQL query
`public Core_QueryBuilder_Selection`	# `where( string $column, string $expression = NULL, string $value = NULL )` Add WHERE Add WHERE // WHERE `a1` > '2' $Core_QueryBuilder_Select->where('a1', '>', '2'); // WHERE `a4` IN (17, 19, NULL, 'NULL') $Core_QueryBuilder_Select->where('a4', 'IN', array(17, 19, NULL, 'NULL')); // WHERE `a7` BETWEEN 1 AND 10 $Core_QueryBuilder_Select->where('a7', 'BETWEEN', array(1, 10)); Parameters `$column` column `$expression` expression `$value` value Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `deleteLastWhere( )` Delete last WHERE condition Delete last WHERE condition Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `deleteFirstWhere( )` Delete first WHERE condition Delete first WHERE condition Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `orWhere( string $column, string $expression = NULL, string $value = NULL )` Add OR and WHERE, e.g. WHERE ... OR $column $expression $value Add OR and WHERE, e.g. WHERE ... OR $column $expression $value // WHERE `a1` > 2 OR `a2` < 7 $Core_QueryBuilder_Select->where('a1', '>', 2)->orWhere('a2', '<', 7); Parameters `$column` column `$expression` expression `$value` value Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `whereRaw( string $expr )` Add raw expression into WHERE. ATTENTION! Danger, you should escape the query yourself! Add raw expression into WHERE. ATTENTION! Danger, you should escape the query yourself! // WHERE `a1` > 2 $Core_QueryBuilder_Select->whereRaw("`a1` > 2"); Parameters `$expr` expression Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `whereColumn( string $column1, string $expression, string $column2 )` Verify two columns Verify two columns // WHERE `a1` = `a2` $Core_QueryBuilder_Select->whereColumn('a1', '=', 'a2'); Parameters `$column1` first column `$expression` expression `$column2` second column Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `orWhereColumn( string $column1, string $expression, string $column2 )` Set OR and verify two columns Set OR and verify two columns // WHERE ... OR `a1` = `a2` $Core_QueryBuilder_Select->orWhereColumn('a1', '=', 'a2'); Parameters `$column1` first column `$expression` expression `$column2` second column Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `whereBetween( string $column, string $from, string $to )` Add WHERE $column BETWEEN x AND y Add WHERE $column BETWEEN x AND y // WHERE `a7` BETWEEN 1 AND 10 $Core_QueryBuilder_Select->whereBetween('a7', 1, 10); Parameters `$column` column `$from` `$to` Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `orWhereBetween( string $column, string $from, string $to )` Add OR and WHERE $column BETWEEN x AND y Add OR and WHERE $column BETWEEN x AND y // WHERE ... OR `a7` BETWEEN 1 AND 10 $Core_QueryBuilder_Select->orWhereBetween('a7', 1, 10); Parameters `$column` column `$from` `$to` Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `whereNotBetween( string $column, string $from, string $to )` Add WHERE $column NOT BETWEEN x AND y Add WHERE $column NOT BETWEEN x AND y // WHERE `a7` NOT BETWEEN 1 AND 10 $Core_QueryBuilder_Select->whereNotBetween('a7', 1, 10); Parameters `$column` column `$from` `$to` Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `orWhereNotBetween( string $column, string $from, string $to )` Add OR and WHERE $column NOT BETWEEN x AND y Add OR and WHERE $column NOT BETWEEN x AND y // WHERE ... OR `a7` NOT BETWEEN 1 AND 10 $Core_QueryBuilder_Select->orWhereNotBetween('a7', 1, 10); Parameters `$column` column `$from` `$to` Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `whereIn( string $column, array $value )` Add WHERE $column IN (x, y) Add WHERE $column IN (x, y) // WHERE `a7` IN (1, 2, 'aaa') $Core_QueryBuilder_Select->whereIn('a7', array(1, 2, 'aaa')); Parameters `$column` column `$value` value Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `orWhereIn( string $column, array $value )` Add OR and WHERE $column IN (x, y) Add OR and WHERE $column IN (x, y) // WHERE ... OR `a7` IN (1, 2, 'aaa') $Core_QueryBuilder_Select->orWhereIn('a7', array(1, 2, 'aaa')); Parameters `$column` column `$value` value Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `whereNotIn( string $column, array $value )` Add WHERE $column NOT IN (x, y) Add WHERE $column NOT IN (x, y) // WHERE `a7` NOT IN (1, 2, 'aaa') $Core_QueryBuilder_Select->whereNotIn('a7', array(1, 2, 'aaa')); Parameters `$column` column `$value` value Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `orWhereNotIn( string $column, array $value )` Add OR and WHERE $column NOT IN (x, y) Add OR and WHERE $column NOT IN (x, y) // WHERE ... OR `a7` NOT IN (1, 2, 'aaa') $Core_QueryBuilder_Select->orWhereNotIn('a7', array(1, 2, 'aaa')); Parameters `$column` column `$value` value Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `whereIsNull( string $column )` Add WHERE $column IS NULL Add WHERE $column IS NULL // WHERE `a1` IS NULL $Core_QueryBuilder_Select->whereIsNull('a1'); Parameters `$column` column Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `orWhereIsNull( string $column )` Add OR and WHERE $column IS NULL Add OR and WHERE $column IS NULL // WHERE `a1` IS NULL OR `a2` IS NULL $Core_QueryBuilder_Select->whereIsNull('a1')->orWhereIsNull('a2'); Parameters `$column` column Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `whereIsNotNull( string $column )` Add WHERE $column IS NOT NULL Add WHERE $column IS NOT NULL // WHERE `a2` IS NOT NULL $Core_QueryBuilder_Select->whereIsNotNull('a2'); Parameters `$column` column Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `orWhereIsNotNull( string $column )` Add OR and WHERE $column IS NOT NULL Add OR and WHERE $column IS NOT NULL // WHERE `a1` IS NOT NULL $Core_QueryBuilder_Select->orWhereIsNotNull('a1'); Parameters `$column` column Returns `Core_QueryBuilder_Selection`
`protected string`	# `_buildExpression( array $aConditions )` Build WHERE or HAVING expression Build WHERE or HAVING expression Parameters `$aConditions` list of conditions Returns string The SQL query See `Core_QueryBuilder_Selection::_buildWhere()`
`protected string`	# `_buildWhere( string $column, string $expression, string $value )` Build expression for one condition Build expression for one condition Parameters `$column` column `$expression` expression `$value` value Returns string The SQL query See `Core_QueryBuilder_Selection::_buildExpression()`
`public Core_QueryBuilder_Selection`	# `orderBy( string $column, string $direction = 'ASC', boolean $binary = FALSE )` Set order column and direction Set order column and direction http://dev.mysql.com/doc/refman/5.7/en/sorting-rows.html // ORDER BY `field1` ASC $Core_QueryBuilder_Select->orderBy('field1'); // ORDER BY `field1` DESC $Core_QueryBuilder_Select->orderBy('field1', 'DESC'); // ORDER BY BINARY `field1` DESC $Core_QueryBuilder_Select->orderBy('field1', 'DESC', TRUE); // ORDER BY `field2` RAND() $Core_QueryBuilder_Select->orderBy('field1', 'RAND()'); Parameters `$column` column `$direction` sorting direction `$binary` binary option Returns `Core_QueryBuilder_Selection`
`public`	# `order( string $column, string $direction = 'ASC', boolean $binary = FALSE )` Order options Order options Parameters `$column` column `$direction` sorting direction `$binary` binary option See `Core_QueryBuilder_Selection::orderBy()`
`public Core_QueryBuilder_Selection`	# `orderByRaw( string $expr )` Add raw expression into ORDER BY. ATTENTION! Danger, you should escape the query yourself! Add raw expression into ORDER BY. ATTENTION! Danger, you should escape the query yourself! // ORDER BY `field1` + `field2` ASC $Core_QueryBuilder_Select->orderByRaw('`field1` + `field2` ASC'); Parameters `$expr` expression Returns `Core_QueryBuilder_Selection`
`protected string`	# `_buildOrderBy( array $aOrderBy )` Build ORDER BY expression Build ORDER BY expression Parameters `$aOrderBy` Returns string The SQL query
`public Core_QueryBuilder_Selection`	# `limit( integer $arg1, integer $arg2 = NULL )` Set limit and offset Set limit and offset // LIMIT 10 $Core_QueryBuilder_Select->limit(10); // LIMIT 10 OFFSET 0 $Core_QueryBuilder_Select->limit(0, 10); Parameters `$arg1` offset `$arg2` limit Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `offset( integer $offset )` Set offset Set offset // OFFSET 10 $Core_QueryBuilder_Select->offset(10); Parameters `$offset` offset Returns `Core_QueryBuilder_Selection`
`public array`	# `getOrderBy( )` Get ORDER BY Get ORDER BY Returns array
`public Core_QueryBuilder_Selection`	# `clearOrderBy( )` Clear ORDER BY Clear ORDER BY Returns `Core_QueryBuilder_Selection`
`public array`	# `getWhere( )` Get WHERE Get WHERE Returns array
`public Core_QueryBuilder_Selection`	# `clearWhere( )` Clear WHERE list Clear WHERE list Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `clearIndexHints( )` Clear Index Hints Clear Index Hints Returns `Core_QueryBuilder_Selection`
`public array`	# `getJoin( )` Get JOIN Get JOIN Returns array
`public Core_QueryBuilder_Selection`	# `clearJoin( )` Clear JOIN Clear JOIN Returns `Core_QueryBuilder_Selection`
`public Core_QueryBuilder_Selection`	# `clear( )` Clear Clear Returns `Core_QueryBuilder_Selection`

Methods inherited from Core_QueryBuilder_Statement

__call(), __set(), _isObjectSelect(), _quoteColumns(), _quoteValues(), build(), clearLimit(), clearOffset(), execute(), setDataBase(), unbuffered()

Properties summary

`protected array`	`$_where` WHERE WHERE	# `array()`
`protected string`	`$_operator` Current operator Current operator	# `''`
`protected string`	`$_defaultOperator` Default operator between conditions Default operator between conditions	# `'AND'`
`protected array`	`$_partition` PARTITION PARTITION	# `array()`
`protected array`	`$_indexHints` Index Hints Index Hints	# `array()`
`protected array`	`$_join` JOIN JOIN	# `array()`
`protected array`	`$_orderBy` ORDER BY ORDER BY	# `array()`
`protected mixed`	`$_limit` LIMIT LIMIT	# `NULL`
`protected mixed`	`$_offset` OFFSET OFFSET	# `NULL`

Properties inherited from Core_QueryBuilder_Statement

$_dataBase, $_unbuffered

Classes

Exceptions

Functions

Class Core_QueryBuilder_Selection

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Overrides

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns