Класс WincacheEngine
Двигатель хранения Wincache для кэша
- CacheEngine
-
WincacheEngine
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Cache/Engine/WincacheEngine.php
Краткое описание свойств
-
$_compiledGroupNamesprotectedarrayСодержит скомпилированные имена групп (с префиксом глобального префикса конфигурации)
Унаследованные свойства
Краткое описание методов
- add() public
Записывает данные для ключа в кэш, если они еще не существуют. Если они уже существуют, попытка завершается ошибкой и возвращает false.
- clear() public
Удаляет все ключи из кэша. Это очистит все элементы в кэше, соответствующие префиксу конфигурации кэша.
- clearGroup() public
Увеличивает значение группы, чтобы смоделировать удаление всех ключей в группе. Старые значения останутся в хранилище до истечения срока действия.
- decrement() publicУменьшает значение целочисленного кэшированного ключа
- delete() publicУдаляет ключ из кэша
- groups() public
Возвращает
group valueдля каждой из настроенных групп. Если начальное значение группы не найдено, то группа инициализируется соответствующим образом. - increment() publicУвеличивает значение целочисленного кэшированного ключа
- init() publicИнициализация движка кэширования
- read() publicЧтение ключа из кэша
- write() publicЗапись данных для ключа в кэш
Подробное описание методов
add()source public
add( string $key , mixed $value , integer $duration )
Записывает данные для ключа в кэш, если они еще не существуют. Если они уже существуют, попытка завершается ошибкой и возвращает false.
Параметры
- строка
$key - Идентификатор данных.
- смешанный
$value - Данные для кэширования.
- целое число
$duration - Время кэширования данных в секундах.
Возвращает
booleanTrue, если данные успешно кэшированы, false при ошибке.
Переопределяет
CacheEngine::add() clear()source public
clear( boolean $check )
Удаляет все ключи из кэша. Это очистит все элементы в кэше, соответствующие префиксу конфигурации кэша.
Параметры
- boolean
$check Если true, ничего не будет очищено, так как записи естественным образом истекут в wincache.
Возвращает
booleanTrue Возвращает true.
clearGroup()source public
clearGroup( string $group )
Увеличивает значение группы, чтобы смоделировать удаление всех ключей в группе. Старые значения останутся в хранилище до истечения срока действия.
Параметры
- строка
$group - Группа для очистки.
Возвращает
booleanуспех
Переопределяет
CacheEngine::clearGroup() decrement()source public
decrement( string $key , integer $offset 1 )
Уменьшает значение целочисленного кэшированного ключа
Параметры
- строка
$key - Идентификатор данных
- целое число
$offsetопционально 1 - На сколько уменьшить
Возвращает
Новоеуменьшенное значение, иначе false
delete()source public
delete( string $key )
Удаляет ключ из кэша
Параметры
- строка
$key - Идентификатор данных
Возвращает
booleanTrue, если значение было успешно удалено, false, если его не существовало или не удавалось удалить
groups()source public
groups( )
Возвращает group value для каждой из настроенных групп. Если начальное значение группы не найдено, то группа инициализируется соответствующим образом.
Возвращает
массивПереопределяет
CacheEngine::groups() increment()source public
increment( string $key , integer $offset 1 )
Увеличивает значение целочисленного кэшированного ключа
Параметры
- строка
$key - Идентификатор данных
- целое число
$offsetопционально 1 - На сколько увеличить
Возвращает
Новоеувеличенное значение, иначе false
init()source public
init( array $settings array() )
Инициализация движка кэширования
Вызывается автоматически передним фронт-эндом кэша. Для повторной инициализации настроек вызовите Cache::engine('EngineName', [опционально] settings = array());
Параметры
- массив
$settingsопционально array() - массив настроек для движка
Возвращает
booleanTrue, если движок был успешно инициализирован, false в противном случае
См. также
CacheEngine::__defaultsПереопределяет
CacheEngine::init() read()source public
read( string $key )
Чтение ключа из кэша
Параметры
- строка
$key - Идентификатор данных
Возвращает
смешанныйКэшированные данные или false, если данных нет, они истекли или произошла ошибка при их получении
write()source public
write( string $key , mixed $value , integer $duration )
Запись данных для ключа в кэш
Параметры
- строка
$key - Идентификатор данных
- смешанный
$value - Данные для кэширования
- целое число
$duration - Время кэширования данных в секундах
Возвращает
booleanTrue, если данные были успешно кэшированы, false в противном случае
Наследуемые методы от CacheEngine
gc()source public
gc( integer $expires null )
Сбор мусора
Постоянно удаляет все просроченные и удалённые данные
Параметры
- целое число
$expiresопционально null - [опционально] Маркер времени истечения срока действия, делая недействительными все данные до него.
key()source public
key( string $key )
Генерирует безопасный ключ для использования с движками кэширования.
Параметры
- строка
$key - Переданный ключ
Возвращает
смешанныйстрока $key или false
Подробное описание свойств
$_compiledGroupNamessource
protected array
Содержит скомпилированные имена групп (с префиксом из глобальной конфигурации)
array()
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.9/class-WincacheEngine.html