Класс FileEngine

_activesource protected

_active( )

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

Возвращает

boolean
bool

_clearDirectorysource protected

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

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

Параметры

строка $path

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

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

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

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

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

_setKeysource protected

_setKey( string $key , boolean $createKey false )

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

Параметры

строка $key

Ключ

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

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

Возвращает

boolean
true, если ключ кеша был установлен, иначе false

clearsource public

clear( boolean $check )

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

Параметры

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

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

Возвращает

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

clearGroupsource public

clearGroup( string $group )

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

Параметры

строка $group

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

Возвращает

boolean
успех

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

CacheEngine::clearGroup()

decrementsource public

decrement( string $key , integer $offset 1 )

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

Параметры

строка $key

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

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

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

Выбрасывает

CacheException
CacheException

deletesource public

delete( string $key )

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

Параметры

строка $key

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

Возвращает

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

gcsource public

gc( integer $expires null )

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

Параметры

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

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

Возвращает

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

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

CacheEngine::gc()

incrementsource public

increment( string $key , integer $offset 1 )

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

Параметры

строка $key

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

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

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

Выбрасывает

CacheException
CacheException

initsource public

init( array $settings array() )

Инициализация двигателя кеша

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

Параметры

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

Массив настроек для двигателя

Возвращает

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

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

CacheEngine::init()

keysource public

key( string $key )

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

Параметры

строка $key

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

Возвращает

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

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

CacheEngine::key()

readsource public

read( string $key )

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

Параметры

строка $key

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

Возвращает

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

writesource public

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

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

Параметры

строка $key

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

смешанное значение $data

Данные, которые необходимо поместить в кеш

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

Время хранения данных в секундах

Возвращает

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

groupssource public

groups( )

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

Возвращает

array
массив

settingssource public

settings( )

Настройки двигателя кеша

Возвращает

array
настройки

null

true

array()

null