Класс XcacheEngine

_auth()source protected

_auth( boolean $reverse false )

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

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

Параметры

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

Вернуть изменения

clear()source public

clear( boolean $check )

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

Параметры

boolean $check

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

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

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 )

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

Параметры

string $key

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

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

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

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

boolean|integer
Новое уменьшенное значение, иначе false

delete()source public

delete( string $key )

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

Параметры

string $key

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

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

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

groups()source public

groups( )

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

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

array

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

Cake\Cache\CacheEngine::groups()

increment()source public

increment( string $key , integer $offset 1 )

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

Параметры

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

write()source public

write( string $key , mixed $value )

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

Параметры

string $key

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

mixed $value

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

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

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

_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.

deleteMany()source public

deleteMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

массив

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

gc()source public

gc( integer|null $expires null )

Сбор мусора

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

Параметры

целое число|null $expires необязательно null

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

key()source public

key( string $key )

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

Параметры

строка $key

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

Возвращает

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

readMany()source public

readMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

массив

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

writeMany()source public

writeMany( array $data )

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

Параметры

массив $data

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

Возвращает

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

Устарело

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

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

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

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

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

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

Параметры

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

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

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

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

Возвращает

$this

getConfig()source public

getConfig( string|null $key null , mixed $default null )

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение определенного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

строка|null $key необязательно null

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

смешанный тип $default необязательно null

Значение по умолчанию, если ключ не существует.

Возвращает

смешанный тип
Значение конфигурации для чтения.

setConfig()source public

setConfig( string|array $key , mixed|null $value null , boolean $merge true )

Устанавливает конфигурацию.

Использование

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

$this->setConfig('key', $value);

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

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

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

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

Параметры

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

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

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

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

boolean $merge необязательно true

Выполнять рекурсивное слияние или перезаписывать существующую конфигурацию, по умолчанию true.

Возвращает

$this

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

Cake\Core\Exception\Exception
При попытке установить некорректный ключ.

[
    'duration' => 3600,
    'groups' => [],
    'prefix' => null,
    'probability' => 100,
    'PHP_AUTH_USER' => 'user',
    'PHP_AUTH_PW' => 'password'
]