W3cubDocs

Class QueryCacher

Handles caching queries and loading results from the cache.

Used by Cake\Datasource\QueryTrait internally.

Namespace: Cake\Datasource
See: \Cake\Datasource\QueryTrait::cache() for the public interface.
Location: Datasource/QueryCacher.php

Properties summary

$_config protected

string|Cake\Cache\CacheEngine
Config for cache engine.
$_key protected

string|callable
The key or function to generate a key.

Method Summary

__construct() public
Constructor.
_resolveCacher() protected
Get the cache engine.
_resolveKey() protected
Get/generate the cache key.
fetch() public
Load the cached results from the cache or run the query.
store() public
Store the result set into the cache.

Method Detail

__construct()source public

__construct( string|Closure $key , string|Cake\Cache\CacheEngine $config )

Constructor.

Parameters

string|Closure $key: The key or function to generate a key.
string|Cake\Cache\CacheEngine $config: The cache config name or cache engine instance.

Throws

RuntimeException

_resolveCacher()source protected

_resolveCacher( )

Get the cache engine.

Returns

Cake\Cache\CacheEngine

_resolveKey()source protected

_resolveKey( object $query )

Get/generate the cache key.

Parameters

object $query: The query to generate a key for.

Returns

string

Throws

RuntimeException

fetch()source public

fetch( object $query )

Load the cached results from the cache or run the query.

Parameters

object $query: The query the cache read is for.

Returns

Cake\ORM\ResultSet|null
Either the cached results or null.

store()source public

store( object $query , Traversable $results )

Store the result set into the cache.

Parameters

object $query: The query the cache read is for.
Traversable $results: The result set to store.

Returns

boolean
True if the data was successfully cached, false on failure

Properties detail

$_configsource

protected string|Cake\Cache\CacheEngine

Config for cache engine.

$_keysource

protected string|callable

The key or function to generate a key.

© 2005–2017 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/3.4/class-Cake.Datasource.QueryCacher.html