Класс MemcachedEngine
Двигатель хранения Memcached для кэша. Memcached имеет некоторые ограничения в управлении временем истечения действия далеко в будущем. Подробнее см. MemcachedEngine::write().
Основным преимуществом этого двигателя Memcached перед двигателем memcached является поддержка двоичного протокола и сериализации igbibnary (если расширение memcached скомпилировано с --enable-igbinary). Сжатые ключи также могут быть инкрементированы/декрементированы.
- CacheEngine
-
MemcachedEngine
Авторские права: Авторские права (с) 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 ключей.
Возвращает
booleanTrue, если кэш был успешно очищен, иначе 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
deletesource public
delete( string $key )
Удалить ключ из кэша
Параметры
- строка
$key - Идентификатор данных
Возвращаемое значение
booleanTrue, если значение было успешно удалено, 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необязательный массив() - массив настроек для движка
Возвращаемое значение
booleanTrue, если движок был успешно инициализирован, 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 - Срок хранения данных в секундах
Возвращаемое значение
booleanTrue, если данные были успешно кэшированы, 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
Резюме свойств
Свойства, унаследованные от 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