Класс WincacheEngine

clear()source public

clear( boolean $check )

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

Параметры

boolean $check

Если true, ничего не будет очищено, так как записи естественным образом истекают в wincache..

Возвращает

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

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

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

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

Возвращает

mixed

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

write()source public

write( string $key , mixed $value )

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

Параметры

строка $key

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

смешанный $value

Данные, которые нужно кэшировать.

Возвращает

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

_key()source protected

_key( string $key )

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

Параметры

строка $key

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

Возвращает

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

Выбрасывает

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

add()source public

add( string $key , mixed $value )

Добавить ключ в кэш, если он еще не существует.

По умолчанию используется неатомарная реализация. Подклассы должны предпочитать атомарные реализации.

Параметры

строка $key

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

смешанный $value

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

Возвращает

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

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
ключ или ложь

readMany()source public

readMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

массив

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

warning()source protected

warning( string $message )

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

Параметры

строка $message

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

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 optional false

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

Выбрасывает

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() вместо.

Параметры

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

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

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

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

boolean $merge optional true

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

Возвращает

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

Выбрасывает

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

Параметры

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

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

смешанный тип|null $value optional 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');

Параметры

строка|null $key optional null

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

смешанный тип $default optional null

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

Возвращает

смешанный тип
Значение считываемой конфигурации.

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

Параметры

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

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

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

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

boolean $merge optional true

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

Возвращает

$this

Выбрасывает

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

[]