Класс XcacheEngine

_auth()source protected

_auth( boolean $reverse false )

Заполняет и инвертирует значения аутентификации $_SERVER. Вносит необходимые изменения (и отменяет их) в $_SERVER

Это необходимо сделать, потому что xcache_clear_cache() необходимо передать Basic Http Auth (см. параметры конфигурации xcache.admin)

Параметры

boolean $reverse необязательный false

Отменить изменения

add()source public

add( string $key , mixed $value , integer $duration )

Записывает данные для ключа в кэш, если они еще не существуют. Если ключ уже существует, то возвращает false.

Параметры

string $key

Идентификатор данных.

mixed $value

Данные, которые нужно кэшировать.

integer $duration

Сколько времени хранить данные в кэше (в секундах).

Возвращаемое значение

boolean
True, если данные успешно кэшированы, false в случае неудачи.

Переопределяет

CacheEngine::add()

clear()source public

clear( boolean $check )

Удалить все ключи из кэша

Параметры

boolean $check

Если true, удаления не будут выполняться, а CakePHP будет полагаться на значения TTL ключей.

Возвращаемое значение

boolean
True, если кэш успешно очищен, false в противном случае

clearGroup()source public

clearGroup( string $group )

Увеличивает значение группы, чтобы имитировать удаление всех ключей в рамках этой группы. Старые значения остаются в хранилище до истечения срока их действия.

Параметры

string $group

Группа для очистки.

Возвращаемое значение

boolean
Успех

Переопределяет

CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset 1 )

Уменьшает значение целочисленного кэшированного ключа. Если ключ кэша не является целым числом, он обрабатывается как 0.

Параметры

string $key

Идентификатор данных

integer $offset необязательный 1

Сколько нужно отнять

Возвращаемое значение

Новое
уменьшенное значение, false в противном случае

delete()source public

delete( string $key )

Удалить ключ из кэша

Параметры

string $key

Идентификатор данных

Возвращаемое значение

boolean
True, если значение было успешно удалено, false, если его не существовало или не удалось удалить

groups()source public

groups( )

Возвращает group value для каждой из настроенных групп. Если начальное значение группы не найдено, то группа инициализируется соответствующим образом.

Возвращаемое значение

array

Переопределяет

CacheEngine::groups()

increment()source public

increment( string $key , integer $offset 1 )

Увеличивает значение целочисленного кэшированного ключа. Если ключ кэша не является целым числом, он обрабатывается как 0.

Параметры

string $key

Идентификатор данных

integer $offset необязательный 1

На сколько увеличить

Возвращаемое значение

Новое
увеличенное значение, false в противном случае

init()source public

init( array $settings array() )

Инициализировать движок кэширования

Вызывается автоматически фронтендом кэша. Чтобы повторно инициализировать настройки, вызовите Cache::engine('EngineName', [необязательный] settings = array());

Параметры

array $settings необязательный array()

Массив настроек для движка

Возвращаемое значение

boolean
True, если движок успешно инициализирован, false в противном случае

Переопределяет

CacheEngine::init()

read()source public

read( string $key )

Прочитать ключ из кэша

Параметры

string $key

Идентификатор данных

Возвращаемое значение

mixed
Кэшированные данные или false, если данных нет, они истекли или произошла ошибка при их получении

write()source public

write( string $key , mixed $value , integer $duration )

Записать данные для ключа в кэш

Параметры

string $key

Идентификатор данных

mixed $value

Данные, которые нужно кэшировать

integer $duration

Сколько времени хранить данные в кэше (в секундах)

Возвращаемое значение

boolean
True, если данные успешно кэшированы, false в случае неудачи

gc()source public

gc( integer $expires null )

Сбор мусора

Постоянно удаляет все устаревшие и удалённые данные

Параметры

integer $expires необязательный null

[необязательно] Маркер времени истечения срока действия, аннулируя все данные до указанной даты.

key()source public

key( string $key )

Генерирует безопасный ключ для использования с движками кэширования.

Параметры

string $key

переданный ключ

Возвращаемое значение

mixed
строка $key или false

settings()source public

settings( )

Настройки движка кэширования

Возвращаемое значение

массив
настройки

array()