Spec-Zone.ru › Yii 1.1

CZendDataCache

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

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

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

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

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

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

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

addValue() метод

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

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

deleteValue() метод

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

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

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

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

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

getValue() метод

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

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

init() метод

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

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

setValue() метод

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

Spec-Zone.ru

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