Класс XcacheEngine

_auth()source protected

_auth( boolean $reverse false )

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

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

Параметры

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

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

add()source public

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

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

Параметры

строка $key

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

смешанный $value

Данные для кэширования.

целое число $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 )

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

Параметры

строка $group

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

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

boolean
успех

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

CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset 1 )

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

Параметры

строка $key

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

целое число $offset необязательно 1

На сколько уменьшить

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

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

delete()source public

delete( string $key )

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

Параметры

строка $key

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

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

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

groups()source public

groups( )

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

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

массив

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

CacheEngine::groups()

increment()source public

increment( string $key , integer $offset 1 )

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

Параметры

строка $key

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

целое число $offset необязательно 1

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

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

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

init()source public

init( array $settings array() )

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

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

Параметры

массив $settings необязательно array()

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

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

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

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

CacheEngine::init()

read()source public

read( string $key )

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

Параметры

строка $key

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

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

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

write()source public

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

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

Параметры

строка $key

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

смешанный $value

Данные для кэширования

целое число $duration

Срок действия кэшированных данных в секундах

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

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

gc()source public

gc( integer $expires null )

Сбор мусора

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

Параметры

целое число $expires необязательно null

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

key()source public

key( string $key )

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

Параметры

string $key

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

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

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

settings()source public

settings( )

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

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

array
настройки

array()