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

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

groups()source public

groups( )

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

Возвращает

array

key()source public

key( string $key )

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

Параметры

string $key

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

Возвращает

boolean|string
ключ или false

warning()source protected

warning( string $message )

Движки кэша могут генерировать предупреждения, если они сталкиваются с ошибками во время работы, если опция warnOnWriteFailures установлена в true.

Параметры

string $message

Сообщение об ошибке.

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 optional false

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

Исключения

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

config()source public deprecated

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

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

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

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

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

Параметры

string|array $key

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

mixed|null $value optional 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 optional null

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

mixed $default optional 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 optional null

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

boolean $merge optional true

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

Возвращает

$this

Исключения

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