Inheritance diagram for Select:

Public Member Functions
	__construct (\Magento\Framework\DB\Adapter\Pdo\Mysql $adapter, \Magento\Framework\DB\Select\SelectRenderer $selectRenderer, $parts=[])

	where ($cond, $value=null, $type=null)

	resetJoinLeft ()

	limit ($count=null, $offset=null)

	crossUpdateFromSelect ($table)

	insertFromSelect ($tableName, $fields=[], $onDuplicate=true)

	insertIgnoreFromSelect ($tableName, $fields=[])

	deleteFromSelect ($table)

	setPart ($part, $value)

	useStraightJoin ($flag=true)

	orderRand ($field=null)

	exists ($select, $joinCondition, $isExists=true)

	getConnection ()

	assemble ()

	__sleep ()

	__wakeup ()

Public Member Functions inherited from Zend_Db_Select
	__construct (Zend_Db_Adapter_Abstract $adapter)

	getBind ()

	bind ($bind)

	distinct ($flag=true)

	from ($name, $cols=' *', $schema=null)

	columns ($cols=' *', $correlationName=null)

	union ($select=array(), $type=self::SQL_UNION)

	join ($name, $cond, $cols=self::SQL_WILDCARD, $schema=null)

	joinInner ($name, $cond, $cols=self::SQL_WILDCARD, $schema=null)

	joinLeft ($name, $cond, $cols=self::SQL_WILDCARD, $schema=null)

	joinRight ($name, $cond, $cols=self::SQL_WILDCARD, $schema=null)

	joinFull ($name, $cond, $cols=self::SQL_WILDCARD, $schema=null)

	joinCross ($name, $cols=self::SQL_WILDCARD, $schema=null)

	joinNatural ($name, $cols=self::SQL_WILDCARD, $schema=null)

	where ($cond, $value=null, $type=null)

	orWhere ($cond, $value=null, $type=null)

	group ($spec)

	having ($cond, $value=null, $type=null)

	orHaving ($cond, $value=null, $type=null)

	order ($spec)

	limit ($count=null, $offset=null)

	limitPage ($page, $rowCount)

	forUpdate ($flag=true)

	getPart ($part)

	query ($fetchMode=null, $bind=array())

	assemble ()

	reset ($part=null)

	getAdapter ()

	_joinUsing ($type, $name, $cond, $cols=' *', $schema=null)

	__call ($method, array $args)

	__toString ()

Data Fields
const	TYPE_CONDITION = 'TYPE_CONDITION'

const	STRAIGHT_JOIN = 'straightjoin'

const	SQL_STRAIGHT_JOIN = 'STRAIGHT_JOIN'

Data Fields inherited from Zend_Db_Select
const	DISTINCT = 'distinct'

const	COLUMNS = 'columns'

const	FROM = 'from'

const	UNION = 'union'

const	WHERE = 'where'

const	GROUP = 'group'

const	HAVING = 'having'

const	ORDER = 'order'

const	LIMIT_COUNT = 'limitcount'

const	LIMIT_OFFSET = 'limitoffset'

const	FOR_UPDATE = 'forupdate'

const	INNER_JOIN = 'inner join'

const	LEFT_JOIN = 'left join'

const	RIGHT_JOIN = 'right join'

const	FULL_JOIN = 'full join'

const	CROSS_JOIN = 'cross join'

const	NATURAL_JOIN = 'natural join'

const	SQL_WILDCARD = '*'

const	SQL_SELECT = 'SELECT'

const	SQL_UNION = 'UNION'

const	SQL_UNION_ALL = 'UNION ALL'

const	SQL_FROM = 'FROM'

const	SQL_WHERE = 'WHERE'

const	SQL_DISTINCT = 'DISTINCT'

const	SQL_GROUP_BY = 'GROUP BY'

const	SQL_ORDER_BY = 'ORDER BY'

const	SQL_HAVING = 'HAVING'

const	SQL_FOR_UPDATE = 'FOR UPDATE'

const	SQL_AND = 'AND'

const	SQL_AS = 'AS'

const	SQL_OR = 'OR'

const	SQL_ON = 'ON'

const	SQL_ASC = 'ASC'

const	SQL_DESC = 'DESC'

const	REGEX_COLUMN_EXPR = '/^([\w]\s$([^\($]\|(?1))*\))$/'

const	REGEX_COLUMN_EXPR_ORDER = '/^([\w]+\s$([^\($]\|(?1))\))$/'

const	REGEX_COLUMN_EXPR_GROUP = '/^([\w]+\s$([^\($]\|(?1))\))$/'

const	REGEX_SQL_COMMENTS

Protected Member Functions
	_resetJoinLeft ()

	_findTableInCond ($table, $cond)

	_join ($type, $name, $cond, $cols, $schema=null)

	_renderStraightjoin ($sql)

	_tableCols ($correlationName, $cols, $afterCorrelationName=null)

	_renderForupdate ($sql)

Protected Member Functions inherited from Zend_Db_Select
	_join ($type, $name, $cond, $cols, $schema=null)

	_tableCols ($correlationName, $cols, $afterCorrelationName=null)

	_where ($condition, $value=null, $type=null, $bool=true)

	_getDummyTable ()

	_getQuotedSchema ($schema=null)

	_getQuotedTable ($tableName, $correlationName=null)

	_renderDistinct ($sql)

	_renderColumns ($sql)

	_renderFrom ($sql)

	_renderUnion ($sql)

	_renderWhere ($sql)

	_renderGroup ($sql)

	_renderHaving ($sql)

	_renderOrder ($sql)

	_renderLimitoffset ($sql)

	_renderForupdate ($sql)

Additional Inherited Members
Protected Attributes inherited from Zend_Db_Select
	$_bind = array()

	$_adapter

	$_parts = array()

	$_tableCols = array()

Static Protected Attributes inherited from Zend_Db_Select
static	$_partsInit

static	$_joinTypes

static	$_unionTypes

Detailed Description

Class for SQL SELECT generation and results.

@api @method \Magento\Framework\DB\Select from($name, $cols = '*', $schema = null) @method \Magento\Framework\DB\Select join($name, $cond, $cols = '*', $schema = null) @method \Magento\Framework\DB\Select joinInner($name, $cond, $cols = '*', $schema = null) @method \Magento\Framework\DB\Select joinLeft($name, $cond, $cols = '*', $schema = null) @method \Magento\Framework\DB\Select joinNatural($name, $cond, $cols = '*', $schema = null) @method \Magento\Framework\DB\Select joinFull($name, $cond, $cols = '*', $schema = null) @method \Magento\Framework\DB\Select joinRight($name, $cond, $cols = '*', $schema = null) @method \Magento\Framework\DB\Select joinCross($name, $cols = '*', $schema = null) @method \Magento\Framework\DB\Select orWhere($cond, $value = null, $type = null) @method \Magento\Framework\DB\Select group($spec) @method \Magento\Framework\DB\Select order($spec) @method \Magento\Framework\DB\Select limitPage($page, $rowCount) @method \Magento\Framework\DB\Select forUpdate($flag = true) @method \Magento\Framework\DB\Select distinct($flag = true) @method \Magento\Framework\DB\Select reset($part = null) @method \Magento\Framework\DB\Select columns($cols = '*', $correlationName = null)

Since: 100.0.2

Definition at line 33 of file Select.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\DB\Adapter\Pdo\Mysql	$adapter,
		\Magento\Framework\DB\Select\SelectRenderer	$selectRenderer,
			$parts = `[]`
	)

Class constructor Add straight join support

Parameters

Adapter\Pdo\Mysql	$adapter
Select\SelectRenderer	$selectRenderer
array	$parts

Definition at line 63 of file Select.php.

       {
         self::$_partsInit = array_merge(self::$_partsInit, $parts);
         if (!isset(self::$_partsInit[self::STRAIGHT_JOIN])) {
             self::$_partsInit = [self::STRAIGHT_JOIN => false] + self::$_partsInit;
         }
 
         $this->selectRenderer = $selectRenderer;
         parent::__construct($adapter);
     }

Member Function Documentation

◆ __sleep()

__sleep ( )

Returns: string[]

Since: 100.0.11

Definition at line 516 of file Select.php.

     {
         $properties = array_keys(get_object_vars($this));
         $properties = array_diff(
             $properties,
             [
                 '_adapter',
                 'selectRenderer'
             ]
         );
         return $properties;
     }

◆ __wakeup()

__wakeup ( )

Init not serializable fields

Returns: void

Since: 100.0.11

Definition at line 535 of file Select.php.

     {
         $objectManager = \Magento\Framework\App\ObjectManager::getInstance();
         $this->_adapter = $objectManager->get(ResourceConnection::class)->getConnection();
         $this->selectRenderer = $objectManager->get(\Magento\Framework\DB\Select\SelectRenderer::class);
     }

◆ _findTableInCond()

_findTableInCond	(	$table,
		$cond
	)

protected

Find table name in condition (where, column)

Parameters

string	$table
string	$cond

Returns: bool

Definition at line 241 of file Select.php.

     {
         $quote = $this->_adapter->getQuoteIdentifierSymbol();
 
         if (strpos($cond, $quote . $table . $quote . '.') !== false) {
             return true;
         }
 
         $position = 0;
         $result = 0;
         $needle = [];
         while (is_integer($result)) {
             $result = strpos($cond, $table . '.', $position);
 
             if (is_integer($result)) {
                 $needle[] = $result;
                 $position = $result + strlen($table) + 1;
             }
         }
 
         if (!$needle) {
             return false;
         }
 
         foreach ($needle as $position) {
             if ($position == 0) {
                 return true;
             }
             if (!preg_match('#[a-z0-9_]#is', substr($cond, $position - 1, 1))) {
                 return true;
             }
         }
 
         return false;
     }

◆ _join()

_join	(	$type,
		$name,
		$cond,
		$cols,
		$schema = `null`
	)

protected

Populate the $_parts 'join' key

Does the dirty work of populating the join key.

The $name and $cols parameters follow the same logic as described in the from() method.

Parameters

null \| string	$type	Type of join; inner, left, and null are currently supported
array \| string \| \Zend_Db_Expr	$name	Table name
string	$cond	Join on this condition
array \| string	$cols	The columns to select from the joined table
string	$schema	The database name to specify, if any.

Returns: \Magento\Framework\DB\Select This \Magento\Framework\DB\Select object

Exceptions

Definition at line 293 of file Select.php.

     {
         if ($type == self::INNER_JOIN && empty($cond)) {
             $type = self::CROSS_JOIN;
         }
         return parent::_join($type, $name, $cond, $cols, $schema);
     }

◆ _renderForupdate()

_renderForupdate ( $sql )

protected

Render FOR UPDATE clause

Parameters

string $sql SQL query

Returns: string

Definition at line 459 of file Select.php.

     {
         if ($this->_parts[self::FOR_UPDATE]) {
             $sql = $this->_adapter->forUpdate($sql);
         }
 
         return $sql;
     }

◆ _renderStraightjoin()

_renderStraightjoin ( $sql )

protected

Render STRAIGHT_JOIN clause

Parameters

string $sql SQL query

Returns: string

Definition at line 407 of file Select.php.

     {
         if ($this->_adapter->supportStraightJoin() && !empty($this->_parts[self::STRAIGHT_JOIN])) {
             $sql .= ' ' . self::SQL_STRAIGHT_JOIN;
         }
 
         return $sql;
     }

◆ _resetJoinLeft()

_resetJoinLeft ( )

protected

Validate LEFT joins, and remove it if not exists

Returns: $this

Definition at line 208 of file Select.php.

     {
         foreach ($this->_parts[self::FROM] as $tableId => $tableProp) {
             if ($tableProp['joinType'] == self::LEFT_JOIN) {
                 if ($tableProp['useInCond']) {
                     continue;
                 }
 
                 $used = false;
                 foreach ($tableProp['joinInTables'] as $table) {
                     if (isset($this->_parts[self::FROM][$table])) {
                         $used = true;
                         break;
                     }
                 }
 
                 if (!$used) {
                     unset($this->_parts[self::FROM][$tableId]);
                     return $this->_resetJoinLeft();
                 }
             }
         }
 
         return $this;
     }

◆ _tableCols()

_tableCols	(	$correlationName,
		$cols,
		$afterCorrelationName = `null`
	)

protected

Adds to the internal table-to-column mapping array.

Parameters

string	$correlationName	The table/join the columns come from.
array \| string	$cols	The list of columns; preferably as an array, but possibly as a string containing one column.
bool \| string	$afterCorrelationName	True if it should be prepended, a correlation name if it should be inserted

Returns: void

Definition at line 426 of file Select.php.

     {
         if (!is_array($cols)) {
             $cols = [$cols];
         }
 
         foreach ($cols as $k => $v) {
             if ($v instanceof Select) {
                 $cols[$k] = new \Zend_Db_Expr(sprintf('(%s)', $v->assemble()));
             }
         }
 
         return parent::_tableCols($correlationName, $cols, $afterCorrelationName);
     }

◆ assemble()

assemble ( )

Converts this object to an SQL SELECT string.

Returns: string|null This object as a SELECT string. (or null if a string cannot be produced.)

Since: 100.1.0

Definition at line 507 of file Select.php.

     {
         return $this->selectRenderer->render($this);
     }

◆ crossUpdateFromSelect()

crossUpdateFromSelect ( $table )

Cross Table Update From Current select

Parameters

string | array $table

Returns: string

Definition at line 329 of file Select.php.

     {
         return $this->getConnection()->updateFromSelect($this, $table);
     }

◆ deleteFromSelect()

deleteFromSelect ( $table )

Retrieve DELETE query from select

Parameters

string $table The table name or alias

Returns: string

Definition at line 366 of file Select.php.

     {
         return $this->getConnection()->deleteFromSelect($this, $table);
     }

◆ exists()

exists	(	$select,
		$joinCondition,
		$isExists = `true`
	)

Add EXISTS clause

Parameters

Select	$select
string	$joinCondition
bool	$isExists

Returns: $this

Definition at line 476 of file Select.php.

     {
         if ($isExists) {
             $exists = 'EXISTS (%s)';
         } else {
             $exists = 'NOT EXISTS (%s)';
         }
         $select->reset(self::COLUMNS)->columns([new \Zend_Db_Expr('1')])->where($joinCondition);
 
         $exists = sprintf($exists, $select->assemble());
 
         $this->where($exists);
         return $this;
     }

◆ getConnection()

getConnection ( )

Get adapter

Returns: \Magento\Framework\DB\Adapter\AdapterInterface

Definition at line 496 of file Select.php.

     {
         return $this->_adapter;
     }

◆ insertFromSelect()

insertFromSelect	(	$tableName,
		$fields = `[]`,
		$onDuplicate = `true`
	)

Insert to table from current select

Parameters

string	$tableName
array	$fields
bool	$onDuplicate

Returns: string

Definition at line 342 of file Select.php.

     {
         $mode = $onDuplicate ? AdapterInterface::INSERT_ON_DUPLICATE : false;
         return $this->getConnection()->insertFromSelect($this, $tableName, $fields, $mode);
     }

◆ insertIgnoreFromSelect()

insertIgnoreFromSelect	(	$tableName,
		$fields = `[]`
	)

Generate INSERT IGNORE query to the table from current select

Parameters

string	$tableName
array	$fields

Returns: string

Definition at line 355 of file Select.php.

     {
         return $this->getConnection()->insertFromSelect($this, $tableName, $fields, AdapterInterface::INSERT_IGNORE);
     }

◆ limit()

limit	(	$count = `null`,
		$offset = `null`
	)

Sets a limit count and offset to the query.

Parameters

int	$count	OPTIONAL The number of rows to return.
int	$offset	OPTIONAL Start returning after this many rows.

Returns: $this

Definition at line 308 of file Select.php.

     {
         if ($count === null) {
             $this->reset(self::LIMIT_COUNT);
         } else {
             $this->_parts[self::LIMIT_COUNT] = (int)$count;
         }
         if ($offset === null) {
             $this->reset(self::LIMIT_OFFSET);
         } else {
             $this->_parts[self::LIMIT_OFFSET] = (int)$offset;
         }
         return $this;
     }

◆ orderRand()

orderRand ( $field = null )

Adds the random order to query

Parameters

string $field integer field name

Returns: $this

Definition at line 447 of file Select.php.

     {
         $this->_adapter->orderRand($this, $field);
         return $this;
     }

◆ resetJoinLeft()

resetJoinLeft ( )

Reset unused LEFT JOIN(s)

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 130 of file Select.php.

     {
         foreach ($this->_parts[self::FROM] as $tableId => $tableProp) {
             if ($tableProp['joinType'] == self::LEFT_JOIN) {
                 $useJoin = false;
                 foreach ($this->_parts[self::COLUMNS] as $columnEntry) {
                     list($correlationName, $column) = $columnEntry;
                     if ($column instanceof \Zend_Db_Expr) {
                         if ($this->_findTableInCond(
                             $tableId,
                             $column
                         ) || $this->_findTableInCond(
                             $tableProp['tableName'],
                             $column
                         )
                         ) {
                             $useJoin = true;
                         }
                     } else {
                         if ($correlationName == $tableId) {
                             $useJoin = true;
                         }
                     }
                 }
                 foreach ($this->_parts[self::WHERE] as $where) {
                     if ($this->_findTableInCond(
                         $tableId,
                         $where
                     ) || $this->_findTableInCond(
                         $tableProp['tableName'],
                         $where
                     )
                     ) {
                         $useJoin = true;
                     }
                 }
 
                 $joinUseInCond = $useJoin;
                 $joinInTables = [];
 
                 foreach ($this->_parts[self::FROM] as $tableCorrelationName => $table) {
                     if ($tableCorrelationName == $tableId) {
                         continue;
                     }
                     if (!empty($table['joinCondition'])) {
                         if ($this->_findTableInCond(
                             $tableId,
                             $table['joinCondition']
                         ) || $this->_findTableInCond(
                             $tableProp['tableName'],
                             $table['joinCondition']
                         )
                         ) {
                             $useJoin = true;
                             $joinInTables[] = $tableCorrelationName;
                         }
                     }
                 }
 
                 if (!$useJoin) {
                     unset($this->_parts[self::FROM][$tableId]);
                 } else {
                     $this->_parts[self::FROM][$tableId]['useInCond'] = $joinUseInCond;
                     $this->_parts[self::FROM][$tableId]['joinInTables'] = $joinInTables;
                 }
             }
         }
 
         $this->_resetJoinLeft();
 
         return $this;
     }

◆ setPart()

setPart	(	$part,
		$value
	)

Modify (hack) part of the structured information for the current query

Parameters

string	$part
mixed	$value

Returns: $this

Exceptions

Definition at line 379 of file Select.php.

     {
         $part = strtolower($part);
         if (!array_key_exists($part, $this->_parts)) {
             throw new \Zend_Db_Select_Exception("Invalid Select part '{$part}'");
         }
         $this->_parts[$part] = $value;
         return $this;
     }

◆ useStraightJoin()

useStraightJoin ( $flag = true )

Use a STRAIGHT_JOIN for the SQL Select

Parameters

bool $flag Whether or not the SELECT use STRAIGHT_JOIN (default true).

Returns: $this

Definition at line 395 of file Select.php.

     {
         $this->_parts[self::STRAIGHT_JOIN] = (bool)$flag;
         return $this;
     }

◆ where()

where	(	$cond,
		$value = `null`,
		$type = `null`
	)

Adds a WHERE condition to the query by AND.

If a value is passed as the second param, it will be quoted and replaced into the condition wherever a question-mark appears. Array values are quoted and comma-separated.

// simplest but non-secure $select->where("id = $id");

// secure (ID is quoted but matched anyway) $select->where('id = ?', $id);

// alternatively, with named binding $select->where('id = :id');

Note that it is more correct to use named bindings in your queries for values other than strings. When you use named bindings, don't forget to pass the values when actually making a query:

$db->fetchAll($select, array('id' => 5));

Parameters

string	$cond	The WHERE condition.
string	$value	OPTIONAL A single value to quote into the condition.
string \| int \| null	$type	OPTIONAL The type of the given value

Returns: \Magento\Framework\DB\Select

Definition at line 109 of file Select.php.

     {
         if ($value === null && $type === null) {
             $value = '';
         } elseif ($type == self::TYPE_CONDITION) {
             $type = null;
         }
         if (is_array($value)) {
             $cond = $this->getConnection()->quoteInto($cond, $value);
             $value = null;
         }
         return parent::where($cond, $value, $type);
     }

Field Documentation

◆ SQL_STRAIGHT_JOIN

const SQL_STRAIGHT_JOIN = 'STRAIGHT_JOIN'

Sql straight join

Definition at line 48 of file Select.php.

◆ STRAIGHT_JOIN

const STRAIGHT_JOIN = 'straightjoin'

Straight join key

Definition at line 43 of file Select.php.

◆ TYPE_CONDITION

const TYPE_CONDITION = 'TYPE_CONDITION'

Condition type

Definition at line 38 of file Select.php.

The documentation for this class was generated from the following file:

vendor/magento/framework/DB/Select.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __sleep()

◆ __wakeup()

◆ _findTableInCond()

◆ _join()

◆ _renderForupdate()

◆ _renderStraightjoin()

◆ _resetJoinLeft()

◆ _tableCols()

◆ assemble()

◆ crossUpdateFromSelect()

◆ deleteFromSelect()

◆ exists()

◆ getConnection()

◆ insertFromSelect()

◆ insertIgnoreFromSelect()

◆ limit()

◆ orderRand()

◆ resetJoinLeft()

◆ setPart()

◆ useStraightJoin()

◆ where()

Field Documentation

◆ SQL_STRAIGHT_JOIN

◆ STRAIGHT_JOIN

◆ TYPE_CONDITION