Класс Cache

_buildEnginesource protected static

_buildEngine( string $name )

Находит и создаёт экземпляр требуемого класса движка.

Параметры

string $name

Имя конфигурационного массива, для которого требуется экземпляр движка

Исключения

addsource public static

add( string $key , mixed $value , string $config 'default' )

Записывает данные для ключа в движок кэша, если он ещё не существует.

Использование:

Запись в активную конфигурацию кэша:

Cache::add('cached_data', $data);

Запись в определённую конфигурацию кэша:

Cache::add('cached_data', $data, 'long_term');

Параметры

string $key

Идентификатор данных.

mixed $value

Данные для кэширования — всё, кроме ресурсов.

string $config необязательно 'default'

Необязательное имя конфигурации для записи. По умолчанию 'default'.

Возвращает

clearsource public static

clear( boolean $check false , string $config 'default' )

Удаляет все ключи из кэша.

Параметры

boolean $check необязательно false

Если true, проверяет срок действия, иначе удаляет все

string $config необязательно 'default'

Имя конфигурации для использования. По умолчанию 'default'

Возвращает

clearGroupsource public static

clearGroup( string $group , string $config 'default' )

Удаляет все ключи из кэша, принадлежащие одной группе.

Параметры

string $group

Имя группы для очистки

string $config необязательно 'default'

Имя конфигурации для использования. По умолчанию 'default'

Возвращает

decrementsource public static

decrement( string $key , integer $offset 1 , string $config 'default' )

Уменьшает число по ключу и возвращает уменьшенное значение.

Параметры

string $key

Идентификатор данных

integer $offset необязательно 1

На сколько уменьшить

string $config необязательно 'default'

Необязательное имя конфигурации. По умолчанию 'default'

Возвращает

deletesource public static

delete( string $key , string $config 'default' )

Удаляет ключ из кэша.

Использование:

Удаление из активной конфигурации кэша.

Cache::delete('my_data');

Удаление из определённой конфигурации кэша.

Cache::delete('my_data', 'long_term');

Параметры

string $key

Идентификатор данных

string $config необязательно 'default'

Имя конфигурации для использования. По умолчанию 'default'

Возвращает

deleteManysource public static

deleteMany( array $keys , string $config 'default' )

Удаляет множество ключей из кэша.

Использование:

Удаление нескольких ключей из активной конфигурации кэша.

Cache::deleteMany(['my_data_1', 'my_data_2']);

Удаление из определённой конфигурации кэша.

Cache::deleteMany(['my_data_1', 'my_data_2], 'long_term');

Параметры

array $keys

Массив ключей кэша для удаления

string $config необязательно 'default'

Имя конфигурации для использования. По умолчанию 'default'

Возвращает

disablesource public static

disable( )

Отключает кэширование.

При отключении все операции с кэшем вернут null.

enablesource public static

enable( )

Включает кэширование.

Если кэширование было отключено с помощью Cache::disable(), этот метод отменит это действие.

enabledsource public static

enabled( )

Проверяет, включено ли кэширование.

Возвращает

enginesource public static

engine( string $config )

Извлекает движок, связанный с конкретным именем конфигурации.

Если движок кэша и конфигурация отсутствуют, будет выведено сообщение об ошибке.

Параметры

string $config

Имя конфигурации, для которой нужен движок.

Возвращает

gcsource public static

gc( string $config 'default' , integer|null $expires null )

Сбор мусора

Постоянно удаляет все истекшие и удалённые данные

Параметры

строка $config необязательный 'default'

[необязательно] Имя конфигурации, которую нужно собрать мусор. По умолчанию 'default'

целое число|null $expires необязательный null

[необязательно] Отметка времени истечения. По умолчанию NULL

groupConfigssource public static

groupConfigs( string|null $group null )

Получение отображения группировки имён конфигурации.

Cache::config('daily', ['duration' => '1 day', 'groups' => ['posts']]);
Cache::config('weekly', ['duration' => '1 week', 'groups' => ['posts', 'archive']]);
$configs = Cache::groupConfigs('posts');

$configs будут равны ['posts' => ['daily', 'weekly']] Вызов этого метода загрузит все настроенные движки.

Параметры

строка|null $group необязательный null

имя группы или null для получения всех сопоставлений групп

Возвращает

Изначает

incrementsource public static

increment( string $key , integer $offset 1 , string $config 'default' )

Увеличить число по ключу и вернуть увеличенное значение.

Параметры

строка $key

Идентификатор данных

целое число $offset необязательный 1

На сколько увеличить

строка $config необязательный 'default'

Необязательное имя конфигурации. По умолчанию 'default'

Возвращает

readsource public static

read( string $key , string $config 'default' )

Чтение ключа из кэша.

Использование:

Чтение из активной конфигурации кэша.

Cache::read('my_data');

Чтение из определенной конфигурации кэша.

Cache::read('my_data', 'long_term');

Параметры

строка $key

Идентификатор данных

строка $config необязательный 'default'

необязательное имя конфигурации для использования. По умолчанию 'default'

Возвращает

readManysource public static

readMany( array $keys , string $config 'default' )

Чтение нескольких ключей из кэша.

Использование:

Чтение нескольких ключей из активной конфигурации кэша.

Cache::readMany(['my_data_1', 'my_data_2]);

Чтение из определенной конфигурации кэша.

Cache::readMany(['my_data_1', 'my_data_2], 'long_term');

Параметры

массив $keys

массив ключей для извлечения из кэша

строка $config необязательный 'default'

необязательное имя конфигурации для использования. По умолчанию 'default'

Возвращает

registrysource public static

registry( Cake\Core\ObjectRegistry $registry null )

Возвращает экземпляр Реестра кэша, используемый для создания и использования адаптеров кэша. Также позволяет вводить новый экземпляр реестра.

Параметры

Cake\Core\ObjectRegistry $registry необязательный null

Вводимый объект реестра.

Возвращает

remembersource public static

remember( string $key , callable $callable , string $config 'default' )

Предоставляет возможность легко выполнять кэширование с чтением.

При вызове, если $key не задан в $config, будет вызван $callable function. Результаты затем будут сохранены в конфигурации кэша по ключу.

Примеры:

Использование замыкания для предоставления данных, предположим, что $this — это объект Table:

$results = Cache::remember('all_articles', function () {
     return $this->find('all');
});

Параметры

строка $key

Ключ кэша для чтения/хранения данных.

вызываемый $callable

Вызываемый объект, который предоставляет данные в случае, если ключ кэша пуст. Может быть любого типа вызываемого объекта, поддерживаемого PHP.

строка $config необязательный 'default'

Конфигурация кэша для использования в этой операции. По умолчанию default.

Возвращает

writesource public static

write( string $key , mixed $value , string $config 'default' )

Запись данных для ключа в кэш.

Использование:

Запись в активную конфигурацию кэша:

Cache::write('cached_data', $data);

Запись в определенную конфигурацию кэша:

Cache::write('cached_data', $data, 'long_term');

Параметры

строка $key

Идентификатор данных

смешанный $value

Данные, которые нужно кэшировать — всё, кроме ресурса

строка $config необязательный 'default'

Необязательное имя конфигурации для записи. По умолчанию 'default'

Возвращает

writeManysource public static

writeMany( array $data , string $config 'default' )

Запись данных для многих ключей в кэш.

Использование:

Запись в активную конфигурацию кэша:

Cache::writeMany(['cached_data_1' => 'data 1', 'cached_data_2' => 'data 2']);

Запись в определенную конфигурацию кэша:

Cache::writeMany(['cached_data_1' => 'data 1', 'cached_data_2' => 'data 2'], 'long_term');

Параметры

массив $data

Массив данных, которые нужно сохранить в кэше

строка $config необязательный 'default'

Необязательное имя конфигурации для записи. По умолчанию 'default'

Возвращает

Изначает

configsource public static

config( string|array $key , array $config null )

Этот метод может быть использован для определения конфигураций адаптеров для приложения или чтения существующих конфигураций.

Чтобы изменить конфигурацию адаптера во время выполнения, сначала удалите адаптер, а затем переконфигурируйте его.

Адаптеры не будут построены, пока не будет выполнена первая операция.

Использование

Предполагая, что имя класса Cache следующие сценарии поддерживаются:

Чтение конфигурационных данных обратно:

Cache::config('default');

Настройка движка кэша.

Cache::config('default', $settings);

Ввод построенного адаптера:

Cache::config('default', $instance);

Конфигурирование нескольких адаптеров одновременно:

Cache::config($arrayOfConfig);

Параметры

строка|массив $key

Имя конфигурации или массив нескольких конфигураций.

массив $config необязательный null

Массив имя => конфигурационные данные для адаптера.

Возвращает

Изначает

configuredsource public static

configured( )

Возвращает массив, содержащий именованные конфигурации

Возвращает

dropsource public static

drop( string $config )

Удаляет созданный адаптер.

Если вы хотите изменить существующую конфигурацию, вы должны удалить её, изменить конфигурацию и затем снова добавить её.

Если реализующие объекты поддерживают объект $_registry, то указанная конфигурация также будет выгружена из реестра.

Параметры

string $config

Существующая конфигурация, которую вы хотите удалить.

Возвращает

dsnClassMapsource public static

dsnClassMap( array $map null )

Возвращает или обновляет карту классов DSN для этого класса

Параметры

array $map optional null

Добавления/изменения в карте классов для применения

Возвращает

parseDsnsource public static

parseDsn( string $dsn )

Парсит DSN в корректную конфигурацию подключения

Этот метод позволяет установить DSN, используя формат, аналогичный тому, который используется PEAR::DB. Вот пример его использования:

$dsn = 'mysql://user:pass@localhost/database?';
$config = ConnectionManager::parseDsn($dsn);

$dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS';
$config = Log::parseDsn($dsn);

$dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null';
$config = Email::parseDsn($dsn);

$dsn = 'file:///?className=\My\Cache\Engine\FileEngine';
$config = Cache::parseDsn($dsn);

$dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/';
$config = Cache::parseDsn($dsn);

Для всех классов значение scheme устанавливается в качестве значения обоих className, если они не были указаны иначе.

Обратите внимание, что аргументы строки запроса также анализируются и устанавливаются в качестве значений в возвращаемой конфигурации.

Параметры

string $dsn

Строка DSN, которую необходимо преобразовать в массив конфигурации

Возвращает

Выбрасывает