Класс CacheEngine
Двигатель хранения для кэширования CakePHP
Прямые подклассы
Пакет: Cake\Cache
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Cache/CacheEngine.php
Краткое описание свойств
-
$_groupPrefixprotectedstringСодержит скомпилированную строку со всеми префиксами групп, которые должны добавляться к каждому ключу в этом кэше
-
$settingspublicНастройки текущего экземпляра двигателяarray
Краткое описание методов
- add() publicЗаписывает значение для ключа в кэш, если он еще не существует
- Удаляет все ключи из кэша
- clearGroup() public
Очищает все значения, принадлежащие группе. Реализующий движок должен решить, действительно ли удалять ключи или просто имитировать это, чтобы достичь того же результата.
- Уменьшает число по ключу и возвращает уменьшенное значение
- Удаляет ключ из кэша
- gc() publicСбор мусора
- groups() public
Выполняет необходимые операции инициализации для каждой группы и возвращает
group valueдля каждой из них, это маркер, представляющий каждую группу в ключе кэша - Увеличивает число по ключу и возвращает увеличенное значение
- init() publicИнициализирует кэш-движок
- key() publicГенерирует безопасный ключ для использования с хранилищами кэш-движков.
- Считывает ключ из кэша
- settings() publicНастройки кэш-движка
- Записывает значение для ключа в кэш
Подробное описание методов
add()source public
add( string $key , mixed $value , integer $duration )
Записывает значение для ключа в кэш, если он еще не существует
Параметры
- строка
$key - Идентификатор данных
- смешанный
$value - Данные для кэширования
- целое число
$duration - Срок кэширования.
Возвращает
booleanИстина, если данные были успешно кэшированы, ложь в случае ошибки
clear()source abstract public
clear( boolean $check )
Удаляет все ключи из кэша
Параметры
- boolean
$check - Если true, будет проверяться срок действия, в противном случае удаляются все
Возвращает
booleanИстина, если кэш был успешно очищен, ложь в противном случае
clearGroup()source public
clearGroup( string $group )
Очищает все значения, принадлежащие группе. Реализующий движок должен решить, действительно ли удалять ключи или просто имитировать это, чтобы достичь того же результата.
Параметры
- строка
$group - Имя группы, подлежащей очистке
Возвращает
booleandecrement()source abstract public
decrement( string $key , integer $offset 1 )
Уменьшает число по ключу и возвращает уменьшенное значение
Параметры
- строка
$key - Идентификатор данных
- целое число
$offsetнеобязательно 1 - На сколько уменьшить
Возвращает
Новоеуменьшенное значение, ложь в противном случае
delete()source abstract public
delete( string $key )
Удаляет ключ из кэша
Параметры
- строка
$key - Идентификатор данных
Возвращает
booleanИстина, если значение было успешно удалено, ложь, если его не существовало или не удалось удалить
gc()source public
gc( integer $expires null )
Сбор мусора
Постоянно удаляет все устаревшие и удаленные данные
Параметры
- целое число
$expiresнеобязательно null - [необязательно] Отметка времени истечения срока действия, аннулируя все данные до нее.
groups()source public
groups( )
Выполняет необходимые операции инициализации для каждой группы и возвращает group value для каждой из них, это маркер, представляющий каждую группу в ключе кэша
Возвращает
arrayincrement()source abstract public
increment( string $key , integer $offset 1 )
Увеличивает число по ключу и возвращает увеличенное значение
Параметры
- строка
$key - Идентификатор данных
- целое число
$offsetнеобязательно 1 - На сколько увеличить
Возвращает
Новоеувеличенное значение, ложь в противном случае
init()source public
init( array $settings array() )
Инициализирует кэш-движок
Вызывается автоматически фронтендом кэша
Параметры
- массив
$settingsнеобязательно array() - Ассоциативный массив параметров для двигателя
Возвращает
booleanИстина, если движок был успешно инициализирован, ложь в противном случае
key()source public
key( string $key )
Генерирует безопасный ключ для использования с хранилищами кэш-движков.
Параметры
- строка
$key - переданный ключ
Возвращает
смешанныйстрока $key или ложь
read()source abstract public
read( string $key )
Считывает ключ из кэша
Параметры
- строка
$key - Идентификатор данных
Возвращает
смешанныйКэшированные данные или ложь, если данных нет, истек срок действия или произошла ошибка при их извлечении
write()source abstract public
write( string $key , mixed $value , integer $duration )
Записать значение для ключа в кэш
Параметры
- string
$key - Идентификатор данных
- mixed
$value - Данные, которые необходимо кешировать
- integer
$duration - Срок хранения.
Возвращает
booleanTrue, если данные были успешно помещены в кэш, false в случае ошибки
Подробное описание свойств
$_groupPrefixsource
protected string
Содержит скомпилированную строку со всеми префиксами групп, которые необходимо добавить к каждому ключу в этом движке кэша
null
© 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-CacheEngine.html