Класс MemcachedEngine

_parseServerStringsource protected

_parseServerString( string $server )

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

Параметры

строка $server

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

Возвращает

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

_setOptionssource protected

_setOptions( )

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

Выбрасывает

InvalidArgumentException
При использовании расширения Memcached без требуемого механизма сериализации.

addsource public

add( string $key , mixed $value )

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

Параметры

строка $key

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

смешанное $value

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

Возвращает

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

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

Cake\Cache\CacheEngine::add()

clearsource public

clear( boolean $check )

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

Параметры

boolean $check

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

Возвращает

boolean
True, если кэш успешно очищен, false в противном случае

clearGroupsource public

clearGroup( string $group )

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

Параметры

строка $group

Имя группы, которую нужно очистить

Возвращает

boolean
Успешно или нет

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

Cake\Cache\CacheEngine::clearGroup()

decrementsource public

decrement( string $key , integer $offset 1 )

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

Параметры

строка $key

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

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

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

Возвращает

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

deletesource public

delete( string $key )

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

Параметры

строка $key

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

Возвращает

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

deleteManysource public

deleteMany( array $keys )

Удаляет сразу несколько ключей из кэша

Параметры

массив $keys

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

Возвращает

array
Массив значений boolean, true, если ключ был успешно удален, false — если его не было или не удалось удалить.

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

Cake\Cache\CacheEngine::deleteMany()

groupssource public

groups( )

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

Возвращает

array
Массив

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

Cake\Cache\CacheEngine::groups()

incrementsource public

increment( string $key , integer $offset 1 )

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

Параметры

строка $key

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

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

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

Возвращает

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

initsource public

init( array $config [] )

Инициализация движка кэша

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

Параметры

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

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

Возвращает

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

Выбрасывает

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

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

Cake\Cache\CacheEngine::init()

readsource public

read( string $key )

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

Параметры

строка $key

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

Возвращает

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

readManysource public

readMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

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

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

Cake\Cache\CacheEngine::readMany()

writesource public

write( string $key , mixed $value )

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

Параметры

строка $key

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

смешанное $value

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

Возвращает

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

См.

http://php.net/manual/en/memcache.set.php

writeManysource public

writeMany( array $data )

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

Параметры

массив $data

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

Возвращает

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

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

Cake\Cache\CacheEngine::writeMany()

_keysource protected

_key( string $key )

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

Параметры

строка $key

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

Возвращает

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

Выбрасывает

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

gcsource public

gc( integer|null $expires null )

Сбор мусора

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

Параметры

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

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

keysource public

key( string $key )

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

Параметры

строка $key

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

Возвращает

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

_configDeletesource protected

_configDelete( string $key )

Удалить отдельный ключ конфигурации

Параметры

строка $key

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

Выбрасывает

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

_configReadsource protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

строка|null $key

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

Возвращает

mixed
смешанный тип

_configWritesource protected

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

Записать переменную конфигурации

Параметры

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

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

смешанный тип $value

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

логическое значение|строка $merge необязательно false

Истина для рекурсивного слияния, 'shallow' для простого слияния, ложь для перезаписи, по умолчанию ложь.

Выбрасывает

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

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

Параметры

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

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

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

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

логическое значение $merge необязательно true

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

Возвращает

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

Выбрасывает

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

configShallowsource public

configShallow( string|array $key , mixed|null $value null )

Слияние предоставленной конфигурации с существующей. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

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

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

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

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

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

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

Параметры

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

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

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

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

Возвращает

mixed
$this Сам объект.

null

[
    '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' => [],
]

[]

null

[]

false