Spec-Zone.ru › Yii 1.1

CXCache

Пакет system.caching
Наследование класс CXCache » CCache » CApplicationComponent » CComponent
Реализует ArrayAccess, ICache, IApplicationComponent
Исходный код framework/caching/CXCache.php
CXCache реализует модуль кэширования на основе xcache.

Для использования этого компонента необходимо загрузить расширение XCache PHP. Функциональность очистки будет работать корректно только если в php.ini параметр "xcache.admin.enable_auth" установлен в "Off".

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

Свойства Public

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

Методы Public

Метод Описание Определено
__call() Вызывает метод по имени, который не является методом класса. CComponent
__get() Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. CComponent
__isset() Проверяет, является ли значение свойства null. 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() Инициализирует этот компонент приложения. CXCache
mget() Извлекает несколько значений из кэша по заданным ключам. CCache
offsetExists() Возвращает, есть ли запись в кэше с заданным ключом. CCache
offsetGet() Извлекает значение из кэша по заданному ключу. CCache
offsetSet() Сохраняет значение, идентифицируемое ключом, в кэше. CCache
offsetUnset() Удаляет значение со заданным ключом из кэша. CCache
raiseEvent() Вызывает событие. CComponent
set() Сохраняет значение, идентифицируемое ключом, в кэше. CCache

Методы Protected

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

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

addValue() метод

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

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

deleteValue() метод

protected boolean deleteValue(string $key)
$key строка ключ значения, которое нужно удалить
{return} булево true, если удаление прошло успешно, иначе false
Исходный код: framework/caching/CXCache.php#82 (показать)
protected function deleteValue($key)
{
    return 
xcache_unset($key);
}

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

flushValues() метод (доступен с версии v1.1.5)

protected boolean flushValues()
{return} булево успешно ли выполнена операция очистки.
Исходный код: framework/caching/CXCache.php#93 (показать)
protected function flushValues()
{
    for(
$i=0, $max=xcache_count(XC_TYPE_VAR); $i<$max; $i++)
    {
        if(
xcache_clear_cache(XC_TYPE_VAR, $i)===false)
            return 
false;
    }
    return 
true;
}

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

getValue() метод

protected string|boolean getValue(string $key)
$key строка уникальный ключ, идентифицирующий кэшированное значение
{return} строка|булево значение, сохраненное в кэше, false, если значение отсутствует в кэше или истекло.
Исходный код: framework/caching/CXCache.php#43 (показать)
protected function getValue($key)
{
    return 
xcache_isset($key) ? xcache_get($key) : false;
}

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

init() метод

public void init()
Исходный код: framework/caching/CXCache.php#30 (показать)
public function init()
{
    
parent::init();
    if(!
function_exists('xcache_isset'))
        throw new 
CException(Yii::t('yii','CXCache requires PHP XCache extension to be loaded.'));
}

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

setValue() метод

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

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

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

Spec-Zone.ru

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