Класс XcacheEngine

_auth()source protected deprecated

_auth( boolean $reverse = false )

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

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

Параметры

boolean $reverse optional 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 optional 1

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

Возвращает

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

delete()source public deprecated

delete( string $key )

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

Параметры

string $key

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

Возвращает

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

groups()source public deprecated

groups( )

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

Возвращает

array

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

Cake\Cache\CacheEngine::groups()

increment()source public deprecated

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

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

Параметры

string $key

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

integer $offset optional 1

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

Возвращает

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

init()source public deprecated

init( array $config = [] )

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

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

Параметры

array $config optional []

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

Возвращает

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 )

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

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

Параметры

string $key

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

mixed $value

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

Возвращает

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

deleteMany()source public

deleteMany( array $keys )

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

Параметры

array $keys

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

Возвращает

array

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

gc()source public

gc( integer|null $expires = null )

Сбор мусора

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

Параметры

integer|null $expires optional null

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

key()source public

key( string $key )

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

Параметры

string $key

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

Возвращает

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

readMany()source public

readMany( array $keys )

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

Параметры

array $keys

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

Возвращает

array

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

warning()source protected

warning( string $message )

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

Параметры

string $message

Сообщение предупреждения.

writeMany()source public

writeMany( array $data )

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

Параметры

array $data

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

Возвращает

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

_configDelete()source protected

_configDelete( string $key )

Удаляет один ключ конфигурации.

Параметры

string $key

Ключ для удаления.

Исключения

Cake\Core\Exception\Exception
если пытаетесь перезаписать существующую конфигурацию

_configRead()source protected

_configRead( string|null $key )

Считывает ключ конфигурации.

Параметры

string|null $key

Ключ для чтения.

Возвращает

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Записывает ключ конфигурации.

Параметры

string|array $key

Ключ для записи.

mixed $value

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

boolean|string $merge optional 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']);

Параметры

string|array|null $key optional null

Ключ для получения/установки или весь массив настроек.

mixed|null $value optional null

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

boolean $merge optional true

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

Возвращает

mixed
Значение конфигурации, которое читается, или сам объект при операциях записи.

Исключения

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

Параметры

string|array $key

Ключ для установки или весь массив настроек.

mixed|null $value optional 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');

Параметры

string|null $key optional null

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

mixed $default optional null

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

Возвращает

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

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

Параметры

string|array $key

Ключ для установки или весь массив настроек.

mixed|null $value optional null

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

boolean $merge optional true

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

Возвращает

$this

Исключения

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

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