Класс WincacheEngine

clear()source public

clear( boolean $check )

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

Параметры

boolean $check

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

Возвращает

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

clearGroup()source public

clearGroup( string $group )

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

Параметры

string $group

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

Возвращает

boolean
успех

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

Cake\Cache\CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset 1 )

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

Параметры

string $key

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

integer $offset optional 1

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

Возвращает

boolean|integer
Новое уменьшенное значение, иначе false

delete()source public

delete( string $key )

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

Параметры

string $key

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

Возвращает

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

groups()source public

groups( )

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

Возвращает

array

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

Cake\Cache\CacheEngine::groups()

increment()source public

increment( string $key , integer $offset 1 )

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

Параметры

string $key

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

integer $offset optional 1

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

Возвращает

boolean|integer
Новое увеличенное значение, иначе false

init()source public

init( array $config [] )

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

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

Параметры

array $config optional []

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

Возвращает

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

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

Cake\Cache\CacheEngine::init()

read()source public

read( string $key )

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

Параметры

string $key

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

Возвращает

mixed

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

write()source public

write( string $key , mixed $value )

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

Параметры

string $key

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

mixed $value

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

Возвращает

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

_key()source protected

_key( string $key )

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

Параметры

string $key

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

Возвращает

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

Вызывает

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

add()source public

add( string $key , mixed $value )

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

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

Параметры

string $key

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

mixed $value

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

Возвращает

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

deleteMany()source public

deleteMany( array $keys )

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

Параметры

array $keys

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

Возвращает

array

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

gc()source public

gc( integer|null $expires null )

Сбор мусора

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

Параметры

integer|null $expires optional 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

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

Возвращает

массив
значений boolean для каждого предоставленного ключа, 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|строка $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 Сам объект.

[]