Класс FileEngine

_active()source protected

_active( )

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

Возвращает

boolean

_clearDirectory()source protected

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

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

Параметры

string $path

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

integer $now

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

integer $threshold

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

_setKey()source protected

_setKey( string $key , boolean $createKey = false )

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

Параметры

string $key

Ключ

boolean $createKey optional false

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

Возвращает

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

clear()source public

clear( boolean $check )

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

Параметры

boolean $check

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

Возвращает

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

clearGroup()source public

clearGroup( string $group )

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

Параметры

string $group

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

Возвращает

boolean
успех

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

Cake\Cache\CacheEngine::clearGroup()

decrement()source public

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

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

Параметры

string $key

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

integer $offset optional 1

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

Выбрасывает

LogicException

delete()source public

delete( string $key )

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

Параметры

string $key

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

Возвращает

boolean

True, если значение было успешно удалено, false, если его не было или не удалили

gc()source public

gc( integer|null $expires = null )

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

Параметры

integer|null $expires optional null

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

Возвращает

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

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

Cake\Cache\CacheEngine::gc()

increment()source public

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

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

Параметры

string $key

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

integer $offset optional 1

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

Выбрасывает

LogicException

init()source public

init( array $config = [] )

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

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

Параметры

array $config optional []

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

Возвращает

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

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

Cake\Cache\CacheEngine::init()

key()source public

key( string $key )

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

Параметры

string $key

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

Возвращает

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

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

Cake\Cache\CacheEngine::key()

read()source public

read( string $key )

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

Параметры

string $key

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

Возвращает

mixed

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

write()source public

write( string $key , mixed $data )

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

Параметры

string $key

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

mixed $data

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

Возвращает

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

_key()source protected

_key( string $key )

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

Параметры

string $key

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

Возвращает

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

Выбрасывает

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

add()source public

add( string $key , mixed $value )

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

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

Параметры

string $key

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

mixed $value

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

Возвращает

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

deleteMany()source public

deleteMany( array $keys )

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

Параметры

array $keys

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

Возвращает

array

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

groups()source public

groups( )

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

Возвращает

array

readMany()source public

readMany( array $keys )

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

Параметры

array $keys

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

Возвращает

array

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

warning()source protected

warning( string $message )

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

Параметры

string $message

Сообщение о предупреждении.

writeMany()source public

writeMany( array $data )

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

Параметры

array $data

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

Возвращает

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

_configDelete()source protected

_configDelete( string $key )

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

Параметры

string $key

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

Выбрасывает

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

_configRead()source protected

_configRead( string|null $key )

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

Параметры

string|null $key

Ключ для чтения.

Возвращает

mixed

_configWrite()source protected

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

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

Параметры

string|array $key

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

mixed $value

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

boolean|string $merge optional 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() вместо этого.

Параметры

string|array|null $key optional null

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

mixed|null $value optional null

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

boolean $merge optional true

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

Возвращает

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

Выбрасывает

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']);

Параметры

string|array $key

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

mixed|null $value optional 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');

Параметры

string|null $key optional null

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

mixed $default optional null

Возвращаемое значение, когда ключ не существует.

Возвращает

mixed
Значение конфигурации, которое читается.

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']);

Параметры

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

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

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

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

булево $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