Класс 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
true, если ключ кэша был установлен, иначе 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 )

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

Параметры

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

Опционально - удалять только истекшие элементы кэша

Возвращает

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

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
True, если значение было успешно удалено, false, если его не существовало или его нельзя было удалить

gc()source public

gc( integer $expires null )

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

Параметры

целое число $expires опционально null

[опционально] Метка времени истечения срока действия, аннулирующая все данные до этого значения.

Возвращает

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

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

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
True, если движок был успешно инициализирован, иначе false

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

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()