Spec-Zone.ru › CakePHP 2.7

Класс MemcacheEngine

Двигатель кеширования Memcache для кеша. Memcache имеет некоторые ограничения в объёме управления временем истечения кеширования в далёком будущем. Для получения дополнительной информации см. MemcacheEngine::write().

CacheEngine
Расширенный MemcacheEngine
Пакет: Cake\Cache\Engine
Устаревший: 3.0.0 Следует использовать адаптер Memcached вместо него.
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Cache/Engine/MemcacheEngine.php

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

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

_parseServerString( string $server )

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

Параметры

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

Возвращает

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

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

clear( boolean $check )

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

Параметры

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

Возвращает

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

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

clearGroup( string $group )

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

Параметры

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

Возвращает

boolean
успех

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

CacheEngine::clearGroup()

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

connect( string $host , integer $port 11211 )

Подключение к серверу в пуле подключений

Параметры

строка $host
IP-адрес или имя хоста
целое число $port необязательно 11211
Порт сервера

Возвращает

boolean
True, если сервер memcache был подключен

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

decrement( string $key , integer $offset 1 )

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

Параметры

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

Возвращает

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

Выбрасывает

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

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

delete( string $key )

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

Параметры

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

Возвращает

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

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

groups( )

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

Возвращает

array
массив

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

CacheEngine::groups()

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

increment( string $key , integer $offset 1 )

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

Параметры

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

Возвращает

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

Выбрасывает

CacheException
при попытке увеличения с compress = true

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

init( array $settings array() )

Инициализировать двигатель кеширования

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

Параметры

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

Возвращает

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

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

CacheEngine::init()

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

read( string $key )

Прочитать ключ из кеша

Параметры

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

Возвращает

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

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

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

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

Параметры

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

Возвращает

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

См. также

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

Наследуемые методы из CacheEngine

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

gc( integer $expires null )

Сбор мусора

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

Параметры

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

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

key( string $key )

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

Параметры

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

Возвращает

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

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

settings( )

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

Возвращает

array
настройки

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

$_Memcacheисходный код

protected Memcache

Обёртка Memcache.

null

$_compiledGroupNamesисходный код

protected массив

Содержит скомпилированные имена групп (с префиксом глобальной конфигурации)

array()

$settingsисходный код

public массив

Настройки

  • servers = строка или массив серверов memcache, по умолчанию => 127.0.0.1. Если массив, MemcacheEngine будет использовать их как пул. - compress = boolean, по умолчанию => false
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-MemcacheEngine.html

Spec-Zone.ru

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