Класс ApcEngine

add()source public

add( string $key , mixed $value )

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

Параметры

строка $key

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

смешанный $value

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

Возвращает

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

Ссылка

http://php.net/manual/en/function.apc-add.php

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

Cake\Cache\CacheEngine::add()

clear()source public

clear( boolean $check )

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

Параметры

boolean $check

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

Возвращает

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

clearGroup()source public

clearGroup( string $group )

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

Параметры

строка $group

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

Возвращает

boolean
success

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

Cake\Cache\CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset 1 )

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

Параметры

строка $key

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

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

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

Возвращает

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

delete()source public

delete( string $key )

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

Параметры

строка $key

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

Возвращает

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

groups()source public

groups( )

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

Возвращает

массив

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

Cake\Cache\CacheEngine::groups()

increment()source public

increment( string $key , integer $offset 1 )

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

Параметры

строка $key

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

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

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

Возвращает

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

init()source public

init( array $config [] )

Инициализирует кэш-двигатель

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

Параметры

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

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

Возвращает

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

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

Cake\Cache\CacheEngine::init()

read()source public

read( string $key )

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

Параметры

строка $key

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

Возвращает

смешанный

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

write()source public

write( string $key , mixed $value )

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

Параметры

строка $key

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

смешанный $value

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

Возвращает

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

_key()source protected

_key( string $key )

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

Параметры

строка $key

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

Возвращает

смешанный
строка $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 )

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

Параметры

строка $key

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

Возвращаемое значение

boolean|string
ключ или false

readMany()source public

readMany( array $keys )

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

Параметры

массив $keys

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

Возвращаемое значение

массив

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

writeMany()source public

writeMany( array $data )

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

Параметры

массив $data

Массив данных для хранения в кэше

Возвращаемое значение

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

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

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

Выбрасывает

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

_configRead()source protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка|null $key

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

Возвращаемое значение

смешанное

_configWrite()source protected

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

Запись переменной конфигурации

Параметры

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

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

смешанное $value

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

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

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

Выбрасывает

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

config()source public

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']);

Параметры

строка|массив|null $key необязательный null

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

смешанное|null $value необязательный null

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

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

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

Возвращаемое значение

смешанное
Чтение значения конфигурации, или сам объект при операциях записи.

Выбрасывает

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

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

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

смешанное|null $value необязательный null

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

Возвращаемое значение

$this Сам объект.

[]