Класс MemcachedEngine

_parseServerString()source protected

_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

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

Возвращает

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

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

Cake\Cache\CacheEngine::add()

clear()source public

clear( boolean $check )

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

Параметры

булево $check

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

Возвращает

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

clearGroup()source public

clearGroup( string $group )

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

Параметры

строка $group

имя группы, которая должна быть очищена

Возвращает

булево
успех

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

Cake\Cache\CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset 1 )

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

Параметры

строка $key

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

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

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

Возвращает

булево|целое число
Новое уменьшенное значение, иначе false

delete()source public

delete( string $key )

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

Параметры

строка $key

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

Возвращает

булево

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

deleteMany()source public

deleteMany( array $keys )

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

Параметры

массив $keys

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

Возвращает

массив

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

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

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 )

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

Параметры

string $key

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

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

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

Возвращает

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

init()source public

init( array $config [] )

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

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

Параметры

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

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

Возвращает

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

Выбрасывает

InvalidArgumentException

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

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

Cake\Cache\CacheEngine::init()

parseServerString()source public

parseServerString( string $server )

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

Параметры

string $server

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

Возвращает

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

read()source public

read( string $key )

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

Параметры

string $key

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

Возвращает

mixed

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

readMany()source public

readMany( array $keys )

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

Параметры

array $keys

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

Возвращает

array

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

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

Cake\Cache\CacheEngine::readMany()

write()source public

write( string $key , mixed $value )

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

Параметры

string $key

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

mixed $value

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

Возвращает

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

См. также

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

writeMany()source public

writeMany( array $data )

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

Параметры

array $data

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

Возвращает

array

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

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

Cake\Cache\CacheEngine::writeMany()

_key()source protected

_key( string $key )

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

Параметры

string $key

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

Возвращает

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

Выбрасывает

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

gc()source public

gc( integer|null $expires null )

Сбор мусора

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

Параметры

integer|null $expires необязательно null

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

key()source public

key( string $key )

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

Параметры

string $key

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

Возвращает

boolean|string
строка ключа или 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 необязательно false

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

Выбрасывает

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

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

Устарело

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

Параметры

string|array|null $key необязательно null

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

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

[]