Класс XcacheEngine

_auth()source protected устарел

_auth( boolean $reverse = false )

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

Это необходимо, так как xcache_clear_cache() требует передачи аутентификации Basic HTTP (см. конфигурацию 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( )

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

Возвращает

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 )

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

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

Параметры

строка $key

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

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

warning()source protected

warning( string $message )

Движки кэша могут генерировать предупреждения, если они обнаруживают сбои во время работы, если параметр warnOnWriteFailures установлен в true.

Параметры

строка $message

Сообщение об ошибке.

writeMany()source public

writeMany( array $data )

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

Параметры

массив $data

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

Возвращает

массив
логическое значение для каждого предоставленного ключа, 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 deprecated

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

Возвращаемое значение, когда ключ не существует.

Возвращает

смешанный
Данные конфигурации по указанному ключу или 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'
]