Spec-Zone.ru › CakePHP 2.7

Класс MemcachedEngine

Двигатель хранения Memcached для кэша. Memcached имеет некоторые ограничения в управлении временем истечения действия далеко в будущем. Подробнее см. MemcachedEngine::write().

Основным преимуществом этого двигателя Memcached перед двигателем memcached является поддержка двоичного протокола и сериализации igbibnary (если расширение memcached скомпилировано с --enable-igbinary). Сжатые ключи также могут быть инкрементированы/декрементированы.

CacheEngine
Extended by MemcachedEngine
Пакет: Cake\Кэш\Двигатель
Авторские права: Авторские права (с) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение Cake/Cache/Engine/MemcachedEngine.php

Подробное описание методов

_parseServerStringисходный код protected

_parseServerString( string $server )

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

Параметры

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

Возвращает

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

_setOptionsисходный код protected

_setOptions( )

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

Выбрасывает

CacheException
в случае, если расширение Memcached не скомпилировано с нужным двигателем сериализации

clearисходный код public

clear( boolean $check )

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

Параметры

логическое значение $check
Если true, удаление не произойдёт, и CakePHP будет полагаться на значения TTL ключей.

Возвращает

boolean
True, если кэш был успешно очищен, иначе false. Также вернёт false, если используется двоичный протокол.

clearGroupисходный код public

clearGroup( string $group )

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

Параметры

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

Возвращает

boolean
успех

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

CacheEngine::clearGroup()

decrementисходный код public

decrement( string $key , integer $offset 1 )

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

Параметры

строка $key
Идентификатор данных
целое число $offset необязательно 1
На сколько уменьшить

Возвращает

New
Уменьшенное значение, иначе false

Выбрасывает

CacheException
при попытке уменьшения с compress = true
END_OF_DOCUMENT_MARKER

deletesource public

delete( string $key )

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

Параметры

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

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

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

groupssource public

groups( )

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

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

array
массив

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

CacheEngine::groups()

incrementsource public

increment( string $key , integer $offset 1 )

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

Параметры

строка $key
Идентификатор данных
целое число $offset необязательный 1
На сколько увеличить

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

New
увеличенное значение, в противном случае false

Выбрасывает

CacheException
когда вы пытаетесь увеличить с compress = true

initsource public

init( array $settings array() )

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

Вызывается автоматически фронтендом кэша. Чтобы повторно инициализировать настройки, вызовите Cache::engine('EngineName', [необязательные] settings = array());

Параметры

массив $settings необязательный массив()
массив настроек для движка

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

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

Выбрасывает

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

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

CacheEngine::init()

readsource public

read( string $key )

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

Параметры

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

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

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

writesource public

write( string $key , mixed $value , integer $duration )

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

Параметры

строка $key
Идентификатор данных
смешанный $value
Данные для кэширования
целое число $duration
Срок хранения данных в секундах

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

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

См.

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

Методы, унаследованные от CacheEngine

gcsource public

gc( integer $expires null )

Сбор мусора

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

Параметры

целое число $expires необязательный null
[необязательно] отметка времени истечения срока действия, аннулируя все данные до.

keysource public

key( string $key )

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

Параметры

строка $key
переданный ключ

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

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

settingssource public

settings( )

Настройки движка кэша

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

array
настройки

Резюме свойств

$_Memcachedsource

protected Memcache

Обёртка для memcached.

null

$_serializerssource

protected array

Список доступных движков сериализации

Для использования этих движков memcached должен быть скомпилирован с поддержкой json и igbinary

array(
    'igbinary' => Memcached::SERIALIZER_IGBINARY,
    'json' => Memcached::SERIALIZER_JSON,
    'php' => Memcached::SERIALIZER_PHP
)

$settingssource

public array

Настройки

  • servers = строка или массив серверов memcached, по умолчанию => 127.0.0.1. Если массив, MemcacheEngine будет использовать их как пул. - compress = boolean, по умолчанию => false - persistent = string Имя постоянного соединения. Все конфигурации с одинаковым значением persistent будут использовать одно и то же базовое соединение. - serialize = строка, по умолчанию => php. Движок сериализации, используемый для сериализации данных. Доступные движки: php, igbinary и json. Помимо php, расширение memcached должно быть скомпилировано с соответствующей поддержкой сериализации. - options - Дополнительные опции для клиента memcached. Должны быть массивом опция => значение. Используйте константы Memcached::OPT_* в качестве ключей.
array()

Свойства, унаследованные от CacheEngine

$_groupPrefixsource

protected string

Содержит скомпилированную строку со всеми префиксами групп, которые нужно добавить к каждому ключу в этом кэше

null

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.7/class-MemcachedEngine.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API