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

clear()source public

clear( boolean $check )

Удаление всех значений из кэша

Параметры

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

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

Возвращает

boolean
Истина, если кэш успешно очищен, ложь в противном случае

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

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

gc()source public

gc( integer|null $expires null )

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

Параметры

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

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

Возвращает

boolean
Истина, если сбор мусора выполнен успешно, ложь в случае ошибки

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

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

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

Cake\Cache\CacheEngine::init()

key()source public

key( string $key )

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

Параметры

строка $key

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

Возвращает

смешанное
строка $key или ложь

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

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, если данные не найдены, истекли или произошла ошибка при их получении

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

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

Параметры

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->config('key', $value);

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

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

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

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

Параметры

string|array $key

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

mixed|null $value optional null

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

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

$this Объект самого себя.

null

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

true