Spec-Zone.ru › CakePHP 2.8

Класс MemcacheEngine

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

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

Краткое описание свойств

  • $_Memcache protected
    Memcache
    Обёртка Memcache.
  • $_compiledGroupNames protected
    array

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

  • $settings public
    array
    Настройки

Унаследованные свойства

  • _groupPrefix

Краткое описание методов

  • _parseServerString() protected

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

  • add() public

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

  • clear() public
    Удаляет все ключи из кеша
  • clearGroup() public

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

  • connect() public
    Подключается к серверу в пуле подключений
  • decrement() public
    Уменьшает значение целого числа кешированного ключа
  • delete() public
    Удаляет ключ из кеша
  • groups() public

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

  • increment() public
    Увеличивает значение целого числа кешированного ключа
  • init() public
    Инициализирует двигатель кеширования
  • read() public
    Чтение ключа из кеша
  • write() public

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

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

_parseServerString()source protected 

_parseServerString( string $server )

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

Параметры

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

Возвращает

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

add()source public 

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

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

Параметры

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

Возвращает

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

Ссылка

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

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

CacheEngine::add()

clear()source public 

clear( boolean $check )

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

Параметры

булево $check

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

Возвращает

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

clearGroup()source public 

clearGroup( string $group )

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

Параметры

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

Возвращает

булево
успех

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

CacheEngine::clearGroup()

connect()source public 

connect( string $host , integer $port 11211 )

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

Параметры

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

Возвращает

булево
True, если сервер memcache подключился

decrement()source public 

decrement( string $key , integer $offset 1 )

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

Параметры

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

Возвращает

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

Выбрасывает

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

delete()source public 

delete( string $key )

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

Параметры

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

Возвращает

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

groups()source public 

groups( )

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

Возвращает

массив

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

CacheEngine::groups()

increment()source public 

increment( string $key , integer $offset 1 )

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

Параметры

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

Возвращает

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

Выбрасывает

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

init()source public 

init( array $settings array() )

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

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

Параметры

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

Возвращает

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

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

CacheEngine::init()

read()source public 

read( string $key )

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

Параметры

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

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

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

write()source 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()source public 

gc( integer $expires null )

Сбор мусора

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

Параметры

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

key()source public 

key( string $key )

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

Параметры

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

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

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

settings()source public 

settings( )

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

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

array
настройки

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

$_Memcachesource

protected Memcache

Обёртка Memcache.

null

$_compiledGroupNamessource

protected array

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

array()

$settingssource

public array

Настройки

  • servers = строка или массив серверов memcache, по умолчанию => 127.0.0.1. Если массив, MemcacheEngine будет использовать их как пул.
    • compress = булево, по умолчанию => false
array()

© 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.8/class-MemcacheEngine.html

Spec-Zone.ru

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