Класс CacheEngine
Двигатель кэширования для CakePHP
Непосредственные известные подклассы
ApcEngine, FileEngine, MemcachedEngine, MemcacheEngine, RedisEngine, WincacheEngine, XcacheEngineПакет: Cake\Cache
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение Cake/Cache/CacheEngine.php
Подробное описание методов
clearsource абстрактный public
clear( boolean $check )
Удаляет все ключи из кэша
Параметры
- boolean
$check - если true, будет проверяться срок действия, в противном случае удаляются все
Возвращает
booleanTrue, если кэш был успешно очищен, false в противном случае
clearGroupsource public
clearGroup( string $group )
Очищает все значения, принадлежащие группе. Реализующий движок решает, действительно ли удалять ключи или просто имитировать это, чтобы достичь того же результата.
Параметры
- string
$group - название группы, которая должна быть очищена
Возвращает
booleanbool
decrementsource абстрактный public
decrement( string $key , integer $offset 1 )
Уменьшает число по ключу и возвращает уменьшенное значение
Параметры
- string
$key - Идентификатор данных
- integer
$offsetнеобязательно 1 - На сколько уменьшить
Возвращает
NewУменьшенное значение, false в противном случае
deletesource абстрактный public
delete( string $key )
Удаляет ключ из кэша
Параметры
- string
$key - Идентификатор данных
Возвращает
booleanTrue, если значение было успешно удалено, false, если его не существовало или не удалось удалить
gcsource public
gc( integer $expires null )
Сбор мусора
Постоянно удаляет все истекшие и удаленные данные
Параметры
- integer
$expiresнеобязательно null - [необязательно] отметка времени истечения срока действия, аннулирующая все данные до.
groupssource public
groups( )
Выполняет необходимые инициализации для каждой группы и возвращает group value для каждой из них, это маркер, представляющий каждую группу в ключе кэша
Возвращает
arrayмассив
incrementsource абстрактный public
increment( string $key , integer $offset 1 )
Увеличивает число по ключу и возвращает увеличенное значение
Параметры
- string
$key - Идентификатор данных
- integer
$offsetнеобязательно 1 - На сколько увеличить
Возвращает
NewУвеличенное значение, false в противном случае
initsource public
init( array $settings array() )
Инициализирует движок кэширования
Вызывается автоматически интерфейсом кэширования
Параметры
- array
$settingsнеобязательно array() - Ассоциативный массив параметров для движка
Возвращает
booleanTrue, если движок был успешно инициализирован, false в противном случае
keysource public
key( string $key )
Генерирует безопасный ключ для использования с хранилищами движков кэширования.
Параметры
- string
$key - переданный ключ
Возвращает
mixedстрока $key или false
readsource абстрактный public
read( string $key )
Читает ключ из кэша
Параметры
- string
$key - Идентификатор данных
Возвращает
mixedДанные кэша или false, если данные не существуют, истекли или произошла ошибка при их извлечении
writesource абстрактный public
write( string $key , mixed $value , integer $duration )
Записывает значение для ключа в кэш
Параметры
- string
$key - Идентификатор данных
- mixed
$value - Данные, которые нужно кэшировать
- integer
$duration - Срок кэширования.
Возвращает
booleanTrue, если данные были успешно кэшированы, false в случае ошибки
Краткое описание свойств
© 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.
http://api.cakephp.org/2.7/class-CacheEngine.html