Класс MemcachedEngine

_parseServerString()source protected deprecated

_parseServerString( string $server )

Обратный совместимый псевдоним для parseServerString

Устаревшее

3.4.13 Будет удалено в 4.0.0

Параметры

строка $server

Строка адреса сервера.

Возвращает

массив
Массив, содержащий хост и порт

_setOptions()source protected

_setOptions( )

Настройка экземпляра memcached

Исключения

InvalidArgumentException

Когда расширение Memcached не скомпилировано с необходимым двигателем сериализации.

add()source public

add( string $key , mixed $value )

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

Параметры

строка $key

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

смешанное $value

Данные, которые нужно кэшировать.

Возвращает

булево
Истина, если данные были успешно кэшированы, ложь в случае неудачи.

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

Cake\Cache\CacheEngine::add()

clear()source public

clear( boolean $check )

Удаление всех ключей из кэша

Параметры

булево $check

Если истина, проверяет истечение срока действия, иначе удаляет все.

Возвращает

булево
Истина, если кэш был успешно очищен, ложь в противном случае

clearGroup()source public

clearGroup( string $group )

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

Параметры

строка $group

имя группы для очистки

Возвращает

булево
успех

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

Cake\Cache\CacheEngine::clearGroup()

decrement()source public

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

Уменьшение значения целочисленного кэшированного ключа

Параметры

строка $key

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

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

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

Возвращает

булево|целое
Новое уменьшенное значение, ложь в противном случае

delete()source public

delete( string $key )

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

Параметры

строка $key

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

Возвращает

булево

Истина, если значение было успешно удалено, ложь, если его не существовало или не удалялось.

deleteMany()source public

deleteMany( array $keys )

Удаление сразу многих ключей из кэша

Параметры

массив $keys

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

Возвращает

массив

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

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

Cake\Cache\CacheEngine::deleteMany()

getOption()source public

getOption( string $name )

Чтение значения параметра из соединения memcached.

Параметры

строка $name

Имя параметра для чтения.

Возвращает

строка|целое|null|булево

groups()source public

groups( )

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

Возвращает

array

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

Cake\Cache\CacheEngine::groups()

increment()source public

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

Увеличивает значение целочисленного кэшированного ключа

Параметры

строка $key

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

целое число $offset необязательно 1

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

Возвращает

boolean|integer
Новое увеличенное значение, в противном случае false

init()source public

init( array $config = [] )

Инициализация кэша

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

Параметры

массив $config необязательно []

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

Возвращает

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

Исключения

InvalidArgumentException

При попытке использовать аутентификацию без поддержки SASL в Memcached

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

Cake\Cache\CacheEngine::init()

parseServerString()source public

parseServerString( string $server )

Парсит адрес сервера в хост/порт. Обрабатывает адреса IPv6 и IPv4, а также Unix-сокеты

Параметры

строка $server

Строка адреса сервера.

Возвращает

array
Массив, содержащий хост и порт

read()source public

read( string $key )

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

Параметры

строка $key

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

Возвращает

mixed

Кэшированные данные или false, если данных нет, срок действия истек или произошла ошибка при их извлечении.

readMany()source public

readMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

array

Массив, содержащий, для каждого из переданных $keys, кэшированные данные или false, если кэшированные данные не удалось получить.

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

Cake\Cache\CacheEngine::readMany()

write()source public

write( string $key , mixed $value )

Запись данных для ключа в кэш. При использовании memcached в качестве кэша помните, что расширение Memcached pecl не поддерживает время истечения кэша, превышающее 30 дней в будущем. Любой срок больше 30 дней будет обрабатываться как срок действия без истечения.

Параметры

строка $key

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

смешанное $value

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

Возвращает

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

См.

https://secure.php.net/manual/en/memcache.set.php

writeMany()source public

writeMany( array $data )

Запись нескольких записей кэша в кэш одновременно

Параметры

массив $data

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

Возвращает

array

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

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

Cake\Cache\CacheEngine::writeMany()

_key()source protected

_key( string $key )

Генерирует безопасный ключ, учитывая настроенный префикс ключа

Параметры

строка $key

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

Возвращает

mixed
строка $key или false

Исключения

InvalidArgumentException
Если значение ключа пустое

gc()source public

gc( integer|null $expires = null )

Сбор мусора

Постоянное удаление всех истекших и удалённых данных

Параметры

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

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

key()source public

key( string $key )

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

Параметры

строка $key

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

Возвращает

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

warning()source protected

warning( string $message )

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

Параметры

строка $message

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

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

_configRead()source protected

_configRead( string|null $key )

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

Параметры

строка|null $key

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

Возвращает

mixed

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

Устаревшее

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

Параметры

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

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

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

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

boolean $merge необязательно 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 необязательно 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 необязательно null

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

mixed $default необязательно 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 необязательно null

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

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

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

Возвращает

$this

Выбрасывает

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

[]

[
    'compress' => false,
    'duration' => 3600,
    'groups' => [],
    'host' => null,
    'username' => null,
    'password' => null,
    'persistent' => false,
    'port' => null,
    'prefix' => 'cake_',
    'probability' => 100,
    'serialize' => 'php',
    'servers' => ['127.0.0.1'],
    'options' => [],
]

[]