Класс 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 = [] )

Инициализирует File Cache Engine

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

Параметры

массив $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

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

Возвращает

mixed

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

write()source public

write( string $key , mixed $data )

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

Параметры

строка $key

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

смешанный $data

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

Возвращает

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

_key()source protected

_key( string $key )

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

Параметры

строка $key

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

Возвращает

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

Вызывает

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

add()source public

add( string $key , mixed $value )

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

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

Параметры

строка $key

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

смешанный $value

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

Возвращает

boolean
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

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

Возвращает

mixed

_configWrite()source protected

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

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

Параметры

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

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

смешанный $value

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

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

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

Вызывает

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

config()source public устаревший

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

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

boolean $merge необязательно 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']);

Параметры

строка|массив $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

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

Возвращает

mixed
Данные конфигурации по указанному ключу или 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