Класс WincacheEngine

clearsource public

clear( boolean $check )

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

Параметры

boolean $check

Если true, ничего не будет очищено, так как записи естественным образом истекут в wincache.

Возвращает

boolean
True Возвращает true.

clearGroupsource public

clearGroup( string $group )

Увеличивает значение группы, чтобы смоделировать удаление всех ключей в группе. Старые значения останутся в хранилище до тех пор, пока не истечёт срок их действия.

Параметры

string $group

Группа для очистки.

Возвращает

boolean
success

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

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, если оно не существовало или не могло быть удалено

groupssource public

groups( )

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

Возвращает

array
массив

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

Cake\Cache\CacheEngine::groups()

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, если данные не существуют, истекли или при возникновении ошибки при их извлечении

writesource public

write( string $key , mixed $value )

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

Параметры

string $key

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

mixed $value

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

Возвращает

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

_keysource protected

_key( string $key )

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

Параметры

string $key

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

Возвращает

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

Имеет исключения

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

addsource public

add( string $key , mixed $value )

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

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

Параметры

string $key

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

mixed $value

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

Возвращает

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

deleteManysource public

deleteMany( array $keys )

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

Параметры

array $keys

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

Возвращает

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

gcsource public

gc( integer|null $expires null )

Сбор мусора

Постоянно удаляет все устаревшие и удаленные данные

Параметры

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

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

keysource public

key( string $key )

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

Параметры

string $key

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

Возвращает

boolean|string
строка ключа или false

readManysource public

readMany( array $keys )

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

Параметры

array $keys

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

Возвращает

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

writeManysource public

writeMany( array $data )

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

Параметры

array $data

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

Возвращает

array
массив значений для каждого предоставленного ключа, true, если данные были успешно кэшированы, 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

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

Исключения

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

Рекурсивно слить или перезаписать существующую конфигурацию, по умолчанию 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
Сам объект.

[]

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

null

[]

false