Класс NullEngine

clear()source public

clear( boolean $check )

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

Параметры

boolean $check

если true, проверит срок действия, иначе удалит все

Возвращает

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

clearGroup()source public

clearGroup( string $group )

Очищает все значения, принадлежащие группе. Реализация решает, нужно ли фактически удалить ключи или просто смоделировать действие для достижения того же результата.

Параметры

string $group

имя группы для очистки

Возвращает

boolean

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

Cake\Cache\CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset 1 )

Уменьшить число по ключу и вернуть уменьшенное значение

Параметры

string $key

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

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

На сколько уменьшить

Возвращает

boolean|integer
Новое уменьшенное значение, false в противном случае

delete()source public

delete( string $key )

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

Параметры

string $key

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

Возвращает

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

deleteMany()source public

deleteMany( array $keys )

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

Параметры

array $keys

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

Возвращает

array

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

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

Cake\Cache\CacheEngine::deleteMany()

gc()source public

gc( integer|null $expires null )

Сбор мусора

Параметры

integer|null $expires необязательно null

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

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

Cake\Cache\CacheEngine::gc()

increment()source public

increment( string $key , integer $offset 1 )

Увеличить число по ключу и вернуть увеличенное значение

Параметры

string $key

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

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

На сколько увеличить

Возвращает

boolean|integer
Новое увеличенное значение, false в противном случае

init()source public

init( array $config [] )

Инициализировать кэш-движок

Параметры

array $config необязательно []

Ассоциативный массив параметров для движка

Возвращает

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

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

Cake\Cache\CacheEngine::init()

read()source public

read( string $key )

Прочитать ключ из кэша

Параметры

string $key

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

Возвращает

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

readMany()source public

readMany( array $keys )

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

Параметры

array $keys

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

Возвращает

array

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

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

Cake\Cache\CacheEngine::readMany()

write()source public

write( string $key , mixed $value )

Записать значение для ключа в кэш

Параметры

string $key

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

mixed $value

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

Возвращает

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

writeMany()source public

writeMany( array $data )

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

Параметры

array $data

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

Возвращает

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

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

Cake\Cache\CacheEngine::writeMany()

_key()source protected

_key( string $key )

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

Параметры

string $key

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

Возвращает

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

Выбрасывает

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

add()source public

add( string $key , mixed $value )

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

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

Параметры

строка $key

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

смешанный $value

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

Возвращает

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

groups()source public

groups( )

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

Возвращает

массив

key()source public

key( string $key )

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

Параметры

строка $key

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

Возвращает

boolean|строка
ключ в виде строки или false

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

_configRead()source protected

_configRead( string|null $key )

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

Параметры

строка|null $key

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

Возвращает

смешанный

_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.

Возвращает

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

Исключения

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

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

Возвращает

смешанный
Значение конфигурации для чтения.

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

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

boolean $merge необязательно true

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

Возвращает

$this

Исключения

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