Класс ApcuEngine

add()source public

add( string $key , mixed $value )

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

Параметры

строка $key

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

смешанный тип $value

Данные для кэширования.

Возвращает

boolean
True, если данные были успешно кэшированы, false в случае ошибки.

Ссылка

https://secure.php.net/manual/en/function.apcu-add.php

Переопределяет

Cake\Cache\CacheEngine::add()

clear()source public

clear( boolean $check )

Удаляет все ключи из кэша. Очищает все конфигурации кэша, использующие APC.

Параметры

boolean $check

Если true, ничего не очищается, так как записи удаляются из APC по истечении срока действия. Этот флаг используется только FileEngine.

Возвращает

boolean
True Возвращает true.

Ссылка

https://secure.php.net/manual/en/function.apcu-cache-info.php
https://secure.php.net/manual/en/function.apcu-delete.php

clearGroup()source public

clearGroup( string $group )

Увеличивает значение группы, чтобы имитировать удаление всех ключей в группе. Старые значения останутся в хранилище до истечения срока действия.

Параметры

строка $group

Группа для очистки.

Возвращает

boolean
успех

Переопределяет

Cake\Cache\CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset = 1 )

Уменьшает значение целочисленного кэшированного ключа

Параметры

строка $key

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

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

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

Возвращает

boolean|целое число
Новое уменьшенное значение, false в противном случае

Ссылка

https://secure.php.net/manual/en/function.apcu-dec.php

delete()source public

delete( string $key )

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

Параметры

строка $key

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

Возвращает

boolean
True, если значение было успешно удалено, false, если оно не существовало или не удалось удалить

Ссылка

https://secure.php.net/manual/en/function.apcu-delete.php

groups()source public

groups( )

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

Возвращает

массив

Ссылка

https://secure.php.net/manual/en/function.apcu-fetch.php
https://secure.php.net/manual/en/function.apcu-store.php

Переопределяет

Cake\Cache\CacheEngine::groups()

increment()source public

increment( string $key , integer $offset = 1 )

Увеличивает значение целочисленного кэшированного ключа

Параметры

строка $key

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

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

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

Возвращает

boolean|целое число
Новое увеличенное значение, false в противном случае

Ссылка

https://secure.php.net/manual/en/function.apcu-inc.php

init()source public

init( array $config = [] )

Инициализирует движок кэширования

Вызывается автоматически передним фронтендом кэша

Параметры

массив $config необязательно []

массив настроек для движка

Возвращает

boolean
True, если движок был успешно инициализирован, false в противном случае

Переопределяет

Cake\Cache\CacheEngine::init()

read()source public

read( string $key )

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

Параметры

строка $key

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

Возвращает

смешанный тип

Кэшированные данные или false, если данные не существуют, истекли или произошла ошибка при их извлечении

Ссылка

https://secure.php.net/manual/en/function.apcu-fetch.php

write()source public

write( string $key , mixed $value )

Записывает данные для ключа в кэш

Параметры

строка $key

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

смешанный тип $value

Данные для кэширования

Возвращает

boolean
True, если данные были успешно кэшированы, false в случае ошибки

Ссылка

https://secure.php.net/manual/en/function.apcu-store.php

_key()source protected

_key( string $key )

Генерирует безопасный ключ, учитывая конфигурированный префикс ключа

Параметры

string $key

переданный ключ

Возвращает

mixed
строка $key или false

Исключения

InvalidArgumentException
Если значение ключа пустое

deleteMany()source public

deleteMany( array $keys )

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

Параметры

массив $keys

Массив идентификаторов данных

Возвращает

массив

Для каждого предоставленного ключа кэша (в качестве ключа массива) true, если значение было успешно удалено, false, если оно не существовало или не могло быть удалено

gc()source public

gc( integer|null $expires = null )

Сбор мусора

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

Параметры

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

[необязательно] Отметка времени истечения срока действия, делающая недействительными все данные до неё.

key()source public

key( string $key )

Генерирует безопасный ключ для использования с движками кэширования.

Параметры

string $key

переданный ключ

Возвращает

boolean|string
строка ключа или false

readMany()source public

readMany( array $keys )

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

Параметры

массив $keys

Массив идентификаторов данных

Возвращает

массив

Для каждого ключа кэша (указанного в качестве ключа массива) связанные данные кэша или false, если данных нет, они истекли или произошла ошибка при их извлечении

warning()source protected

warning( string $message )

Движки кэша могут генерировать предупреждения, если при работе возникают ошибки, если параметр warnOnWriteFailures установлен в true.

Параметры

string $message

Сообщение предупреждения.

writeMany()source public

writeMany( array $data )

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

Параметры

массив $data

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

Возвращает

массив
логическое значение для каждого предоставленного ключа, true, если данные были успешно кэшированы, false при ошибке

_configDelete()source protected

_configDelete( string $key )

Удаляет один ключ конфигурации.

Параметры

string $key

Ключ для удаления.

Исключения

Cake\Core\Exception\Exception
при попытке перезаписи существующей конфигурации

_configRead()source protected

_configRead( string|null $key )

Читает ключ конфигурации.

Параметры

string|null $key

Ключ для чтения.

Возвращает

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Записывает ключ конфигурации.

Параметры

string|array $key

Ключ для записи.

mixed $value

Значение для записи.

boolean|string $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

Cake\Core\Exception\Exception
при попытке перезаписи существующей конфигурации

config()source public deprecated

config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )

Получает/устанавливает конфигурацию.

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

Чтение всей конфигурации:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Устаревшая

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

string|array|null $key необязательно null

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

mixed|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

mixed
Значение конфигурации для чтения или сам объект при операциях записи.

Исключения

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

configShallow()source public

configShallow( string|array $key , mixed|null $value = null )

Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определенного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

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

mixed|null $value необязательно null

Значение для установки.

Возвращает

$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

Возвращает конфигурацию.

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

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key необязательно null

Ключ для получения или null для всей конфигурации.

mixed $default необязательно null

Возвращаемое значение, когда ключ не существует.

Возвращает

mixed
Значение конфигурации для чтения.

setConfig()source public

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

Устанавливает конфигурацию.

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

Установка определенного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

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

mixed|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

$this

Исключения

Cake\Core\Exception\Exception
При попытке установить недопустимый ключ.

[]