Класс CacheEngine

add()source public

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

Записать значение для ключа в кэш, если оно ещё не существует

Параметры

строка $key

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

смешанный $value

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

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

Срок хранения в кэше.

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

boolean
Истина, если данные были успешно кэшированы, ложь в случае ошибки

clear()source abstract public

clear( boolean $check )

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

Параметры

логическое значение $check

если истина, проверяется срок действия, иначе удаляются все

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

boolean
Истина, если кэш был успешно очищен, ложь в противном случае

clearGroup()source public

clearGroup( string $group )

Очищает все значения, принадлежащие группе. Реализация решает, удалять ли ключи фактически или просто симулировать это, чтобы достичь того же результата.

Параметры

строка $group

название группы, которую нужно очистить

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

boolean

decrement()source abstract public

decrement( string $key , integer $offset 1 )

Уменьшить число по ключу и вернуть уменьшенное значение

Параметры

строка $key

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

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

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

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

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

delete()source abstract public

delete( string $key )

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

Параметры

строка $key

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

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

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

gc()source public

gc( integer $expires null )

Сбор мусора

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

Параметры

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

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

groups()source public

groups( )

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

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

массив

increment()source abstract public

increment( string $key , integer $offset 1 )

Увеличить число по ключу и вернуть увеличенное значение

Параметры

строка $key

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

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

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

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

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

init()source public

init( array $settings array() )

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

Вызывается автоматически фронтендом кэша

Параметры

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

Ассоциативный массив параметров для движка

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

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

key()source public

key( string $key )

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

Параметры

строка $key

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

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

смешанный
строка $key или ложь

read()source abstract public

read( string $key )

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

Параметры

строка $key

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

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

смешанный
Данные из кэша или ложь, если данных нет, они истекли или произошла ошибка при получении

settings()source public

settings( )

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

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

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

write()source abstract public

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

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

Параметры

string $key

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

mixed $value

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

integer $duration

Срок хранения.

Возвращает

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

null

array()