Класс FileEngine

_activeисходный код protected

_active( )

Определить, является ли каталог кэша доступным для записи.

Возвращает

boolean
bool

_clearDirectoryисходный код protected

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

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

Параметры

string $path

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

integer $now

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

integer $threshold

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

_setKeyисходный код protected

_setKey( string $key , boolean $createKey false )

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

Параметры

string $key

Ключ

boolean $createKey необязательно false

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

Возвращает

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

clearисходный код public

clear( boolean $check )

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

Параметры

boolean $check

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

Возвращает

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

clearGroupисходный код public

clearGroup( string $group )

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

Параметры

string $group

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

Возвращает

boolean
успех

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

Cake\Cache\CacheEngine::clearGroup()

decrementисходный код public

decrement( string $key , integer $offset 1 )

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

Параметры

string $key

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

integer $offset необязательно 1

Число смещения.

Выбрасывает

LogicException
\LogicException

deletesource public

delete( string $key )

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

Параметры

строка $key

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

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

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

gcsource public

gc( integer|null $expires null )

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

Параметры

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

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

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

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

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

Cake\Cache\CacheEngine::gc()

incrementsource public

increment( string $key , integer $offset 1 )

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

Параметры

строка $key

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

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

Число для смещения

Исключения

LogicException
\LogicException

initsource public

init( array $config [] )

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

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

Параметры

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

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

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

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

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

Cake\Cache\CacheEngine::init()

keysource public

key( string $key )

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

Параметры

строка $key

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

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

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

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

Cake\Cache\CacheEngine::key()

readsource public

read( string $key )

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

Параметры

строка $key

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

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

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

writesource public

write( string $key , mixed $data )

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

Параметры

строка $key

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

смешанный $data

Данные, которые нужно поместить в кэш

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

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

_keysource protected

_key( string $key )

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

Параметры

строка $key

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

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

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

Исключения

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

addsource public

add( string $key , mixed $value )

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

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

Параметры

строка $key

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

смешанный $value

Данные, которые нужно поместить в кэш.

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

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

deleteManysource public

deleteMany( array $keys )

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

Параметры

массив $keys

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

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

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

groupssource public

groups( )

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

Возвращает

array
массив

readManysource public

readMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

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

writeManysource public

writeMany( array $data )

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

Параметры

массив $data

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

Возвращает

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

_configDeletesource protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

_configReadsource protected

_configRead( string|null $key )

Чтение конфигурационной переменной

Параметры

строка|null $key

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

Возвращает

mixed
смешанный тип

_configWritesource protected

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

Запись конфигурационной переменной

Параметры

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

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

смешанный тип $value

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

boolean|строка $merge дополнительно false

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

Исключения

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

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

Параметры

строка|массив|null $key дополнительно null

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

смешанный тип|null $value дополнительно null

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

boolean $merge дополнительно true

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

Возвращает

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

Исключения

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

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

Параметры

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

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

смешанный тип|null $value дополнительно null

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

Возвращает

mixed
Сам объект.

null

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

true

null

[]

false