Zend Framework
Back to top  

 Methods

__clone

__clone() : void

Resets the where object each time the Select is cloned.

Constructor

__construct(null | string | array | \Zend\Db\Sql\TableIdentifier $table) 

Parameters

$table

nullstringarray\Zend\Db\Sql\TableIdentifier

Variable overloading

__get(string $name) : mixed

Parameters

$name

string

Exceptions

\Zend\Db\Sql\Exception\InvalidArgumentException

Returns

mixed

Specify columns from which to select

columns(array $columns, bool $prefixColumnsWithTable) : \Zend\Db\Sql\Select

Possible valid states:

array(*)

array(value, ...) value can be strings or Expression objects

array(string => value, ...) key string will be use as alias, value can be string or Expression objects

Parameters

$columns

array

$prefixColumnsWithTable

bool

Returns

\Zend\Db\Sql\Select

combine() 

combine(\Zend\Db\Sql\Select $select, string $type, string $modifier) : \Zend\Db\Sql\Select

Parameters

$select

\Zend\Db\Sql\Select

$type

string

$modifier

string

Exceptions

\Zend\Db\Sql\Exception\InvalidArgumentException

Returns

\Zend\Db\Sql\Select

Create from clause

from(string | array | \Zend\Db\Sql\TableIdentifier $table) : \Zend\Db\Sql\Select

Parameters

$table

stringarray\Zend\Db\Sql\TableIdentifier

Exceptions

\Zend\Db\Sql\Exception\InvalidArgumentException

Returns

\Zend\Db\Sql\Select

getRawState() 

getRawState($key) 

Parameters

$key

Get SQL string for statement

getSqlString(\Zend\Db\Adapter\Platform\PlatformInterface $adapterPlatform) : string
Inherited

inherited_from \Zend\Db\Sql\AbstractSql::getSqlString()
inherited_from \Zend\Db\Sql\AbstractPreparableSql::getSqlString()

Parameters

$adapterPlatform

null\Zend\Db\Adapter\Platform\PlatformInterface

Returns

string

group() 

group($group) 

Parameters

$group

Create where clause

having(\Zend\Db\Sql\Where | \Closure | string | array $predicate, string $combination) : \Zend\Db\Sql\Select

Parameters

$predicate

\Zend\Db\Sql\Where\Closurestringarray

$combination

string

One of the OP_* constants from Predicate\PredicateSet

Returns

\Zend\Db\Sql\Select

Returns whether the table is read only or not.

isTableReadOnly() : bool

Returns

bool

Create join clause

join(string | array $name, string $on, string | array $columns, string $type) : \Zend\Db\Sql\Select

Parameters

$name

stringarray

$on

string

$columns

stringarray

$type

string

one of the JOIN_* constants

Exceptions

\Zend\Db\Sql\Exception\InvalidArgumentException

Returns

\Zend\Db\Sql\Select

limit() 

limit(int $limit) : \Zend\Db\Sql\Select

Parameters

$limit

int

Returns

\Zend\Db\Sql\Select

offset() 

offset(int $offset) : \Zend\Db\Sql\Select

Parameters

$offset

int

Returns

\Zend\Db\Sql\Select

order() 

order(string | array $order) : \Zend\Db\Sql\Select

Parameters

$order

stringarray

Returns

\Zend\Db\Sql\Select

prepareStatement() 

prepareStatement(\Zend\Db\Adapter\AdapterInterface $adapter, \Zend\Db\Adapter\StatementContainerInterface $statementContainer) : \Zend\Db\Adapter\StatementContainerInterface
Inherited

inherited_from \Zend\Db\Sql\AbstractPreparableSql::prepareStatement()

Parameters

$adapter

\Zend\Db\Adapter\AdapterInterface

$statementContainer

\Zend\Db\Adapter\StatementContainerInterface

Returns

\Zend\Db\Adapter\StatementContainerInterface

quantifier() 

quantifier(string | \Zend\Db\Sql\Expression $quantifier) : \Zend\Db\Sql\Select

Parameters

$quantifier

string\Zend\Db\Sql\Expression

DISTINCT|ALL

Returns

\Zend\Db\Sql\Select

reset() 

reset(string $part) : \Zend\Db\Sql\Select

Parameters

$part

string

Exceptions

\Zend\Db\Sql\Exception\InvalidArgumentException

Returns

\Zend\Db\Sql\Select

setSpecification() 

setSpecification($index, $specification) 

Parameters

$index

$specification

Create where clause

where(\Zend\Db\Sql\Where | \Closure | string | array | \Zend\Db\Sql\Predicate\PredicateInterface $predicate, string $combination) : \Zend\Db\Sql\Select

Parameters

$predicate

\Zend\Db\Sql\Where\Closurestringarray\Zend\Db\Sql\Predicate\PredicateInterface

$combination

string

One of the OP_* constants from Predicate\PredicateSet

Exceptions

\Zend\Db\Sql\Exception\InvalidArgumentException

Returns

\Zend\Db\Sql\Select

buildSqlString() 

buildSqlString(\Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) : string
Inherited

inherited_from \Zend\Db\Sql\AbstractSql::buildSqlString()
inherited_from \Zend\Db\Sql\AbstractPreparableSql::buildSqlString()

Parameters

$platform

\Zend\Db\Adapter\Platform\PlatformInterface

$driver

null\Zend\Db\Adapter\Driver\DriverInterface

$parameterContainer

null\Zend\Db\Adapter\ParameterContainer

Returns

string

createSqlFromSpecificationAndParameters() 

createSqlFromSpecificationAndParameters(string | array $specifications, string | array $parameters) : string
Inherited

inherited_from \Zend\Db\Sql\AbstractSql::createSqlFromSpecificationAndParameters()
inherited_from \Zend\Db\Sql\AbstractPreparableSql::createSqlFromSpecificationAndParameters()

Parameters

$specifications

stringarray

$parameters

stringarray

Exceptions

\Zend\Db\Sql\Exception\RuntimeException

Returns

string

Copy variables from the subject into the local properties

localizeVariables() 
Inherited

inherited_from \Zend\Db\Sql\AbstractSql::localizeVariables()
inherited_from \Zend\Db\Sql\AbstractPreparableSql::localizeVariables()

processCombine() 

processCombine(\Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) 

Parameters

$platform

$driver

$parameterContainer

processExpression() 

processExpression(\Zend\Db\Sql\ExpressionInterface $expression, \Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer, null | string $namedParameterPrefix) : string
Inherited

staticvar int $runtimeExpressionPrefix
inherited_from \Zend\Db\Sql\AbstractSql::processExpression()
inherited_from \Zend\Db\Sql\AbstractPreparableSql::processExpression()

Parameters

$expression

\Zend\Db\Sql\ExpressionInterface

$platform

\Zend\Db\Adapter\Platform\PlatformInterface

$driver

null\Zend\Db\Adapter\Driver\DriverInterface

$parameterContainer

null\Zend\Db\Adapter\ParameterContainer

$namedParameterPrefix

nullstring

Exceptions

\Zend\Db\Sql\Exception\RuntimeException

Returns

string

processGroup() 

processGroup(\Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) 

Parameters

$platform

$driver

$parameterContainer

processHaving() 

processHaving(\Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) 

Parameters

$platform

$driver

$parameterContainer

processJoins() 

processJoins(\Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) 

Parameters

$platform

$driver

$parameterContainer

processLimit() 

processLimit(\Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) 

Parameters

$platform

$driver

$parameterContainer

processOffset() 

processOffset(\Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) 

Parameters

$platform

$driver

$parameterContainer

processOrder() 

processOrder(\Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) 

Parameters

$platform

$driver

$parameterContainer

Process the select part

processSelect(\Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) : null | array

Parameters

$platform

\Zend\Db\Adapter\Platform\PlatformInterface

$driver

\Zend\Db\Adapter\Driver\DriverInterface

$parameterContainer

\Zend\Db\Adapter\ParameterContainer

Returns

nullarray

processStatementEnd() 

processStatementEnd(\Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) 

Parameters

$platform

$driver

$parameterContainer

processStatementStart() 

processStatementStart(\Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) 

Parameters

$platform

$driver

$parameterContainer

processSubSelect() 

processSubSelect(\Zend\Db\Sql\Select $subselect, \Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) : string
Inherited

inherited_from \Zend\Db\Sql\AbstractSql::processSubSelect()
inherited_from \Zend\Db\Sql\AbstractPreparableSql::processSubSelect()

Parameters

$subselect

\Zend\Db\Sql\Select

$platform

\Zend\Db\Adapter\Platform\PlatformInterface

$driver

null\Zend\Db\Adapter\Driver\DriverInterface

$parameterContainer

null\Zend\Db\Adapter\ParameterContainer

Returns

string

processWhere() 

processWhere(\Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) 

Parameters

$platform

$driver

$parameterContainer

Render table with alias in from/join parts

renderTable(string $table, string $alias) : string

todo move TableIdentifier concatination here

Parameters

$table

string

$alias

string

Returns

string

resolveColumnValue() 

resolveColumnValue(null | array | \Zend\Db\Sql\ExpressionInterface | \Zend\Db\Sql\Select $column, \Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer, null | string $namedParameterPrefix) : string
Inherited

inherited_from \Zend\Db\Sql\AbstractSql::resolveColumnValue()
inherited_from \Zend\Db\Sql\AbstractPreparableSql::resolveColumnValue()

Parameters

$column

nullarray\Zend\Db\Sql\ExpressionInterface\Zend\Db\Sql\Select

$platform

\Zend\Db\Adapter\Platform\PlatformInterface

$driver

null\Zend\Db\Adapter\Driver\DriverInterface

$parameterContainer

null\Zend\Db\Adapter\ParameterContainer

$namedParameterPrefix

nullstring

Returns

string

resolveTable() 

resolveTable(string | \Zend\Db\Sql\TableIdentifier | \Zend\Db\Sql\Select $table, \Zend\Db\Adapter\Platform\PlatformInterface $platform, \Zend\Db\Adapter\Driver\DriverInterface $driver, \Zend\Db\Adapter\ParameterContainer $parameterContainer) : string

Parameters

$table

string\Zend\Db\Sql\TableIdentifier\Zend\Db\Sql\Select

$platform

\Zend\Db\Adapter\Platform\PlatformInterface

$driver

\Zend\Db\Adapter\Driver\DriverInterface

$parameterContainer

\Zend\Db\Adapter\ParameterContainer

Returns

string

 Properties

 

$having

$having : \Zend\Db\Sql\Having

magic
property
 

$where

$where : \Zend\Db\Sql\Where

magic
property
 

$columns

$columns : array

 

$combine

$combine : array

 

$group

$group : null | array

 

$having

$having : null | string | array

 

$instanceParameterIndex

$instanceParameterIndex : array
Inherited

inherited_from \Zend\Db\Sql\AbstractSql::$$instanceParameterIndex
inherited_from \Zend\Db\Sql\AbstractPreparableSql::$$instanceParameterIndex
 

$joins

$joins : array

 

$limit

$limit : int | null

 

$offset

$offset : int | null

 

$order

$order : array

 

$prefixColumnsWithTable

$prefixColumnsWithTable : bool

 

$processInfo

$processInfo : string
Inherited

inherited_from \Zend\Db\Sql\AbstractSql::$$processInfo
inherited_from \Zend\Db\Sql\AbstractPreparableSql::$$processInfo
 

$quantifier

$quantifier : null | string | \Zend\Db\Sql\Expression

 

Specifications for Sql String generation

$specifications : array

 

$table

$table : string | array | \Zend\Db\Sql\TableIdentifier

 

$tableReadOnly

$tableReadOnly : bool

 

$where

$where : \Zend\Db\Sql\Where

 Constants

 

COLUMNS

COLUMNS 

 

COMBINE

COMBINE 

 

COMBINE_EXCEPT

COMBINE_EXCEPT 

 

COMBINE_INTERSECT

COMBINE_INTERSECT 

 

COMBINE_UNION

COMBINE_UNION 

 

GROUP

GROUP 

 

HAVING

HAVING 

 

JOINS

JOINS 

 

JOIN_INNER

JOIN_INNER 

 

JOIN_LEFT

JOIN_LEFT 

 

JOIN_OUTER

JOIN_OUTER 

 

JOIN_OUTER_LEFT

JOIN_OUTER_LEFT 

 

JOIN_OUTER_RIGHT

JOIN_OUTER_RIGHT 

 

JOIN_RIGHT

JOIN_RIGHT 

 

LIMIT

LIMIT 

 

OFFSET

OFFSET 

 

ORDER

ORDER 

 

ORDER_ASCENDING

ORDER_ASCENDING 

 

ORDER_DESCENDING

ORDER_DESCENDING 

 

QUANTIFIER

QUANTIFIER 

 

QUANTIFIER_ALL

QUANTIFIER_ALL 

 

QUANTIFIER_DISTINCT

QUANTIFIER_DISTINCT 

 

SELECT

SELECT 

 

SQL_STAR

SQL_STAR 

 

TABLE

TABLE 

 

WHERE

WHERE