Класс WincacheEngine
Двигатель хранилища Wincache для кэша
- CacheEngine
-
WincacheEngine
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://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 )
Удаляет все ключи из кэша. Это очистит все элементы в кэше, соответствующие префиксу конфигурации кэша.
Параметры
- логическое значение
$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–2017 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.10/class-WincacheEngine.html