Класс NullEngine

clearsource public

clear( boolean $check )

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

Параметры

boolean $check

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

Возвращает

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

clearGroupsource public

clearGroup( string $group )

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

Параметры

string $group

имя группы, которая должна быть очищена

Возвращает

boolean
bool

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

Cake\Cache\CacheEngine::clearGroup()

decrementsource public

decrement( string $key , integer $offset 1 )

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

Параметры

string $key

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

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

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

Возвращает

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

deletesource public

delete( string $key )

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

Параметры

string $key

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

Возвращает

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

deleteManysource public

deleteMany( array $keys )

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

Параметры

array $keys

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

Возвращает

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

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

Cake\Cache\CacheEngine::deleteMany()

gcsource public

gc( integer|null $expires null )

Сбор мусора

Параметры

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

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

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

Cake\Cache\CacheEngine::gc()

incrementsource public

increment( string $key , integer $offset 1 )

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

Параметры

string $key

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

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

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

Возвращает

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

initsource public

init( array $config [] )

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

Параметры

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

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

Возвращает

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

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

Cake\Cache\CacheEngine::init()

readsource public

read( string $key )

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

Параметры

string $key

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

Возвращает

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

readManysource public

readMany( array $keys )

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

Параметры

array $keys

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

Возвращает

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

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

Cake\Cache\CacheEngine::readMany()

writesource public

write( string $key , mixed $value )

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

Параметры

string $key

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

mixed $value

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

Возвращает

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

writeManysource public

writeMany( array $data )

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

Параметры

array $data

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

Возвращает

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

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

Cake\Cache\CacheEngine::writeMany()

_keysource protected

_key( string $key )

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

Параметры

string $key

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

Возвращает

mixed
string $key или false

Вызывает исключение

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

addsource public

add( string $key , mixed $value )

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

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

Параметры

string $key

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

mixed $value

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

Возвращает

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

groupssource public

groups( )

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

Возвращает

array
array

keysource public

key( string $key )

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

Параметры

string $key

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

Возвращает

boolean|string
string key или 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

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

логический тип|строка $merge необязательно false

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

Исключения

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

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

логический тип $merge необязательно 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
$this Сам объект.

[
    'duration' => 3600,
    'groups' => [],
    'prefix' => 'cake_',
    'probability' => 100
]

null

[]

false