Класс 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
string $key или false

settings()source public

settings( )

Настройки кэша.

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

array
настройки

array()