Класс 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

clear()source public

clear( boolean $check )

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

Параметры

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

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

Возвращает

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

clearGroup()source public

clearGroup( string $group )

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

Параметры

строка $group

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

Возвращает

boolean
успех

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

Cake\Cache\CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset = 1 )

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

Параметры

строка $key

Ключ для декремента

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

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

Выбрасывает

LogicException

delete()source public

delete( string $key )

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

Параметры

строка $key

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

Возвращает

boolean

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

gc()source public

gc( integer|null $expires = null )

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

Параметры

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

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

Возвращает

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

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

Cake\Cache\CacheEngine::gc()

increment()source public

increment( string $key , integer $offset = 1 )

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

Параметры

строка $key

Ключ для инкремента

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

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

Выбрасывает

LogicException

init()source public

init( array $config = [] )

Инициализация движка кэша файлов

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

Параметры

массив $config необязательно []

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

Возвращает

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

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

Cake\Cache\CacheEngine::init()

key()source public

key( string $key )

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

Параметры

строка $key

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

Возвращает

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

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

Cake\Cache\CacheEngine::key()

read()source public

read( string $key )

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

Параметры

строка $key

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

Возвращает

смешанный

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

write()source public

write( string $key , mixed $data )

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

Параметры

строка $key

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

смешанный $data

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

Возвращает

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

_key()source protected

_key( string $key )

Генерирует безопасный ключ, учитывая конфигурированный префикс ключа

Параметры

строка $key

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

Возвращает

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

Исключения

InvalidArgumentException
Если значение ключа пустое

add()source public

add( string $key , mixed $value )

Добавить ключ в кэш, если он еще не существует.

По умолчанию используется неатомарная реализация. Подклассы должны отдавать предпочтение атомарным реализациям.

Параметры

строка $key

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

смешанный $value

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

Возвращает

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

deleteMany()source public

deleteMany( array $keys )

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

Параметры

массив $keys

Массив идентификаторов данных

Возвращает

массив

Для каждого предоставленного ключа кэша (переданного в качестве ключа массива) true, если значение было успешно удалено, false, если оно не существовало или не удалось удалить

groups()source public

groups( )

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

Возвращает

массив

readMany()source public

readMany( array $keys )

Прочитать несколько ключей из кэша

Параметры

массив $keys

Массив идентификаторов данных

Возвращает

массив

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

warning()source protected

warning( string $message )

Движки кэша могут вызывать предупреждения, если при работе возникают ошибки, если параметр warnOnWriteFailures установлен в true.

Параметры

строка $message

Сообщение об ошибке.

writeMany()source public

writeMany( array $data )

Записать данные для многих ключей в кэш

Параметры

массив $data

Массив данных для хранения в кэше

Возвращает

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

_configDelete()source protected

_configDelete( string $key )

Удаляет один ключ конфигурации.

Параметры

строка $key

Ключ для удаления.

Исключения

Cake\Core\Exception\Exception
если происходит попытка перезаписи существующей конфигурации

_configRead()source protected

_configRead( string|null $key )

Считывает ключ конфигурации.

Параметры

строка|null $key

Ключ для считывания.

Возвращает

смешанный

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Записывает ключ конфигурации.

Параметры

строка|массив $key

Ключ для записи.

смешанный $value

Значение для записи.

булево|строка $merge необязательно false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Исключения

Cake\Core\Exception\Exception
если происходит попытка перезаписи существующей конфигурации

config()source public deprecated

config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )

Получение/Установка конфигурации.

Использование

Чтение всей конфигурации:

$this->config();

Чтение определенного значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определенного значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Устарело

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

строка|массив|null $key необязательно null

Ключ для получения/установки или полный массив конфигураций.

смешанный|null $value необязательно null

Значение для установки.

булево $merge необязательно true

Производить ли рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

смешанный
Значение конфигурации для чтения или сам объект при операциях записи.

Исключения

Cake\Core\Exception\Exception
При попытке установить неверный ключ.

configShallow()source public

configShallow( string|array $key , mixed|null $value = null )

Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка определенного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

строка|массив $key

Ключ для установки или полный массив конфигураций.

смешанный|null $value необязательно null

Значение для установки.

Возвращает

$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

строка|null $key необязательно null

Ключ для получения или null для всей конфигурации.

смешанный $default необязательно null

Значение по умолчанию, если ключ не найден.

Возвращает

смешанный
Значение конфигурации для чтения.

setConfig()source public

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

Устанавливает конфигурацию.

Использование

Устанавливает определенное значение:

$this->setConfig('key', $value);

Устанавливает вложенное значение:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

Ключ для установки или массив настроек.

mixed|null $value необязательно null

Значение для установки.

boolean $merge необязательно true

Признак рекурсивного слияния или перезаписи существующей конфигурации, по умолчанию true.

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

$this

Исключения

Cake\Core\Exception\Exception
При попытке установить некорректный ключ.

[
    'duration' => 3600,
    'groups' => [],
    'isWindows' => false,
    'lock' => true,
    'mask' => 0664,
    'path' => null,
    'prefix' => 'cake_',
    'probability' => 100,
    'serialize' => true
]

true