Класс ApcEngine

addисходный код 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исходный код public

clear( boolean $check )

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

Параметры

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

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

Возвращает

boolean
True.

clearGroupисходный код public

clearGroup( string $group )

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

Параметры

строка $group

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

Возвращает

boolean
успешно

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

Cake\Cache\CacheEngine::clearGroup()

decrementисходный код public

decrement( string $key , integer $offset 1 )

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

Параметры

строка $key

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

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

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

Возвращает

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

deleteисходный код public

delete( string $key )

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

Параметры

строка $key

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

Возвращает

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

groupsисходный код public

groups( )

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

Возвращает

array
массив

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

Cake\Cache\CacheEngine::groups()

incrementисходный код public

increment( string $key , integer $offset 1 )

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

Параметры

строка $key

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

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

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

Возвращает

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

initисходный код public

init( array $config [] )

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

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

Параметры

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

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

Возвращает

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

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

Cake\Cache\CacheEngine::init()

readисходный код public

read( string $key )

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

Параметры

строка $key

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

Возвращает

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

writeисходный код public

write( string $key , mixed $value )

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

Параметры

строка $key

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

смешанный $value

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

Возвращает

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

_keyисходный код protected

_key( string $key )

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

Параметры

строка $key

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

Возвращает

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

Выбрасывает

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

deleteManyисходный код public

deleteMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

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

gcисходный код public

gc( integer|null $expires null )

Сбор мусора

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

Параметры

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

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

keyисходный код public

key( string $key )

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

Параметры

строка $key

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

Возвращает

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

readManyисходный код public

readMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

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

writeManyисходный код public

writeMany( array $data )

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

Параметры

массив $data

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

Возвращает

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

_configDeleteисходный код protected

_configDelete( string $key )

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

Параметры

строка $key

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

Выбрасывает

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

_configReadsource protected

_configRead( string|null $key )

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

Параметры

string|null $key

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

Возвращает

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

_configWritesource 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
при попытке перезаписи существующей конфигурации

configsource 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
При попытке установить неверный ключ.

configShallowsource 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

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

Возвращает

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

[]

[
    'duration' => 3600,
    'groups' => [],
    'prefix' => 'cake_',
    'probability' => 100
]

null

[]

false