Класс XcacheEngine

_auth()source protected deprecated

_auth( boolean $reverse = false )

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

Это необходимо сделать, потому что xcache_clear_cache() требует передачи базовой аутентификации HTTP (см. конфигурацию xcache.admin).

Параметры

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

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

clear()source public deprecated

clear( boolean $check )

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

Параметры

boolean $check

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

Возвращает

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

clearGroup()source public deprecated

clearGroup( string $group )

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

Параметры

string $group

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

Возвращает

boolean
Успех

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

Cake\Cache\CacheEngine::clearGroup()

decrement()source public deprecated

decrement( string $key , integer $offset = 1 )

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

Параметры

string $key

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

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

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

Возвращает

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

delete()source public deprecated

delete( string $key )

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

Параметры

string $key

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

Возвращает

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

groups()source public deprecated

groups( )

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

Возвращает

array

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

Cake\Cache\CacheEngine::groups()

increment()source public deprecated

increment( string $key , integer $offset = 1 )

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

Параметры

string $key

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

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

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

Возвращает

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

init()source public deprecated

init( array $config = [] )

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

Вызывается автоматически фронтендом кэша

Параметры

array $config необязательно []

массив настроек для движка

Возвращает

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

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

Cake\Cache\CacheEngine::init()

read()source public deprecated

read( string $key )

Чтение ключа из кэша

Параметры

string $key

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

Возвращает

mixed

Кэшированные данные или false, если данные не существуют, истекли или произошла ошибка при их извлечении

write()source public deprecated

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

Массив данных, которые необходимо сохранить в кэше

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

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

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

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

смешанное
Значение конфигурации, которое читается.

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