Класс FileEngine

_active()source protected

_active( )

Определяет, доступен ли каталог кэша для записи

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

boolean

_clearDirectory()source protected

_clearDirectory( string $path , integer $now , integer $threshold )

Используется для очистки каталога от соответствующих файлов.

Параметры

строка $path

Путь для поиска.

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

Текущая метка времени

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

Любой файл, не изменённый после этого значения, будет удалён.

_setKey()source protected

_setKey( string $key , boolean $createKey false )

Устанавливает текущий ключ кэша, который обрабатывает этот класс, и создаёт экземпляр SplFileObject для файла кэша, на который ссылается ключ.

Параметры

строка $key

Ключ

логическое значение $createKey необязательно false

Создавать ключ, если он не существует, или нет

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

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

add()source public

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

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

Параметры

строка $key

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

смешанные $value

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

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

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

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

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

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

CacheEngine::add()

clear()source public

clear( boolean $check )

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

Параметры

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

Необязательно - удалить только истекшие элементы кэша

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

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

clearGroup()source public

clearGroup( string $group )

Рекурсивно удаляет все файлы в любом каталоге, названном как $group

Параметры

строка $group

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

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

boolean
успех

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

CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset 1 )

Не реализовано

Параметры

строка $key

Ключ для уменьшения

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

Значение смещения

Исключения

CacheException

delete()source public

delete( string $key )

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

Параметры

строка $key

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

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

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

gc()source public

gc( integer $expires null )

Сбор мусора. Постоянно удаляет все истекшие и удалённые данные

Параметры

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

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

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

boolean
Истина, если сбор мусора прошёл успешно, ложь при ошибке

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

CacheEngine::gc()

increment()source public

increment( string $key , integer $offset 1 )

Не реализовано

Параметры

строка $key

Ключ для увеличения

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

Значение смещения

Исключения

CacheException

init()source public

init( array $settings array() )

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

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

Параметры

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

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

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

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

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

CacheEngine::init()

key()source public

key( string $key )

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

Параметры

строка $key

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

Возвращает

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

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

CacheEngine::key()

read()source public

read( string $key )

Чтение ключа из кеша

Параметры

строка $key

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

Возвращает

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

write()source public

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

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

Параметры

строка $key

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

mixed $data

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

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

Срок хранения данных в секундах

Возвращает

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

groups()source public

groups( )

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

Возвращает

array

settings()source public

settings( )

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

Возвращает

array
настройки

null

true

array()