Класс 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 = array());

Параметры

массив $settings дополнительно array()

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

Возвращает

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

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

CacheEngine::init()

key()source public

key( string $key )

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

Параметры

строка $key

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

Возвращает

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

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

CacheEngine::key()

read()source public

read( string $key )

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

Параметры

строка $key

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

Возвращает

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

write()source public

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

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

Параметры

строка $key

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

смешанный $data

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

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

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

Возвращает

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

groups()source public

groups( )

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

Возвращает

массив

settings()source public

settings( )

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

Возвращает

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

null

true

array()