Contains the characteristics for an object that is attached to a repository and can retrieve results based on any criteria.
\Cake\Datasource\QueryCacher|nullA query cacher instance if this query has caching enabled.
boolWhether the query is standalone or the product of an eager load operation.
callable[]List of formatter classes or callbacks that will post-process the results when fetched
arrayList of map-reduce routines that should be applied over the query result
arrayHolds any custom options passed using applyOptions that could not be processed by any method in this class.
\Cake\Datasource\RepositoryInterfaceInstance of a table object this query is bound to
iterable|nullA ResultSet.
Executes this query and returns a traversable object containing the results
Returns a key => value array representing a single aliased field that can be passed directly to the select() method.
Runs aliasField() for each field in the provided list and returns the result under a single array.
Sets the query instance to be an eager loaded query. If no argument is passed, the current configured query _eagerLoaded value is returned.
Returns the first result out of executing this query, if the query has not been executed before, it will set the limit clause to 1 for performance reasons.
Registers a new formatter callback function that is to be executed when trying to fetch the results from the database.
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.
Returns an array with the custom options that were applied to this query and that were not already processed by another method in this class.
Returns the default table object that will be used by this query, that is, the table that will appear in the from clause.
Register a new MapReduce routine to be executed on top of the database results Both the mapper and caller callable should be invokable objects.
Set the default Table object that will be used by this query and form the FROM clause.
__call(string $method, array $arguments)
Enables calling methods from the result set as if they were from this class
string $method the method to call
array $arguments list of arguments for the method to call
mixedBadMethodCallException_decorateResults(\Traversable $result)
Decorates the results iterator with MapReduce routines and formatters
\Traversable $result Original results
\Cake\Datasource\ResultSetInterface_decoratorClass()
Returns the name of the class to be used for decorating results
string_execute()
Executes this query and returns a traversable object containing the results
\Cake\Datasource\ResultSetInterfacealiasField(string $field, ?string $alias)
Returns a key => value array representing a single aliased field that can be passed directly to the select() method.
The key will contain the alias and the value the actual field name.
If the field is already aliased, then it will not be changed. If no $alias is passed, the default table for this query will be used.
string $field The field to alias
string|null $alias optional the alias used to prefix the field
arrayaliasFields(array $fields, ?string $defaultAlias)
Runs aliasField() for each field in the provided list and returns the result under a single array.
array $fields The fields to alias
string|null $defaultAlias optional The default alias
string[]all()
Fetch the results for this query.
Will return either the results set through setResult(), or execute this query and return the ResultSetDecorator object ready for streaming of results.
ResultSetDecorator is a traversable object that implements the methods found on Cake\Collection\Collection.
\Cake\Datasource\ResultSetInterfaceapplyOptions(array $options)
Populates or adds parts to current query clauses using an array.
This is handy for passing all query clauses at once.
array $options the options to be applied
$thiscache(mixed $key, mixed $config)
Enable result caching for this query.
If a query has caching enabled, it will do the following when executed:
// Simple string key + config
$query->cache('my_key', 'db_results');
// Function to generate key.
$query->cache(function ($q) {
$key = serialize($q->clause('select'));
$key .= serialize($q->clause('where'));
return md5($key);
});
// Using a pre-built cache engine.
$query->cache('my_key', $engine);
// Disable caching
$query->cache(false); \Closure|string|false $key Either the cache key or a function to generate the cache key. When using a function, this query instance will be supplied as an argument.
string|\Psr\SimpleCache\CacheInterface $config optional Either the name of the cache config to use, or a cache engine instance.
$thiseagerLoaded(bool $value)
Sets the query instance to be an eager loaded query. If no argument is passed, the current configured query _eagerLoaded value is returned.
bool $value Whether or not to eager load.
$thisfirst()
Returns the first result out of executing this query, if the query has not been executed before, it will set the limit clause to 1 for performance reasons.
$singleUser = $query->select(['id', 'username'])->first();
\Cake\Datasource\EntityInterface|array|nullThe first result from the ResultSet.
firstOrFail()
Get the first result from the executing query or raise an exception.
\Cake\Datasource\EntityInterface|arrayThe first result from the ResultSet.
Cake\Datasource\Exception\RecordNotFoundExceptionformatResults(?callable $formatter, mixed $mode)
Registers a new formatter callback function that is to be executed when trying to fetch the results from the database.
Formatting callbacks will get a first parameter, an object implementing \Cake\Collection\CollectionInterface, that can be traversed and modified at will.
Callbacks are required to return an iterator object, which will be used as the return value for this query's result. Formatter functions are applied after all the MapReduce routines for this query have been executed.
If the second argument is set to true, it will erase previous formatters and replace them with the passed first argument.
// Return all results from the table indexed by id
$query->select(['id', 'name'])->formatResults(function ($results) {
return $results->indexBy('id');
});
// Add a new column to the ResultSet
$query->select(['name', 'birth_date'])->formatResults(function ($results) {
return $results->map(function ($row) {
$row['age'] = $row['birth_date']->diff(new DateTime)->y;
return $row;
});
}); callable|null $formatter optional The formatting callable.
int|true $mode optional Whether or not to overwrite, append or prepend the formatter.
$thisInvalidArgumentExceptiongetIterator()
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.
\Cake\Datasource\ResultSetInterfacegetMapReducers()
Returns the list of previously registered map reduce routines.
arraygetOptions()
Returns an array with the custom options that were applied to this query and that were not already processed by another method in this class.
$query->applyOptions(['doABarrelRoll' => true, 'fields' => ['id', 'name']); $query->getOptions(); // Returns ['doABarrelRoll' => true]
arraygetRepository()
Returns the default table object that will be used by this query, that is, the table that will appear in the from clause.
\Cake\Datasource\RepositoryInterfacegetResultFormatters()
Returns the list of previously registered format routines.
callable[]isEagerLoaded()
Returns the current configured query _eagerLoaded value
boolmapReduce(?callable $mapper, ?callable $reducer, bool $overwrite)
Register a new MapReduce routine to be executed on top of the database results Both the mapper and caller callable should be invokable objects.
The MapReduce routing will only be run when the query is executed and the first result is attempted to be fetched.
If the third argument is set to true, it will erase previous map reducers and replace it with the arguments passed.
callable|null $mapper optional The mapper callable.
callable|null $reducer optional The reducing function.
bool $overwrite optional Set to true to overwrite existing map + reduce functions.
$thisrepository(\Cake\Datasource\RepositoryInterface $table)
Set the default Table object that will be used by this query and form the FROM clause.
\Cake\Datasource\RepositoryInterface|\Cake\ORM\Table $table The default table object to use
$thissetResult(iterable $results)
Set the result set for a query.
Setting the resultset of a query will make execute() a no-op. Instead of executing the SQL query and fetching results, the ResultSet provided to this method will be returned.
This method is most useful when combined with results stored in a persistent cache.
iterable $results The results this query should return.
$thistoArray()
Returns an array representation of the results after executing the query.
arrayA query cacher instance if this query has caching enabled.
\Cake\Datasource\QueryCacher|nullWhether the query is standalone or the product of an eager load operation.
boolList of formatter classes or callbacks that will post-process the results when fetched
callable[]List of map-reduce routines that should be applied over the query result
arrayHolds any custom options passed using applyOptions that could not be processed by any method in this class.
arrayInstance of a table object this query is bound to
\Cake\Datasource\RepositoryInterfaceA ResultSet.
When set, query execution will be bypassed.
iterable|null
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/trait-Cake.Datasource.QueryTrait.html