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

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

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

Cake\Cache\CacheEngine::gc()

increment()source public

increment( string $key , integer $offset 1 )

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

Параметры

string $key

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

integer $offset optional 1

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

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

boolean|integer
Новое увеличенное значение, иначе false

init()source public

init( array $config [] )

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

Параметры

array $config optional []

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

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

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

Параметры

строка|массив|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->config('key', $value);

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

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

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

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

Параметры

строка|массив $key

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

смешанный|null $value необязательно null

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

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

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