Spec-Zone.ru › Yii 1.1

CWinCache

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

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

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

Общественные свойства

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

Общественные методы

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

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

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

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

addValue() метод

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

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

deleteValue() метод

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

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

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

protected boolean flushValues()
{return} булево true, если операция сброса прошла успешно.
Исходный код: framework/caching/CWinCache.php#104 (показать)
protected function flushValues()
{
    return 
wincache_ucache_clear();
}

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

getValue() метод

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

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

getValues() метод

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

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

init() метод

public void init()
Исходный код: framework/caching/CWinCache.php#29 (показать)
public function init()
{
    
parent::init();
    if(!
extension_loaded('wincache'))
        throw new 
CException(Yii::t('yii', 'CWinCache requires PHP wincache extension to be loaded.'));
    if(!
ini_get('wincache.ucenabled'))
        throw new 
CException(Yii::t('yii', 'CWinCache user cache is disabled. Please set wincache.ucenabled to On in your php.ini.'));
}

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

setValue() метод

protected boolean setValue(string $key, string $value, integer $expire)
$key строка ключ, идентифицирующий значение, которое нужно поместить в кэш
$value строка значение, которое нужно поместить в кэш
$expire целое число количество секунд, в течение которых значение в кэше будет действовать. 0 означает, что значение никогда не истекает.
{return} булево true, если значение успешно сохранено в кэше, в противном случае false
Исходный код: framework/caching/CWinCache.php#68 (показать)
protected function setValue($key,$value,$expire)
{
    return 
wincache_ucache_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/CWinCache

Spec-Zone.ru

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