Класс 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 необязательно 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, если данные не существуют, истекли или произошла ошибка при их извлечении

warning()source protected

warning( string $message )

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

Параметры

строка $message

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

writeMany()source public

writeMany( array $data )

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

Параметры

массив $data

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

Возвращает

массив
значений true или false для каждого ключа, 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 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 необязательно 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->configShallow('key', $value);

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

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

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

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

Параметры

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

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

смешанное|null $value необязательно 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 необязательно null

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

смешанное $default необязательно null

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

Возвращает

смешанное
Данные конфигурации по указанному ключу или 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 необязательно null

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

boolean $merge необязательно true

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

Возвращает

$this

Выбрасывает

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

[]