Класс XcacheEngine

_authsource protected

_auth( boolean $reverse false )

Заполняет и переворачивает значения аутентификации $_SERVER. Вносит необходимые изменения (и отменяет их обратно) в $_SERVER

Это необходимо сделать, потому что xcache_clear_cache() нужно передать Basic Http Auth (см. конфигурацию xcache.admin).

Параметры

boolean $reverse необязательно false

Отменить изменения

clearsource public

clear( boolean $check )

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

Параметры

boolean $check

Если true, удаления не будут происходить, и вместо этого CakePHP будет полагаться на значения TTL ключей. Не используется для движка Xcache.

Возвращает

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

clearGroupsource public

clearGroup( string $group )

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

Параметры

string $group

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

Возвращает

boolean
успех

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

Cake\Cache\CacheEngine::clearGroup()

decrementsource public

decrement( string $key , integer $offset 1 )

Уменьшает значение целого кэшированного ключа. Если ключ кэша не является целым числом, он будет обработан как 0

Параметры

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 )

Увеличивает значение целого кэшированного ключа. Если ключ кэша не является целым числом, он будет обработан как 0

Параметры

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 )

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

Параметры

массив $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

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

boolean|строка $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

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

boolean $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' => null,
    'probability' => 100,
    'PHP_AUTH_USER' => 'user',
    'PHP_AUTH_PW' => 'password'
]

null

[]

false