Fr3nch13/CakePHP Utilities

Query
in package

Application

implements ExpressionInterface, IteratorAggregate uses TypeMapTrait

This class represents a Relational database SQL Query. A query can be of different types like select, update, insert and delete. Exposes the methods for dynamically constructing each query part, execute it and transform it to a specific SQL dialect.

Interfaces

ExpressionInterface: An interface used by Expression objects.
IteratorAggregate

Constants

JOIN_TYPE_INNER = 'INNER'
JOIN_TYPE_LEFT = 'LEFT'
JOIN_TYPE_RIGHT = 'RIGHT'

Properties

$_connection : Connection: Connection instance to be used to execute this query.
$_deleteParts : array<string|int, string>: The list of query clauses to traverse for generating a DELETE statement
$_dirty : bool: Indicates whether internal state of this query was changed, this is used to discard internal cached objects such as the transformed query or the reference to the executed statement.
$_functionsBuilder : FunctionsBuilder|null: Instance of functions builder object used for generating arbitrary SQL functions.
$_insertParts : array<string|int, string>: The list of query clauses to traverse for generating an INSERT statement
$_iterator : StatementInterface|null: Statement object resulting from executing this query.
$_parts : array<string, mixed>: List of SQL parts that will be used to build this query.
$_resultDecorators : array<string|int, callable>: A list of callback functions to be called to alter each row from resulting statement upon retrieval. Each one of the callback function will receive the row array as first argument.
$_selectParts : array<string|int, string>: The list of query clauses to traverse for generating a SELECT statement
$_selectTypeMap : TypeMap|null: The Type map for fields in the select clause
$_type : string: Type of this query (select, insert, update, delete).
$_typeMap : TypeMap|null
$_updateParts : array<string|int, string>: The list of query clauses to traverse for generating an UPDATE statement
$_useBufferedResults : bool: Boolean for tracking whether buffered results are enabled.
$_valueBinder : ValueBinder|null: The object responsible for generating query placeholders and temporarily store values associated to each of those.
$typeCastEnabled : bool: Tracking flag to disable casting

Methods

__clone() : void: Handles clearing iterator and cloning all expressions and value binders.
__construct() : mixed: Constructor.
__debugInfo() : array<string, mixed>: Returns an array that can be used to describe the internal state of this object.
__toString() : string: Returns string representation of this query (complete SQL statement).
andHaving() : $this: Connects any previously defined set of conditions to the provided list using the AND operator in the HAVING clause. This method operates in exactly the same way as the method `andWhere()` does. Please refer to its documentation for an insight on how to using each parameter.
andWhere() : $this: Connects any previously defined set of conditions to the provided list using the AND operator. This function accepts the conditions list in the same format as the method `where` does, hence you can use arrays, expression objects callback functions or strings.
bind() : $this: Associates a query placeholder to a value and a type.
clause() : mixed: Returns any data that was stored in the specified clause. This is useful for modifying any internal part of the query and it is used by the SQL dialects to transform the query accordingly before it is executed. The valid clauses that can be retrieved are: delete, update, set, insert, values, select, distinct, from, join, set, where, group, having, order, limit, offset and union.
decorateResults() : $this: Registers a callback to be executed for each result that is fetched from the result set, the callback function will receive as first parameter an array with the raw data from the database for every row that is fetched and must return the row with any possible modifications.
delete() : $this: Create a delete query.
disableBufferedResults() : $this: Disables buffered results.
disableResultsCasting() : $this: Disables result casting.
distinct() : $this: Adds a `DISTINCT` clause to the query to remove duplicates from the result set.
enableBufferedResults() : $this: Enables/Disables buffered results.
enableResultsCasting() : $this: Enables result casting.
epilog() : $this: A string or expression that will be appended to the generated query
execute() : StatementInterface: Compiles the SQL representation of this query and executes it using the configured connection object. Returns the resulting statement object.
expr() : QueryExpression: Returns a new QueryExpression object. This is a handy function when building complex queries using a fluent interface. You can also override this function in subclasses to use a more specialized QueryExpression class if required.
from() : $this: Adds a single or multiple tables to be used in the FROM clause for this query.
func() : FunctionsBuilder: Returns an instance of a functions builder object that can be used for generating arbitrary SQL functions.
getConnection() : Connection: Gets the connection instance to be used for executing and transforming this query.
getDefaultTypes() : array<int|string, string>: Gets default types of current type map.
getIterator() : StatementInterface: Executes this query and returns a results iterator. This function is required for implementing the IteratorAggregate interface and allows the query to be iterated without having to call execute() manually, thus making it look like a result set instead of the query itself.
getSelectTypeMap() : TypeMap: Gets the TypeMap class where the types for each of the fields in the select clause are stored.
getTypeMap() : TypeMap: Returns the existing type map.
getValueBinder() : ValueBinder: Returns the currently used ValueBinder instance.
group() : $this: Adds a single or multiple fields to be used in the GROUP BY clause for this query.
having() : $this: Adds a condition or set of conditions to be used in the `HAVING` clause for this query. This method operates in exactly the same way as the method `where()` does. Please refer to its documentation for an insight on how to using each parameter.
identifier() : ExpressionInterface: Creates an expression that refers to an identifier. Identifiers are used to refer to field names and allow the SQL compiler to apply quotes or escape the identifier.
innerJoin() : $this: Adds a single `INNER JOIN` clause to the query.
insert() : $this: Create an insert query.
into() : $this: Set the table name for insert queries.
isBufferedResultsEnabled() : bool: Returns whether buffered results are enabled/disabled.
isResultsCastingEnabled() : bool: Returns whether result casting is enabled/disabled.
join() : $this: Adds a single or multiple tables to be used as JOIN clauses to this query.
leftJoin() : $this: Adds a single `LEFT JOIN` clause to the query.
limit() : $this: Sets the number of records that should be retrieved from database, accepts an integer or an expression object that evaluates to an integer.
modifier() : $this: Adds a single or multiple `SELECT` modifiers to be used in the `SELECT`.
newExpr() : QueryExpression: Returns a new QueryExpression object. This is a handy function when building complex queries using a fluent interface. You can also override this function in subclasses to use a more specialized QueryExpression class if required.
offset() : $this: Sets the number of records that should be skipped from the original result set This is commonly used for paginating large results. Accepts an integer or an expression object that evaluates to an integer.
order() : $this: Adds a single or multiple fields to be used in the ORDER clause for this query.
orderAsc() : $this: Add an ORDER BY clause with an ASC direction.
orderDesc() : $this: Add an ORDER BY clause with a DESC direction.
page() : $this: Set the page of results you want.
removeJoin() : $this: Remove a join if it has been defined.
rightJoin() : $this: Adds a single `RIGHT JOIN` clause to the query.
rowCountAndClose() : int: Executes the SQL of this query and immediately closes the statement before returning the row count of records changed.
select() : $this: Adds new fields to be returned by a `SELECT` statement when this query is executed. Fields can be passed as an array of strings, array of expression objects, a single expression or a single string.
set() : $this: Set one or many fields to update.
setConnection() : $this: Sets the connection instance to be used for executing and transforming this query.
setDefaultTypes() : $this: Overwrite the default type mappings for fields in the implementing object.
setSelectTypeMap() : $this: Sets the TypeMap class where the types for each of the fields in the select clause are stored.
setTypeMap() : $this: Creates a new TypeMap if $typeMap is an array, otherwise exchanges it for the given one.
setValueBinder() : $this: Overwrite the current value binder
sql() : string: Returns the SQL representation of this object.
traverse() : $this: Will iterate over every specified part. Traversing functions can aggregate results using variables in the closure or instance variables. This function is commonly used as a way for traversing all query parts that are going to be used for constructing a query.
traverseExpressions() : $this: This function works similar to the traverse() function, with the difference that it does a full depth traversal of the entire expression tree. This will execute the provided callback function for each ExpressionInterface object that is stored inside this query at any nesting depth in any part of the query.
traverseParts() : $this: Will iterate over the provided parts.
type() : string: Returns the type of this query (select, insert, update, delete)
union() : $this: Adds a complete query to be used in conjunction with an UNION operator with this query. This is used to combine the result set of this query with the one that will be returned by the passed query. You can add as many queries as you required by calling multiple times this method with different queries.
unionAll() : $this: Adds a complete query to be used in conjunction with the UNION ALL operator with this query. This is used to combine the result set of this query with the one that will be returned by the passed query. You can add as many queries as you required by calling multiple times this method with different queries.
update() : $this: Create an update query.
values() : $this: Set the values for an insert query.
where() : $this: Adds a condition or set of conditions to be used in the WHERE clause for this query. Conditions can be expressed as an array of fields as keys with comparison operators in it, the values for the array will be used for comparing the field to such literal. Finally, conditions can be expressed as a single string or an array of strings.
whereInList() : $this: Adds an IN condition or set of conditions to be used in the WHERE clause for this query.
whereNotInList() : $this: Adds a NOT IN condition or set of conditions to be used in the WHERE clause for this query.
whereNotInListOrNull() : $this: Adds a NOT IN condition or set of conditions to be used in the WHERE clause for this query. This also allows the field to be null with a IS NULL condition since the null value would cause the NOT IN condition to always fail.
whereNotNull() : $this: Convenience method that adds a NOT NULL condition to the query
whereNull() : $this: Convenience method that adds a IS NULL condition to the query
window() : $this: Adds a named window expression.
with() : $this: Adds a new common table expression (CTE) to the query.
_conjugate() : void: Helper function used to build conditions by composing QueryExpression objects.
_decorateStatement() : CallbackStatement|StatementInterface: Auxiliary function used to wrap the original statement from the driver with any registered callbacks.
_dirty() : void: Marks a query as dirty, removing any preprocessed information from in memory caching.
_expressionsVisitor() : void: Query parts traversal method used by traverseExpressions()
_makeJoin() : array<string|int, mixed>: Returns an array that can be passed to the join method describing a single join clause

JOIN_TYPE_INNER


    public
        string
    JOIN_TYPE_INNER
    = 'INNER'

JOIN_TYPE_LEFT


    public
        string
    JOIN_TYPE_LEFT
    = 'LEFT'

JOIN_TYPE_RIGHT


    public
        string
    JOIN_TYPE_RIGHT
    = 'RIGHT'

$_connection

Connection instance to be used to execute this query.


    protected
        Connection
    $_connection

$_deleteParts

The list of query clauses to traverse for generating a DELETE statement

This property is unused.


    protected
        array<string|int, string>
    $_deleteParts
     = ['with', 'delete', 'modifier', 'from', 'where', 'epilog']

$_dirty

Indicates whether internal state of this query was changed, this is used to discard internal cached objects such as the transformed query or the reference to the executed statement.


    protected
        bool
    $_dirty
     = false

$_functionsBuilder

Instance of functions builder object used for generating arbitrary SQL functions.


    protected
        FunctionsBuilder|null
    $_functionsBuilder

$_insertParts

The list of query clauses to traverse for generating an INSERT statement

This property is unused.


    protected
        array<string|int, string>
    $_insertParts
     = ['with', 'insert', 'values', 'epilog']

$_iterator

Statement object resulting from executing this query.


    protected
        StatementInterface|null
    $_iterator

$_parts

List of SQL parts that will be used to build this query.


    protected
        array<string, mixed>
    $_parts
     = ['delete' => true, 'update' => [], 'set' => [], 'insert' => [], 'values' => [], 'with' => [], 'select' => [], 'distinct' => false, 'modifier' => [], 'from' => [], 'join' => [], 'where' => null, 'group' => [], 'having' => null, 'window' => [], 'order' => null, 'limit' => null, 'offset' => null, 'union' => [], 'epilog' => null]

$_resultDecorators

A list of callback functions to be called to alter each row from resulting statement upon retrieval. Each one of the callback function will receive the row array as first argument.


    protected
        array<string|int, callable>
    $_resultDecorators
     = []

$_selectParts

The list of query clauses to traverse for generating a SELECT statement

This property is unused.


    protected
        array<string|int, string>
    $_selectParts
     = ['with', 'select', 'from', 'join', 'where', 'group', 'having', 'order', 'limit', 'offset', 'union', 'epilog']

$_selectTypeMap

The Type map for fields in the select clause


    protected
        TypeMap|null
    $_selectTypeMap

$_type

Type of this query (select, insert, update, delete).


    protected
        string
    $_type
     = 'select'

$_typeMap


    protected
        TypeMap|null
    $_typeMap

$_updateParts

The list of query clauses to traverse for generating an UPDATE statement

This property is unused.


    protected
        array<string|int, string>
    $_updateParts
     = ['with', 'update', 'set', 'where', 'epilog']

$_useBufferedResults

Boolean for tracking whether buffered results are enabled.


    protected
        bool
    $_useBufferedResults
     = true

$_valueBinder

The object responsible for generating query placeholders and temporarily store values associated to each of those.


    protected
        ValueBinder|null
    $_valueBinder

$typeCastEnabled

Tracking flag to disable casting


    protected
        bool
    $typeCastEnabled
     = true

__clone()

Handles clearing iterator and cloning all expressions and value binders.


    public
                    __clone() : void

__construct()

Constructor.


    public
                    __construct(Connection $connection) : mixed

Parameters

$connection : Connection: The connection object to be used for transforming and executing this query

__debugInfo()

Returns an array that can be used to describe the internal state of this object.


    public
                    __debugInfo() : array<string, mixed>

Return values

array<string, mixed>

__toString()

Returns string representation of this query (complete SQL statement).


    public
                    __toString() : string

Return values

string

andHaving()

Connects any previously defined set of conditions to the provided list using the AND operator in the HAVING clause. This method operates in exactly the same way as the method `andWhere()` does. Please refer to its documentation for an insight on how to using each parameter.


    public
                    andHaving(ExpressionInterface|Closure|array<string|int, mixed>|string $conditions[, array<string, string> $types = [] ]) : $this

Having fields are not suitable for use with user supplied data as they are not sanitized by the query builder.

Parameters

$conditions : ExpressionInterface|Closure|array<string|int, mixed>|string: The AND conditions for HAVING.
$types : array<string, string> = []: Associative array of type names used to bind values to query

Return values

$this

andWhere()

Connects any previously defined set of conditions to the provided list using the AND operator. This function accepts the conditions list in the same format as the method `where` does, hence you can use arrays, expression objects callback functions or strings.


    public
                    andWhere(ExpressionInterface|Closure|array<string|int, mixed>|string $conditions[, array<string, string> $types = [] ]) : $this

It is important to notice that when calling this function, any previous set of conditions defined for this query will be treated as a single argument for the AND operator. This function will not only operate the most recently defined condition, but all the conditions as a whole.

When using an array for defining conditions, creating constraints form each array entry will use the same logic as with the where() function. This means that each array entry will be joined to the other using the AND operator, unless you nest the conditions in the array using other operator.

Examples:

$query->where(['title' => 'Hello World')->andWhere(['author_id' => 1]);

Will produce:

WHERE title = 'Hello World' AND author_id = 1

$query
  ->where(['OR' => ['published' => false, 'published is NULL']])
  ->andWhere(['author_id' => 1, 'comments_count >' => 10])

Produces:

WHERE (published = 0 OR published IS NULL) AND author_id = 1 AND comments_count > 10

$query
  ->where(['title' => 'Foo'])
  ->andWhere(function ($exp, $query) {
    return $exp
      ->or(['author_id' => 1])
      ->add(['author_id' => 2]);
  });

Generates the following conditions:

WHERE (title = 'Foo') AND (author_id = 1 OR author_id = 2)

Parameters

$conditions : ExpressionInterface|Closure|array<string|int, mixed>|string: The conditions to add with AND.
$types : array<string, string> = []: Associative array of type names used to bind values to query

Return values

$this

bind()

Associates a query placeholder to a value and a type.


    public
                    bind(string|int $param, mixed $value[, string|int|null $type = null ]) : $this

$query->bind(':id', 1, 'integer');

Parameters

$param : string|int: placeholder to be replaced with quoted version of $value
$value : mixed: The value to be bound
$type : string|int|null = null: the mapped type name, used for casting when sending to database

Return values

$this

clause()

Returns any data that was stored in the specified clause. This is useful for modifying any internal part of the query and it is used by the SQL dialects to transform the query accordingly before it is executed. The valid clauses that can be retrieved are: delete, update, set, insert, values, select, distinct, from, join, set, where, group, having, order, limit, offset and union.


    public
                    clause(string $name) : mixed

The return value for each of those parts may vary. Some clauses use QueryExpression to internally store their state, some use arrays and others may use booleans or integers. This is summary of the return types for each clause.

update: string The name of the table to update
set: QueryExpression
insert: array, will return an array containing the table + columns.
values: ValuesExpression
select: array, will return empty array when no fields are set
distinct: boolean
from: array of tables
join: array
set: array
where: QueryExpression, returns null when not set
group: array
having: QueryExpression, returns null when not set
order: OrderByExpression, returns null when not set
limit: integer or QueryExpression, null when not set
offset: integer or QueryExpression, null when not set
union: array

Parameters

$name : string: name of the clause to be returned

decorateResults()

Registers a callback to be executed for each result that is fetched from the result set, the callback function will receive as first parameter an array with the raw data from the database for every row that is fetched and must return the row with any possible modifications.


    public
                    decorateResults(callable|null $callback[, bool $overwrite = false ]) : $this

Callbacks will be executed lazily, if only 3 rows are fetched for database it will called 3 times, event though there might be more rows to be fetched in the cursor.

Callbacks are stacked in the order they are registered, if you wish to reset the stack the call this function with the second parameter set to true.

If you wish to remove all decorators from the stack, set the first parameter to null and the second to true.

Example

$query->decorateResults(function ($row) {
  $row['order_total'] = $row['subtotal'] + ($row['subtotal'] * $row['tax']);
   return $row;
});

Parameters

$callback : callable|null: The callback to invoke when results are fetched.
$overwrite : bool = false: Whether this should append or replace all existing decorators.

Return values

$this

delete()

Create a delete query.


    public
                    delete([string|null $table = null ]) : $this

Can be combined with from(), where() and other methods to create delete queries with specific conditions.

Parameters

$table : string|null = null: The table to use when deleting.

Return values

$this

disableBufferedResults()

Disables buffered results.


    public
                    disableBufferedResults() : $this

Disabling buffering will consume less memory as fetched results are not remembered for future iterations.

Return values

$this

disableResultsCasting()

Disables result casting.


    public
                    disableResultsCasting() : $this

When disabled, the fields will be returned as received from the database driver (which in most environments means they are being returned as strings), which can improve performance with larger datasets.

Return values

$this

distinct()

Adds a `DISTINCT` clause to the query to remove duplicates from the result set.


    public
                    distinct([ExpressionInterface|array<string|int, mixed>|string|bool $on = [] ][, bool $overwrite = false ]) : $this

This clause can only be used for select statements.

If you wish to filter duplicates based of those rows sharing a particular field or set of fields, you may pass an array of fields to filter on. Beware that this option might not be fully supported in all database systems.

Examples:

// Filters products with the same name and city
$query->select(['name', 'city'])->from('products')->distinct();

// Filters products in the same city
$query->distinct(['city']);
$query->distinct('city');

// Filter products with the same name
$query->distinct(['name'], true);
$query->distinct('name', true);

Parameters

$on : ExpressionInterface|array<string|int, mixed>|string|bool = []: Enable/disable distinct class or list of fields to be filtered on
$overwrite : bool = false: whether to reset fields with passed list or not

Return values

$this

enableBufferedResults()

Enables/Disables buffered results.


    public
                    enableBufferedResults([bool $enable = true ]) : $this

When enabled the results returned by this Query will be buffered. This enables you to iterate a result set multiple times, or both cache and iterate it.

When disabled it will consume less memory as fetched results are not remembered for future iterations.

Parameters

$enable : bool = true: Whether to enable buffering

Return values

$this

enableResultsCasting()

Enables result casting.


    public
                    enableResultsCasting() : $this

When enabled, the fields in the results returned by this Query will be cast to their corresponding PHP data type.

Return values

$this

epilog()

A string or expression that will be appended to the generated query


    public
                    epilog([ExpressionInterface|string|null $expression = null ]) : $this

Examples:

$query->select('id')->where(['author_id' => 1])->epilog('FOR UPDATE');
$query
 ->insert('articles', ['title'])
 ->values(['author_id' => 1])
 ->epilog('RETURNING id');

Epliog content is raw SQL and not suitable for use with user supplied data.

Parameters

$expression : ExpressionInterface|string|null = null: The expression to be appended

Return values

$this

execute()

Compiles the SQL representation of this query and executes it using the configured connection object. Returns the resulting statement object.


    public
                    execute() : StatementInterface

Executing a query internally executes several steps, the first one is letting the connection transform this object to fit its particular dialect, this might result in generating a different Query object that will be the one to actually be executed. Immediately after, literal values are passed to the connection so they are bound to the query in a safe way. Finally, the resulting statement is decorated with custom objects to execute callbacks for each row retrieved if necessary.

Resulting statement is traversable, so it can be used in any loop as you would with an array.

This method can be overridden in query subclasses to decorate behavior around query execution.

Return values

StatementInterface

expr()

Returns a new QueryExpression object. This is a handy function when building complex queries using a fluent interface. You can also override this function in subclasses to use a more specialized QueryExpression class if required.


    public
                    expr([ExpressionInterface|array<string|int, mixed>|string|null $rawExpression = null ]) : QueryExpression

You can optionally pass a single raw SQL string or an array or expressions in any format accepted by \Cake\Database\Expression\QueryExpression:

$expression = $query->expr(); // Returns an empty expression object
$expression = $query->expr('Table.column = Table2.column'); // Return a raw SQL expression

Parameters

$rawExpression : ExpressionInterface|array<string|int, mixed>|string|null = null: A string, array or anything you want wrapped in an expression object

Return values

QueryExpression

from()

Adds a single or multiple tables to be used in the FROM clause for this query.


    public
                    from([array<string|int, mixed>|string $tables = [] ][, bool $overwrite = false ]) : $this

Tables can be passed as an array of strings, array of expression objects, a single expression or a single string.

If an array is passed, keys will be used to alias tables using the value as the real field to be aliased. It is possible to alias strings, ExpressionInterface objects or even other Query objects.

By default this function will append any passed argument to the list of tables to be selected from, unless the second argument is set to true.

This method can be used for select, update and delete statements.

Examples:

$query->from(['p' => 'posts']); // Produces FROM posts p
$query->from('authors'); // Appends authors: FROM posts p, authors
$query->from(['products'], true); // Resets the list: FROM products
$query->from(['sub' => $countQuery]); // FROM (SELECT ...) sub

Parameters

$tables : array<string|int, mixed>|string = []: tables to be added to the list. This argument, can be passed as an array of strings, array of expression objects, or a single string. See the examples above for the valid call types.
$overwrite : bool = false: whether to reset tables with passed list or not

Return values

$this

func()

Returns an instance of a functions builder object that can be used for generating arbitrary SQL functions.


    public
                    func() : FunctionsBuilder

Example:

$query->func()->count('*');
$query->func()->dateDiff(['2012-01-05', '2012-01-02'])

Return values

FunctionsBuilder

getConnection()

Gets the connection instance to be used for executing and transforming this query.


    public
                    getConnection() : Connection

Return values

Connection

getDefaultTypes()

Gets default types of current type map.


    public
                    getDefaultTypes() : array<int|string, string>

Return values

array<int|string, string>

getIterator()

Executes this query and returns a results iterator. This function is required for implementing the IteratorAggregate interface and allows the query to be iterated without having to call execute() manually, thus making it look like a result set instead of the query itself.


    public
                    getIterator() : StatementInterface

Return values

StatementInterface

getSelectTypeMap()

Gets the TypeMap class where the types for each of the fields in the select clause are stored.


    public
                    getSelectTypeMap() : TypeMap

Return values

TypeMap

getTypeMap()

Returns the existing type map.


    public
                    getTypeMap() : TypeMap

Return values

TypeMap

getValueBinder()

Returns the currently used ValueBinder instance.


    public
                    getValueBinder() : ValueBinder

A ValueBinder is responsible for generating query placeholders and temporarily associate values to those placeholders so that they can be passed correctly to the statement object.

Return values

ValueBinder

group()

Adds a single or multiple fields to be used in the GROUP BY clause for this query.


    public
                    group(ExpressionInterface|array<string|int, mixed>|string $fields[, bool $overwrite = false ]) : $this

Fields can be passed as an array of strings, array of expression objects, a single expression or a single string.

By default this function will append any passed argument to the list of fields to be grouped, unless the second argument is set to true.

Examples:

// Produces GROUP BY id, title
$query->group(['id', 'title']);

// Produces GROUP BY title
$query->group('title');

Group fields are not suitable for use with user supplied data as they are not sanitized by the query builder.

Parameters

$fields : ExpressionInterface|array<string|int, mixed>|string: fields to be added to the list
$overwrite : bool = false: whether to reset fields with passed list or not

Return values

$this

having()

Adds a condition or set of conditions to be used in the `HAVING` clause for this query. This method operates in exactly the same way as the method `where()` does. Please refer to its documentation for an insight on how to using each parameter.


    public
                    having([ExpressionInterface|Closure|array<string|int, mixed>|string|null $conditions = null ][, array<string, string> $types = [] ][, bool $overwrite = false ]) : $this

Having fields are not suitable for use with user supplied data as they are not sanitized by the query builder.

Parameters

$conditions : ExpressionInterface|Closure|array<string|int, mixed>|string|null = null: The having conditions.
$types : array<string, string> = []: Associative array of type names used to bind values to query
$overwrite : bool = false: whether to reset conditions with passed list or not

Return values

$this

identifier()

Creates an expression that refers to an identifier. Identifiers are used to refer to field names and allow the SQL compiler to apply quotes or escape the identifier.


    public
                    identifier(string $identifier) : ExpressionInterface

The value is used as is, and you might be required to use aliases or include the table reference in the identifier. Do not use this method to inject SQL methods or logical statements.

Example

$query->newExpr()->lte('count', $query->identifier('total'));

Parameters

$identifier : string: The identifier for an expression

Return values

ExpressionInterface

innerJoin()

Adds a single `INNER JOIN` clause to the query.


    public
                    innerJoin(array<string, mixed>|string $table[, ExpressionInterface|array<string|int, mixed>|string $conditions = [] ][, array<string, string> $types = [] ]) : $this

This is a shorthand method for building joins via join().

The arguments of this method are identical to the leftJoin() shorthand, please refer to that method's description for further details.

Parameters

$table : array<string, mixed>|string: The table to join with
$conditions : ExpressionInterface|array<string|int, mixed>|string = []: The conditions to use for joining.
$types : array<string, string> = []: a list of types associated to the conditions used for converting values to the corresponding database representation.

Return values

$this

insert()

Create an insert query.


    public
                    insert(array<string|int, mixed> $columns[, array<int|string, string> $types = [] ]) : $this

Note calling this method will reset any data previously set with Query::values().

Parameters

$columns : array<string|int, mixed>: The columns to insert into.
$types : array<int|string, string> = []: A map between columns & their datatypes.

Return values

$this

into()

Set the table name for insert queries.


    public
                    into(string $table) : $this

Parameters

$table : string: The table name to insert into.

Return values

$this

isBufferedResultsEnabled()

Returns whether buffered results are enabled/disabled.


    public
                    isBufferedResultsEnabled() : bool

When enabled the results returned by this Query will be buffered. This enables you to iterate a result set multiple times, or both cache and iterate it.

When disabled it will consume less memory as fetched results are not remembered for future iterations.

Return values

bool

isResultsCastingEnabled()

Returns whether result casting is enabled/disabled.


    public
                    isResultsCastingEnabled() : bool

When enabled, the fields in the results returned by this Query will be casted to their corresponding PHP data type.

Return values

bool

join()

Adds a single or multiple tables to be used as JOIN clauses to this query.


    public
                    join(array<string, mixed>|string $tables[, array<string, string> $types = [] ][, bool $overwrite = false ]) : $this

Tables can be passed as an array of strings, an array describing the join parts, an array with multiple join descriptions, or a single string.

By default this function will append any passed argument to the list of tables to be joined, unless the third argument is set to true.

When no join type is specified an INNER JOIN is used by default: $query->join(['authors']) will produce INNER JOIN authors ON 1 = 1

It is also possible to alias joins using the array key: $query->join(['a' => 'authors']) will produce INNER JOIN authors a ON 1 = 1

A join can be fully described and aliased using the array notation:

$query->join([
    'a' => [
        'table' => 'authors',
        'type' => 'LEFT',
        'conditions' => 'a.id = b.author_id'
    ]
]);
// Produces LEFT JOIN authors a ON a.id = b.author_id

You can even specify multiple joins in an array, including the full description:

$query->join([
    'a' => [
        'table' => 'authors',
        'type' => 'LEFT',
        'conditions' => 'a.id = b.author_id'
    ],
    'p' => [
        'table' => 'publishers',
        'type' => 'INNER',
        'conditions' => 'p.id = b.publisher_id AND p.name = "Cake Software Foundation"'
    ]
]);
// LEFT JOIN authors a ON a.id = b.author_id
// INNER JOIN publishers p ON p.id = b.publisher_id AND p.name = "Cake Software Foundation"

Using conditions and types

Conditions can be expressed, as in the examples above, using a string for comparing columns, or string with already quoted literal values. Additionally it is possible to use conditions expressed in arrays or expression objects.

When using arrays for expressing conditions, it is often desirable to convert the literal values to the correct database representation. This is achieved using the second parameter of this function.

$query->join(['a' => [
    'table' => 'articles',
    'conditions' => [
        'a.posted >=' => new DateTime('-3 days'),
        'a.published' => true,
        'a.author_id = authors.id'
    ]
]], ['a.posted' => 'datetime', 'a.published' => 'boolean'])

Overwriting joins

When creating aliased joins using the array notation, you can override previous join definitions by using the same alias in consequent calls to this function or you can replace all previously defined joins with another list if the third parameter for this function is set to true.

$query->join(['alias' => 'table']); // joins table with as alias
$query->join(['alias' => 'another_table']); // joins another_table with as alias
$query->join(['something' => 'different_table'], [], true); // resets joins list

Parameters

$tables : array<string, mixed>|string: list of tables to be joined in the query
$types : array<string, string> = []: Associative array of type names used to bind values to query
$overwrite : bool = false: whether to reset joins with passed list or not

Return values

$this

leftJoin()

Adds a single `LEFT JOIN` clause to the query.


    public
                    leftJoin(array<string, mixed>|string $table[, ExpressionInterface|array<string|int, mixed>|string $conditions = [] ][, array<string|int, mixed> $types = [] ]) : $this

This is a shorthand method for building joins via join().

The table name can be passed as a string, or as an array in case it needs to be aliased:

// LEFT JOIN authors ON authors.id = posts.author_id
$query->leftJoin('authors', 'authors.id = posts.author_id');

// LEFT JOIN authors a ON a.id = posts.author_id
$query->leftJoin(['a' => 'authors'], 'a.id = posts.author_id');

Conditions can be passed as strings, arrays, or expression objects. When using arrays it is possible to combine them with the $types parameter in order to define how to convert the values:

$query->leftJoin(['a' => 'articles'], [
     'a.posted >=' => new DateTime('-3 days'),
     'a.published' => true,
     'a.author_id = authors.id'
], ['a.posted' => 'datetime', 'a.published' => 'boolean']);

See join() for further details on conditions and types.

Parameters

$table : array<string, mixed>|string: The table to join with
$conditions : ExpressionInterface|array<string|int, mixed>|string = []: The conditions to use for joining.
$types : array<string|int, mixed> = []: a list of types associated to the conditions used for converting values to the corresponding database representation.

Return values

$this

limit()

Sets the number of records that should be retrieved from database, accepts an integer or an expression object that evaluates to an integer.


    public
                    limit(ExpressionInterface|int|null $limit) : $this

In some databases, this operation might not be supported or will require the query to be transformed in order to limit the result set size.

Examples

$query->limit(10) // generates LIMIT 10
$query->limit($query->newExpr()->add(['1 + 1'])); // LIMIT (1 + 1)

Parameters

$limit : ExpressionInterface|int|null: number of records to be returned

Return values

$this

modifier()

Adds a single or multiple `SELECT` modifiers to be used in the `SELECT`.


    public
                    modifier(ExpressionInterface|array<string|int, mixed>|string $modifiers[, bool $overwrite = false ]) : $this

By default this function will append any passed argument to the list of modifiers to be applied, unless the second argument is set to true.

Example:

// Ignore cache query in MySQL
$query->select(['name', 'city'])->from('products')->modifier('SQL_NO_CACHE');
// It will produce the SQL: SELECT SQL_NO_CACHE name, city FROM products

// Or with multiple modifiers
$query->select(['name', 'city'])->from('products')->modifier(['HIGH_PRIORITY', 'SQL_NO_CACHE']);
// It will produce the SQL: SELECT HIGH_PRIORITY SQL_NO_CACHE name, city FROM products

Parameters

$modifiers : ExpressionInterface|array<string|int, mixed>|string: modifiers to be applied to the query
$overwrite : bool = false: whether to reset order with field list or not

Return values

$this

newExpr()


    public
                    newExpr([ExpressionInterface|array<string|int, mixed>|string|null $rawExpression = null ]) : QueryExpression

You can optionally pass a single raw SQL string or an array or expressions in any format accepted by \Cake\Database\Expression\QueryExpression:

$expression = $query->expr(); // Returns an empty expression object
$expression = $query->expr('Table.column = Table2.column'); // Return a raw SQL expression

Parameters

$rawExpression : ExpressionInterface|array<string|int, mixed>|string|null = null: A string, array or anything you want wrapped in an expression object

Return values

QueryExpression

offset()

Sets the number of records that should be skipped from the original result set This is commonly used for paginating large results. Accepts an integer or an expression object that evaluates to an integer.


    public
                    offset(ExpressionInterface|int|null $offset) : $this

In some databases, this operation might not be supported or will require the query to be transformed in order to limit the result set size.

Examples

$query->offset(10) // generates OFFSET 10
$query->offset($query->newExpr()->add(['1 + 1'])); // OFFSET (1 + 1)

Parameters

$offset : ExpressionInterface|int|null: number of records to be skipped

Return values

$this

order()

Adds a single or multiple fields to be used in the ORDER clause for this query.


    public
                    order(ExpressionInterface|Closure|array<string|int, mixed>|string $fields[, bool $overwrite = false ]) : $this

Fields can be passed as an array of strings, array of expression objects, a single expression or a single string.

If an array is passed, keys will be used as the field itself and the value will represent the order in which such field should be ordered. When called multiple times with the same fields as key, the last order definition will prevail over the others.

By default this function will append any passed argument to the list of fields to be selected, unless the second argument is set to true.

Examples:

$query->order(['title' => 'DESC', 'author_id' => 'ASC']);

Produces:

ORDER BY title DESC, author_id ASC

$query
    ->order(['title' => $query->newExpr('DESC NULLS FIRST')])
    ->order('author_id');

Will generate:

ORDER BY title DESC NULLS FIRST, author_id

$expression = $query->newExpr()->add(['id % 2 = 0']);
$query->order($expression)->order(['title' => 'ASC']);

and

$query->order(function ($exp, $query) {
    return [$exp->add(['id % 2 = 0']), 'title' => 'ASC'];
});

Will both become:

ORDER BY (id %2 = 0), title ASC

Order fields/directions are not sanitized by the query builder. You should use an allowed list of fields/directions when passing in user-supplied data to order().

If you need to set complex expressions as order conditions, you should use orderAsc() or orderDesc().

Parameters

$fields : ExpressionInterface|Closure|array<string|int, mixed>|string: fields to be added to the list
$overwrite : bool = false: whether to reset order with field list or not

Return values

$this

orderAsc()

Add an ORDER BY clause with an ASC direction.


    public
                    orderAsc(ExpressionInterface|Closure|string $field[, bool $overwrite = false ]) : $this

This method allows you to set complex expressions as order conditions unlike order()

Order fields are not suitable for use with user supplied data as they are not sanitized by the query builder.

Parameters

$field : ExpressionInterface|Closure|string: The field to order on.
$overwrite : bool = false: Whether to reset the order clauses.

Return values

$this

orderDesc()

Add an ORDER BY clause with a DESC direction.


    public
                    orderDesc(ExpressionInterface|Closure|string $field[, bool $overwrite = false ]) : $this

This method allows you to set complex expressions as order conditions unlike order()

Order fields are not suitable for use with user supplied data as they are not sanitized by the query builder.

Parameters

$field : ExpressionInterface|Closure|string: The field to order on.
$overwrite : bool = false: Whether to reset the order clauses.

Return values

$this

page()

Set the page of results you want.


    public
                    page(int $num[, int|null $limit = null ]) : $this

This method provides an easier to use interface to set the limit + offset in the record set you want as results. If empty the limit will default to the existing limit clause, and if that too is empty, then 25 will be used.

Pages must start at 1.

Parameters

$num : int: The page number you want.
$limit : int|null = null: The number of rows you want in the page. If null the current limit clause will be used.

Return values

$this

removeJoin()

Remove a join if it has been defined.


    public
                    removeJoin(string $name) : $this

Useful when you are redefining joins or want to re-order the join clauses.

Parameters

$name : string: The alias/name of the join to remove.

Return values

$this

rightJoin()

Adds a single `RIGHT JOIN` clause to the query.


    public
                    rightJoin(array<string, mixed>|string $table[, ExpressionInterface|array<string|int, mixed>|string $conditions = [] ][, array<string|int, mixed> $types = [] ]) : $this

This is a shorthand method for building joins via join().

The arguments of this method are identical to the leftJoin() shorthand, please refer to that methods description for further details.

Parameters

$table : array<string, mixed>|string: The table to join with
$conditions : ExpressionInterface|array<string|int, mixed>|string = []: The conditions to use for joining.
$types : array<string|int, mixed> = []: a list of types associated to the conditions used for converting values to the corresponding database representation.

Return values

$this

rowCountAndClose()

Executes the SQL of this query and immediately closes the statement before returning the row count of records changed.


    public
                    rowCountAndClose() : int

This method can be used with UPDATE and DELETE queries, but is not recommended for SELECT queries and is not used to count records.

Example

$rowCount = $query->update('articles')
                ->set(['published'=>true])
                ->where(['published'=>false])
                ->rowCountAndClose();

The above example will change the published column to true for all false records, and return the number of records that were updated.

Return values

int

select()

Adds new fields to be returned by a `SELECT` statement when this query is executed. Fields can be passed as an array of strings, array of expression objects, a single expression or a single string.


    public
                    select([ExpressionInterface|callable|array<string|int, mixed>|string $fields = [] ][, bool $overwrite = false ]) : $this

If an array is passed, keys will be used to alias fields using the value as the real field to be aliased. It is possible to alias strings, Expression objects or even other Query objects.

If a callable function is passed, the returning array of the function will be used as the list of fields.

By default this function will append any passed argument to the list of fields to be selected, unless the second argument is set to true.

Examples:

$query->select(['id', 'title']); // Produces SELECT id, title
$query->select(['author' => 'author_id']); // Appends author: SELECT id, title, author_id as author
$query->select('id', true); // Resets the list: SELECT id
$query->select(['total' => $countQuery]); // SELECT id, (SELECT ...) AS total
$query->select(function ($query) {
    return ['article_id', 'total' => $query->count('*')];
})

By default no fields are selected, if you have an instance of Cake\ORM\Query and try to append fields you should also call Cake\ORM\Query::enableAutoFields() to select the default fields from the table.

Parameters

$fields : ExpressionInterface|callable|array<string|int, mixed>|string = []: fields to be added to the list.
$overwrite : bool = false: whether to reset fields with passed list or not

Return values

$this

set()

Set one or many fields to update.


    public
                    set(QueryExpression|Closure|array<string|int, mixed>|string $key[, mixed $value = null ][, array<string, string>|string $types = [] ]) : $this

Examples

Passing a string:

$query->update('articles')->set('title', 'The Title');

Passing an array:

$query->update('articles')->set(['title' => 'The Title'], ['title' => 'string']);

Passing a callable:

$query->update('articles')->set(function ($exp) {
  return $exp->eq('title', 'The title', 'string');
});

Parameters

$key : QueryExpression|Closure|array<string|int, mixed>|string

The column name or array of keys

values to set. This can also be a QueryExpression containing a SQL fragment. It can also be a Closure, that is required to return an expression object.

$value : mixed = null

The value to update $key to. Can be null if $key is an array or QueryExpression. When $key is an array, this parameter will be used as $types instead.

$types : array<string, string>|string = []

The column types to treat data as.

Return values

$this

setConnection()

Sets the connection instance to be used for executing and transforming this query.


    public
                    setConnection(Connection $connection) : $this

Parameters

$connection : Connection: Connection instance

Return values

$this

setDefaultTypes()

Overwrite the default type mappings for fields in the implementing object.


    public
                    setDefaultTypes(array<int|string, string> $types) : $this

This method is useful if you need to set type mappings that are shared across multiple functions/expressions in a query.

To add a default without overwriting existing ones use getTypeMap()->addDefaults()

Parameters

$types : array<int|string, string>: The array of types to set.

Return values

$this

setSelectTypeMap()

Sets the TypeMap class where the types for each of the fields in the select clause are stored.


    public
                    setSelectTypeMap(TypeMap $typeMap) : $this

Parameters

$typeMap : TypeMap: The map object to use

Return values

$this

setTypeMap()

Creates a new TypeMap if $typeMap is an array, otherwise exchanges it for the given one.


    public
                    setTypeMap(TypeMap|array<string|int, mixed> $typeMap) : $this

Parameters

$typeMap : TypeMap|array<string|int, mixed>: Creates a TypeMap if array, otherwise sets the given TypeMap

Return values

$this

setValueBinder()

Overwrite the current value binder


    public
                    setValueBinder(ValueBinder|null $binder) : $this

A ValueBinder is responsible for generating query placeholders and temporarily associate values to those placeholders so that they can be passed correctly to the statement object.

Parameters

$binder : ValueBinder|null: The binder or null to disable binding.

Return values

$this

sql()

Returns the SQL representation of this object.


    public
                    sql([ValueBinder|null $binder = null ]) : string

This function will compile this query to make it compatible with the SQL dialect that is used by the connection, This process might add, remove or alter any query part or internal expression to make it executable in the target platform.

The resulting query may have placeholders that will be replaced with the actual values when the query is executed, hence it is most suitable to use with prepared statements.

Parameters

$binder : ValueBinder|null = null: Value binder that generates parameter placeholders

Return values

string

traverse()

Will iterate over every specified part. Traversing functions can aggregate results using variables in the closure or instance variables. This function is commonly used as a way for traversing all query parts that are going to be used for constructing a query.


    public
                    traverse(callable $callback) : $this

The callback will receive 2 parameters, the first one is the value of the query part that is being iterated and the second the name of such part.

Example

$query->select(['title'])->from('articles')->traverse(function ($value, $clause) {
    if ($clause === 'select') {
        var_dump($value);
    }
});

Parameters

$callback : callable: A function or callable to be executed for each part

Return values

$this

traverseExpressions()

This function works similar to the traverse() function, with the difference that it does a full depth traversal of the entire expression tree. This will execute the provided callback function for each ExpressionInterface object that is stored inside this query at any nesting depth in any part of the query.


    public
                    traverseExpressions(callable $callback) : $this

Callback will receive as first parameter the currently visited expression.

Parameters

$callback : callable: the function to be executed for each ExpressionInterface found inside this query.

Return values

$this

traverseParts()

Will iterate over the provided parts.


    public
                    traverseParts(callable $visitor, array<string|int, string> $parts) : $this

Traversing functions can aggregate results using variables in the closure or instance variables. This method can be used to traverse a subset of query parts in order to render a SQL query.

The callback will receive 2 parameters, the first one is the value of the query part that is being iterated and the second the name of such part.

Example

$query->select(['title'])->from('articles')->traverse(function ($value, $clause) {
    if ($clause === 'select') {
        var_dump($value);
    }
}, ['select', 'from']);

Parameters

$visitor : callable: A function or callable to be executed for each part
$parts : array<string|int, string>: The list of query parts to traverse

Return values

$this

type()

Returns the type of this query (select, insert, update, delete)


    public
                    type() : string

Return values

string

union()

Adds a complete query to be used in conjunction with an UNION operator with this query. This is used to combine the result set of this query with the one that will be returned by the passed query. You can add as many queries as you required by calling multiple times this method with different queries.


    public
                    union(Query|string $query[, bool $overwrite = false ]) : $this

By default, the UNION operator will remove duplicate rows, if you wish to include every row for all queries, use unionAll().

Examples

$union = (new Query($conn))->select(['id', 'title'])->from(['a' => 'articles']);
$query->select(['id', 'name'])->from(['d' => 'things'])->union($union);

Will produce:

SELECT id, name FROM things d UNION SELECT id, title FROM articles a

Parameters

$query : Query|string: full SQL query to be used in UNION operator
$overwrite : bool = false: whether to reset the list of queries to be operated or not

Return values

$this

unionAll()

Adds a complete query to be used in conjunction with the UNION ALL operator with this query. This is used to combine the result set of this query with the one that will be returned by the passed query. You can add as many queries as you required by calling multiple times this method with different queries.


    public
                    unionAll(Query|string $query[, bool $overwrite = false ]) : $this

Unlike UNION, UNION ALL will not remove duplicate rows.

$union = (new Query($conn))->select(['id', 'title'])->from(['a' => 'articles']);
$query->select(['id', 'name'])->from(['d' => 'things'])->unionAll($union);

Will produce:

SELECT id, name FROM things d UNION ALL SELECT id, title FROM articles a

Parameters

$query : Query|string: full SQL query to be used in UNION operator
$overwrite : bool = false: whether to reset the list of queries to be operated or not

Return values

$this

update()

Create an update query.


    public
                    update(ExpressionInterface|string $table) : $this

Can be combined with set() and where() methods to create update queries.

Parameters

$table : ExpressionInterface|string: The table you want to update.

Return values

$this

values()

Set the values for an insert query.


    public
                    values(ValuesExpression|Query|array<string|int, mixed> $data) : $this

Multi inserts can be performed by calling values() more than one time, or by providing an array of value sets. Additionally $data can be a Query instance to insert data from another SELECT statement.

Parameters

$data : ValuesExpression|Query|array<string|int, mixed>: The data to insert.

Return values

$this

where()

Adds a condition or set of conditions to be used in the WHERE clause for this query. Conditions can be expressed as an array of fields as keys with comparison operators in it, the values for the array will be used for comparing the field to such literal. Finally, conditions can be expressed as a single string or an array of strings.


    public
                    where([ExpressionInterface|Closure|array<string|int, mixed>|string|null $conditions = null ][, array<string, string> $types = [] ][, bool $overwrite = false ]) : $this

When using arrays, each entry will be joined to the rest of the conditions using an AND operator. Consecutive calls to this function will also join the new conditions specified using the AND operator. Additionally, values can be expressed using expression objects which can include other query objects.

Any conditions created with this methods can be used with any SELECT, UPDATE and DELETE type of queries.

Conditions using operators:

$query->where([
    'posted >=' => new DateTime('3 days ago'),
    'title LIKE' => 'Hello W%',
    'author_id' => 1,
], ['posted' => 'datetime']);

The previous example produces:

WHERE posted >= 2012-01-27 AND title LIKE 'Hello W%' AND author_id = 1

Second parameter is used to specify what type is expected for each passed key. Valid types can be used from the mapped with Database\Type class.

Nesting conditions with conjunctions:

$query->where([
    'author_id !=' => 1,
    'OR' => ['published' => true, 'posted <' => new DateTime('now')],
    'NOT' => ['title' => 'Hello']
], ['published' => boolean, 'posted' => 'datetime']

The previous example produces:

WHERE author_id = 1 AND (published = 1 OR posted < '2012-02-01') AND NOT (title = 'Hello')

You can nest conditions using conjunctions as much as you like. Sometimes, you may want to define 2 different options for the same key, in that case, you can wrap each condition inside a new array:

$query->where(['OR' => [['published' => false], ['published' => true]])

Would result in:

WHERE (published = false) OR (published = true)

Keep in mind that every time you call where() with the third param set to false (default), it will join the passed conditions to the previous stored list using the AND operator. Also, using the same array key twice in consecutive calls to this method will not override the previous value.

Using expressions objects:

$exp = $query->newExpr()->add(['id !=' => 100, 'author_id' != 1])->tieWith('OR');
$query->where(['published' => true], ['published' => 'boolean'])->where($exp);

The previous example produces:

WHERE (id != 100 OR author_id != 1) AND published = 1

Other Query objects that be used as conditions for any field.

Adding conditions in multiple steps:

You can use callable functions to construct complex expressions, functions receive as first argument a new QueryExpression object and this query instance as second argument. Functions must return an expression object, that will be added the list of conditions for the query using the AND operator.

$query
  ->where(['title !=' => 'Hello World'])
  ->where(function ($exp, $query) {
    $or = $exp->or(['id' => 1]);
    $and = $exp->and(['id >' => 2, 'id <' => 10]);
   return $or->add($and);
  });

The previous example produces:

WHERE title != 'Hello World' AND (id = 1 OR (id > 2 AND id < 10))

Conditions as strings:

$query->where(['articles.author_id = authors.id', 'modified IS NULL']);

The previous example produces:

WHERE articles.author_id = authors.id AND modified IS NULL

Please note that when using the array notation or the expression objects, all values will be correctly quoted and transformed to the correspondent database data type automatically for you, thus securing your application from SQL injections. The keys however, are not treated as unsafe input, and should be validated/sanitized.

If you use string conditions make sure that your values are correctly quoted. The safest thing you can do is to never use string conditions.

Using null-able values

When using values that can be null you can use the 'IS' keyword to let the ORM generate the correct SQL based on the value's type

$query->where([
    'posted >=' => new DateTime('3 days ago'),
    'category_id IS' => $category,
]);

If $category is null - it will actually convert that into category_id IS NULL - if it's 4 it will convert it into category_id = 4

Parameters

$conditions : ExpressionInterface|Closure|array<string|int, mixed>|string|null = null: The conditions to filter on.
$types : array<string, string> = []: Associative array of type names used to bind values to query
$overwrite : bool = false: whether to reset conditions with passed list or not

Return values

$this

whereInList()

Adds an IN condition or set of conditions to be used in the WHERE clause for this query.


    public
                    whereInList(string $field, array<string|int, mixed> $values[, array<string, mixed> $options = [] ]) : $this

This method does allow empty inputs in contrast to where() if you set 'allowEmpty' to true. Be careful about using it without proper sanity checks.

Options:

types - Associative array of type names used to bind values to query
allowEmpty - Allow empty array.

Parameters

$field : string: Field
$values : array<string|int, mixed>: Array of values
$options : array<string, mixed> = []: Options

Return values

$this

whereNotInList()

Adds a NOT IN condition or set of conditions to be used in the WHERE clause for this query.


    public
                    whereNotInList(string $field, array<string|int, mixed> $values[, array<string, mixed> $options = [] ]) : $this

This method does allow empty inputs in contrast to where() if you set 'allowEmpty' to true. Be careful about using it without proper sanity checks.

Parameters

$field : string: Field
$values : array<string|int, mixed>: Array of values
$options : array<string, mixed> = []: Options

Return values

$this

whereNotInListOrNull()

Adds a NOT IN condition or set of conditions to be used in the WHERE clause for this query. This also allows the field to be null with a IS NULL condition since the null value would cause the NOT IN condition to always fail.


    public
                    whereNotInListOrNull(string $field, array<string|int, mixed> $values[, array<string, mixed> $options = [] ]) : $this

This method does allow empty inputs in contrast to where() if you set 'allowEmpty' to true. Be careful about using it without proper sanity checks.

Parameters

$field : string: Field
$values : array<string|int, mixed>: Array of values
$options : array<string, mixed> = []: Options

Return values

$this

whereNotNull()

Convenience method that adds a NOT NULL condition to the query


    public
                    whereNotNull(ExpressionInterface|array<string|int, mixed>|string $fields) : $this

Parameters

$fields : ExpressionInterface|array<string|int, mixed>|string: A single field or expressions or a list of them that should be not null.

Return values

$this

whereNull()

Convenience method that adds a IS NULL condition to the query


    public
                    whereNull(ExpressionInterface|array<string|int, mixed>|string $fields) : $this

Parameters

$fields : ExpressionInterface|array<string|int, mixed>|string: A single field or expressions or a list of them that should be null.

Return values

$this

window()

Adds a named window expression.


    public
                    window(string $name, WindowExpression|Closure $window[, bool $overwrite = false ]) : $this

You are responsible for adding windows in the order your database requires.

Parameters

$name : string: Window name
$window : WindowExpression|Closure: Window expression
$overwrite : bool = false: Clear all previous query window expressions

Return values

$this

with()

Adds a new common table expression (CTE) to the query.


    public
                    with(CommonTableExpression|Closure $cte[, bool $overwrite = false ]) : $this

Examples:

Common table expressions can either be passed as preconstructed expression objects:

$cte = new \Cake\Database\Expression\CommonTableExpression(
    'cte',
    $connection
        ->newQuery()
        ->select('*')
        ->from('articles')
);

$query->with($cte);

or returned from a closure, which will receive a new common table expression object as the first argument, and a new blank query object as the second argument:

$query->with(function (
    \Cake\Database\Expression\CommonTableExpression $cte,
    \Cake\Database\Query $query
 ) {
    $cteQuery = $query
        ->select('*')
        ->from('articles');

    return $cte
        ->name('cte')
        ->query($cteQuery);
});

Parameters

$cte : CommonTableExpression|Closure: The CTE to add.
$overwrite : bool = false: Whether to reset the list of CTEs.

Return values

$this

_conjugate()

Helper function used to build conditions by composing QueryExpression objects.


    protected
                    _conjugate(string $part, ExpressionInterface|Closure|array<string|int, mixed>|string|null $append, string $conjunction, array<string, string> $types) : void

Parameters

$part : string: Name of the query part to append the new part to
$append : ExpressionInterface|Closure|array<string|int, mixed>|string|null: Expression or builder function to append. to append.
$conjunction : string: type of conjunction to be used to operate part
$types : array<string, string>: Associative array of type names used to bind values to query

_decorateStatement()

Auxiliary function used to wrap the original statement from the driver with any registered callbacks.


    protected
                    _decorateStatement(StatementInterface $statement) : CallbackStatement|StatementInterface

Parameters

$statement : StatementInterface: to be decorated

Return values

CallbackStatement|StatementInterface

_dirty()

Marks a query as dirty, removing any preprocessed information from in memory caching.


    protected
                    _dirty() : void

_expressionsVisitor()

Query parts traversal method used by traverseExpressions()


    protected
                    _expressionsVisitor(ExpressionInterface|array<string|int, ExpressionInterface> $expression, Closure $callback) : void

Parameters

$expression : ExpressionInterface|array<string|int, ExpressionInterface>: Query expression or array of expressions.
$callback : Closure: The callback to be executed for each ExpressionInterface found inside this query.

_makeJoin()

Returns an array that can be passed to the join method describing a single join clause


    protected
                    _makeJoin(array<string, mixed>|string $table, ExpressionInterface|array<string|int, mixed>|string $conditions, string $type) : array<string|int, mixed>

Parameters

$table : array<string, mixed>|string: The table to join with
$conditions : ExpressionInterface|array<string|int, mixed>|string: The conditions to use for joining.
$type : string: the join type to use

Return values

array<string|int, mixed>

Query in package Application implements ExpressionInterface, IteratorAggregate uses TypeMapTrait

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

JOIN_TYPE_INNER

JOIN_TYPE_LEFT

JOIN_TYPE_RIGHT

Properties

$_connection

$_deleteParts

$_dirty

$_functionsBuilder

$_insertParts

$_iterator

$_parts

$_resultDecorators

$_selectParts

$_selectTypeMap

$_type

$_typeMap

$_updateParts

$_useBufferedResults

$_valueBinder

$typeCastEnabled

Methods

__clone()

__construct()

Parameters

__debugInfo()

Return values

__toString()

Return values

andHaving()

Parameters

Tags

Return values

andWhere()

Examples:

Parameters

Tags

Return values

bind()

Parameters

Return values

clause()

Parameters

Tags

decorateResults()

Example

Parameters

Return values

delete()

Parameters

Return values

disableBufferedResults()

Return values

disableResultsCasting()

Return values

distinct()

Examples:

Parameters

Return values

enableBufferedResults()

Parameters

Return values

enableResultsCasting()

Return values

epilog()

Examples:

Parameters

Return values

execute()

Return values

expr()

Parameters

Return values

from()

Query
in package

Application

implements ExpressionInterface, IteratorAggregate uses TypeMapTrait