Класс WincacheEngine

clear()source public

clear( boolean $check )

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

Параметры

boolean $check

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

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

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

clearGroup()source public

clearGroup( string $group )

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

Параметры

string $group

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

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

boolean
success

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

Cake\Cache\CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset 1 )

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

Параметры

string $key

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

integer $offset необязательно 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 необязательно 1

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

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

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

init()source public

init( array $config [] )

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

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

Параметры

array $config необязательно []

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

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

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 необязательно 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|строка $merge optional 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']);

Устарело

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

[]