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

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

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

Параметры

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

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

Параметры

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

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

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

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

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

Параметры

string|array $key

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

mixed|null $value необязательно null

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

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

$this Сам объект.