Класс XcacheEngine
Движок кэширования Xcache для кэша
- CacheEngine
-
XcacheEngine
Авторские права: Авторские права (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Ссылка: Xcache
Расположение Cake/Cache/Engine/XcacheEngine.php
Подробное описание методов
_authисходный код protected
_auth( boolean $reverse false )
Заполняет и инвертирует значения аутентификации $_SERVER. Вносит необходимые изменения (и отменяет их) в $_SERVER.
Это необходимо, так как xcache_clear_cache() должен передавать Basic Http Auth (см. настройки конфигурации xcache.admin).
Параметры
- boolean
$reverseнеобязательно false - Вернуть изменения
clearисходный код public
clear( boolean $check )
Удалить все ключи из кэша
Параметры
- boolean
$check - Если true, удаления не будут выполняться, а CakePHP будет полагаться на значения TTL ключей.
Возвращает
booleanTrue, если кэш был успешно очищен, иначе false
clearGroupисходный код public
clearGroup( string $group )
Увеличивает значение группы, чтобы имитировать удаление всех ключей в группе. Старые значения останутся в хранилище до их истечения.
Параметры
- string
$group - Группа для очистки.
Возвращает
booleanУспех
Переопределяет
CacheEngine::clearGroup() decrementисходный код public
decrement( string $key , integer $offset 1 )
Уменьшает значение целочисленного кэшированного ключа. Если ключ кэша не является целым числом, он будет обработан как 0.
Параметры
- string
$key - Идентификатор данных
- integer
$offsetнеобязательно 1 - На сколько уменьшить
Возвращает
NewУменьшенное значение, иначе false
deleteисходный код public
delete( string $key )
Удалить ключ из кэша
Параметры
- string
$key - Идентификатор данных
Возвращает
booleanTrue, если значение было успешно удалено, false, если его не существовало или не удалось удалить
groupsисходный код public
groups( )
Возвращает group value для каждой из настроенных групп. Если начальное значение группы не найдено, оно инициализируется соответствующим образом.
Возвращает
arrayмассив
Переопределяет
CacheEngine::groups() incrementисходный код public
increment( string $key , integer $offset 1 )
Увеличивает значение целочисленного кэшированного ключа. Если ключ кэша не является целым числом, он будет обработан как 0.
Параметры
- string
$key - Идентификатор данных
- integer
$offsetнеобязательно 1 - На сколько увеличить
Возвращает
NewУвеличенное значение, иначе false
initисходный код public
init( array $settings array() )
Инициализировать движок кэширования
Вызывается автоматически фронтэндом кэша. Для повторной инициализации настроек вызовите Cache::engine('EngineName', [необязательные] settings = array());
Параметры
- array
$settingsнеобязательно array() - массив настроек для движка
Возвращает
booleanTrue, если движок был успешно инициализирован, иначе false
Переопределяет
CacheEngine::init() readисходный код public
read( string $key )
Прочитать ключ из кэша
Параметры
- string
$key - Идентификатор данных
Возвращает
mixedКэшированные данные или false, если данных нет, они истекли или произошла ошибка при их извлечении
writeисходный код public
write( string $key , mixed $value , integer $duration )
Записать данные для ключа в кэш
Параметры
- string
$key - Идентификатор данных
- mixed
$value - Данные для кэширования
- integer
$duration - Время кэширования данных, в секундах
Возвращает
booleanTrue, если данные были успешно кэшированы, false при ошибке
Наследованные методы от CacheEngine
gcисходный код public
gc( integer $expires null )
Сбор мусора
Постоянно удалять все истекшие и удаленные данные
Параметры
- integer
$expiresнеобязательно null - [необязательно] Маркер времени истечения, делающий все данные недействительными до указанного момента.
keyисходный код public
key( string $key )
Генерирует безопасный ключ для использования с движками хранения кэша.
Параметры
- string
$key - переданный ключ
Возвращает
mixedстрока $key или false
Краткое описание свойств
Наследованные свойства от CacheEngine
$_groupPrefixисходный код
protected строка
Содержит скомпилированную строку со всеми префиксами групп, которые должны быть добавлены к каждому ключу в этом движке кэширования
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.
http://api.cakephp.org/2.7/class-XcacheEngine.html