Fr3nch13/CakePHP Utilities

__call()

Enables calling methods from the result set as if they were from this class

Parameters

$method : string

the method to call

$arguments : array<string|int, mixed>

list of arguments for the method to call

Tags

throws

BadMethodCallException

if no such method exists in result set

aliasField()

Returns a key => value array representing a single aliased field that can be passed directly to the select() method.

Parameters

$field : string

The field to alias

$alias : string|null = null

the alias used to prefix the field

aliasFields()

Runs `aliasField()` for each field in the provided list and returns the result under a single array.

Parameters

$fields : array<string|int, mixed>

The fields to alias

$defaultAlias : string|null = null

The default alias

all()

Fetch the results for this query.

cache()

Enable result caching for this query.

// 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);

Parameters

$key : Closure|string|false

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.

$config : CacheInterface|string = 'default'

Either the name of the cache config to use, or a cache engine instance.

eagerLoaded()

Sets the query instance to be an eager loaded query. If no argument is passed, the current configured query `_eagerLoaded` value is returned.

Parameters

$value : bool

Whether to eager load.

first()

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();

firstOrFail()

Get the first result from the executing query or raise an exception.

Tags

throws

RecordNotFoundException

When there is no first record.

formatResults()

Registers a new formatter callback function that is to be executed when trying to fetch the results from the database.

$query->select(['id', 'name'])->formatResults(function ($results) {
    return $results->indexBy('id');
});

$query->select(['name', 'birth_date'])->formatResults(function ($results) {
    return $results->map(function ($row) {
        $row['age'] = $row['birth_date']->diff(new DateTime)->y;

        return $row;
    });
});

$query->formatResults(function ($results, $query) {
    return $results->map(function ($row) use ($query) {
        $data = [
            'bar' => 'baz',
        ];

        if ($query->isHydrationEnabled()) {
            $row['foo'] = new Foo($data)
        } else {
            $row['foo'] = $data;
        }

        return $row;
    });
});

// Assuming a `Articles belongsTo Authors` association that uses the join strategy

$articlesQuery->contain('Authors', function ($authorsQuery) {
    return $authorsQuery->formatResults(function ($results, $query) use ($authorsQuery) {
        // Here `$authorsQuery` will always be the instance
        // where the callback was attached to.

        // The instance passed to the callback in the second
        // argument (`$query`), will be the one where the
        // callback is actually being applied to, in this
        // example that would be `$articlesQuery`.

        // ...

        return $results;
    });
});

Parameters

$formatter : callable|null = null

The formatting callable.

$mode : int|bool = self::APPEND

Whether to overwrite, append or prepend the formatter.

Tags

throws

InvalidArgumentException

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.

Tags

psalm-suppress

ImplementedReturnTypeMismatch

getMapReducers()

Returns the list of previously registered map reduce routines.

getOptions()

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]

Tags

see

QueryInterface::applyOptions()

to read about the options that will be processed by this class and not returned by this function

see

applyOptions()

getRepository()

Returns the default table object that will be used by this query, that is, the table that will appear in the from clause.

getResultFormatters()

Returns the list of previously registered format routines.

isEagerLoaded()

Returns the current configured query `_eagerLoaded` value

mapReduce()

Register a new MapReduce routine to be executed on top of the database results Both the mapper and caller callable should be invokable objects.

Parameters

$mapper : callable|null = null

The mapper callable.

$reducer : callable|null = null

The reducing function.

$overwrite : bool = false

Set to true to overwrite existing map + reduce functions.

Tags

see

MapReduce

for details on how to use emit data to the map reducer.

repository()

Set the default Table object that will be used by this query and form the `FROM` clause.

Parameters

$repository : RepositoryInterface|Table

The default table object to use

setResult()

Set the result set for a query.

Parameters

$results : iterable<string|int, mixed>

The results this query should return.

toArray()

Returns an array representation of the results after executing the query.