Spec-Zone.ru › Yii 1.1

CApcCache

Пакет system.caching
Наследование class CApcCache » CCache » CApplicationComponent » CComponent
Реализует ArrayAccess, ICache, IApplicationComponent
С 1.0
Исходный код framework/caching/CApcCache.php
CApcCache предоставляет кэширование APC в рамках компонента приложения.

Кэширование основано на APC. Для использования данного компонента приложения необходимо загрузить расширение APC PHP.

См. руководство по CCache для общих операций кэширования, поддерживаемых CApcCache.

Публичные свойства

Свойство Тип Описание Определено
behaviors массив поведение, которое должно быть подключено к данному компоненту. CApplicationComponent
hashKey boolean используется ли md5-хеширование ключа кэша для нормализации. CCache
isInitialized boolean Проверяет, был ли инициализирован компонент приложения. CApplicationComponent
keyPrefix строка строка, которая добавляется в префикс к каждому ключу кэша для обеспечения уникальности. CCache
serializer массив|boolean функции, используемые для сериализации и десериализации кэшированных данных. CCache
useApcu boolean использовать ли apcu или apc в качестве базового расширения кэширования. CApcCache

Публичные методы

Метод Описание Определено
__call() Вызывает метод с указанным именем, который не является методом класса. CComponent
__get() Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. CComponent
__isset() Проверяет, является ли значение свойства нулевым. CComponent
__set() Устанавливает значение свойства компонента. CComponent
__unset() Устанавливает свойство компонента в значение null. CComponent
add() Сохраняет значение, идентифицируемое ключом, в кэше, если кэш не содержит этот ключ. CCache
asa() Возвращает объект поведения с указанным именем. CComponent
attachBehavior() Подключает поведение к компоненту. CComponent
attachBehaviors() Подключает список поведений к компоненту. CComponent
attachEventHandler() Подключает обработчик событий к событию. CComponent
canGetProperty() Определяет, можно ли считать свойство. CComponent
canSetProperty() Определяет, можно ли установить свойство. CComponent
delete() Удаляет значение с указанным ключом из кэша. CCache
detachBehavior() Отключает поведение от компонента. CComponent
detachBehaviors() Отключает все поведения от компонента. CComponent
detachEventHandler() Отсоединяет существующий обработчик событий. CComponent
disableBehavior() Отключает подключенное поведение. CComponent
disableBehaviors() Отключает все подключенные к данному компоненту поведения. CComponent
enableBehavior() Включает подключенное поведение. CComponent
enableBehaviors() Включает все подключенные к компоненту поведения. CComponent
evaluateExpression() Вычисляет PHP-выражение или обратный вызов в контексте данного компонента. CComponent
flush() Удаляет все значения из кэша. CCache
get() Извлекает значение из кэша по указанному ключу. CCache
getEventHandlers() Возвращает список подключенных обработчиков событий для события. CComponent
getIsInitialized() Проверяет, был ли инициализирован компонент приложения. CApplicationComponent
hasEvent() Определяет, определено ли событие. CComponent
hasEventHandler() Проверяет, есть ли прикрепленные обработчики к событию с указанным именем. CComponent
hasProperty() Определяет, определено ли свойство. CComponent
init() Инициализирует компонент приложения. CApcCache
mget() Извлекает несколько значений из кэша по указанным ключам. CCache
offsetExists() Возвращает, существует ли запись в кэше с указанным ключом. CCache
offsetGet() Извлекает значение из кэша по указанному ключу. CCache
offsetSet() Сохраняет значение, идентифицируемое ключом, в кэш. CCache
offsetUnset() Удаляет значение с указанным ключом из кэша. CCache
raiseEvent() Вызывает событие. CComponent
set() Сохраняет значение, идентифицируемое ключом, в кэш. CCache

Защищенные методы

Метод Описание Определено в
addValue() Сохраняет значение, идентифицируемое ключом, в кэше, если в кэше этот ключ отсутствует. CApcCache
deleteValue() Удаляет значение с указанным ключом из кэша CApcCache
flushValues() Удаляет все значения из кэша. CApcCache
generateUniqueKey() CCache
getValue() Извлекает значение из кэша по указанному ключу. CApcCache
getValues() Извлекает несколько значений из кэша по указанным ключам. CApcCache
setValue() Сохраняет значение, идентифицируемое ключом, в кэше. CApcCache

Подробности свойств

useApcu свойство (доступно начиная с v1.1.17)

public boolean $useApcu;

определяет, использовать ли apcu или apc в качестве базового расширения кэширования. Если true, будет использоваться apcu. Если false, будет использоваться apc. По умолчанию false.

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

addValue() метод

protected boolean addValue(string $key, string $value, integer $expire)
$key string ключ, идентифицирующий значение, которое нужно кэшировать
$value string значение, которое нужно кэшировать
$expire integer количество секунд, по истечении которых значение из кэша будет удалено. 0 означает, что значение никогда не будет удалено.
{return} boolean true, если значение успешно сохранено в кэш, иначе false
Исходный код: framework/caching/CApcCache.php#94 (показать)
protected function addValue($key,$value,$expire)
{
    return 
$this->useApcu ? apcu_add($key,$value,$expire) : apc_add($key,$value,$expire);
}

Сохраняет значение, идентифицируемое ключом, в кэш, если в кэше этот ключ отсутствует. Это реализация метода, объявленного в родительском классе.

deleteValue() метод

protected boolean deleteValue(string $key)
$key string ключ значения, которое нужно удалить
{return} boolean true, если удаление прошло успешно, иначе false
Исходный код: framework/caching/CApcCache.php#105 (показать)
protected function deleteValue($key)
{
    return 
$this->useApcu ? apcu_delete($key) : apc_delete($key);
}

Удаляет значение с указанным ключом из кэша. Это реализация метода, объявленного в родительском классе.

flushValues() метод (доступен начиная с v1.1.5)

protected boolean flushValues()
{return} boolean true, если операция очистки прошла успешно, иначе false.
Исходный код: framework/caching/CApcCache.php#116 (показать)
protected function flushValues()
{
    return 
$this->useApcu ? apcu_clear_cache() : apc_clear_cache('user');
}

Удаляет все значения из кэша. Это реализация метода, объявленного в родительском классе.

getValue() метод

protected string|boolean getValue(string $key)
$key string уникальный ключ, идентифицирующий кэшированное значение
{return} string|boolean значение, сохранённое в кэше, false, если значение отсутствует в кэше или истекло.
Исходный код: framework/caching/CApcCache.php#56 (показать)
protected function getValue($key)
{
    return 
$this->useApcu ? apcu_fetch($key) : apc_fetch($key);
}

Извлекает значение из кэша по указанному ключу. Это реализация метода, объявленного в родительском классе.

getValues() метод

protected array getValues(array $keys)
$keys array список ключей, идентифицирующих кэшированные значения
{return} array список кэшированных значений, индексированных по ключам
Исходный код: framework/caching/CApcCache.php#66 (показать)
protected function getValues($keys)
{
    return 
$this->useApcu ? apcu_fetch($keys) : apc_fetch($keys);
}

Извлекает несколько значений из кэша по указанным ключам.

init() метод

public void init()
Исходный код: framework/caching/CApcCache.php#41 (показать)
public function init()
{
    
parent::init();
    
$extension=$this->useApcu ? 'apcu' : 'apc';
    if(!
extension_loaded($extension))
        throw new 
CException(Yii::t('yii',"CApcCache requires PHP {extension} extension to be loaded.",
            array(
'{extension}'=>$extension)));
}

Инициализирует компонент приложения. Этот метод требуется интерфейсом IApplicationComponent. Он проверяет доступность APC.

setValue() метод

protected boolean setValue(string $key, string $value, integer $expire)
$key string ключ, идентифицирующий значение, которое нужно кэшировать
$value string значение, которое нужно кэшировать
$expire integer количество секунд, по истечении которых значение из кэша будет удалено. 0 означает, что значение никогда не будет удалено.
{return} boolean true, если значение успешно сохранено в кэш, иначе false
Исходный код: framework/caching/CApcCache.php#80 (показать)
protected function setValue($key,$value,$expire)
{
    return 
$this->useApcu ? apcu_store($key,$value,$expire) : apc_store($key,$value,$expire);
}

Сохраняет значение, идентифицируемое ключом, в кэше. Это реализация метода, объявленного в родительском классе.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CApcCache

Spec-Zone.ru

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