Класс 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.

Параметры

логический $check

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

Возвращает

boolean
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 optional 1

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

Возвращает

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

delete()source public

delete( string $key )

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

Параметры

строка $key

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

Возвращает

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

groups()source public

groups( )

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

Возвращает

array

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

Cake\Cache\CacheEngine::groups()

increment()source public

increment( string $key , integer $offset 1 )

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

Параметры

строка $key

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

целое число $offset optional 1

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

Возвращает

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

init()source public

init( array $config [] )

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

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

Параметры

массив $config optional []

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

Возвращает

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

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

Cake\Cache\CacheEngine::init()

read()source public

read( string $key )

Прочитать ключ из кеша

Параметры

строка $key

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

Возвращает

mixed

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

write()source public

write( string $key , mixed $value )

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

Параметры

строка $key

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

смешанный $value

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

Возвращает

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

_key()source protected

_key( string $key )

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

Параметры

строка $key

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

Возвращает

mixed
string $key или false

Исключения

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

deleteMany()source public

deleteMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

array

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

gc()source public

gc( integer|null $expires null )

Сбор мусора

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

Параметры

integer|null $expires необязательно null

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

key()source public

key( string $key )

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

Параметры

string $key

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

Возвращает

boolean|string
строковый ключ или false

readMany()source public

readMany( array $keys )

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

Параметры

array $keys

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

Возвращает

array

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

writeMany()source public

writeMany( array $data )

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

Параметры

array $data

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

Возвращает

array
Массив булевых значений для каждого ключа, 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

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

Параметры

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->config('key', $value);

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

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

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

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

Параметры

string|array $key

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

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

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

Возвращает

$this Объект.

[]