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

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

Возвращает

смешанное
строка $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
string $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
массив булевых значений для каждого предоставленного ключа, 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 необязательно 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() вместо этого.

Параметры

string|array|null $key необязательно null

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

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

Параметры

string|array $key

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

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

Параметры

string|null $key необязательно null

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

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

Параметры

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