Spec-Zone.ru › Yii 1.1

CDummyCache

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

CDummyCache ничего не кэширует. Он предоставляется для того, чтобы всегда можно было настроить компонент приложения 'cache', и не нужно было проверять, является ли Yii::app()->cache нулевым или нет. Заменив CDummyCache другим компонентом кэша, можно быстро переключаться между режимом без кэширования и режимом с кэшированием.

Свойства публичного доступа

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

Методы публичного доступа

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

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

keyPrefix свойство

public string $keyPrefix;

строка-префикс для каждого ключа кэша, чтобы он был уникальным. По умолчанию идентификатор приложения.

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

add() метод

public boolean add(string $id, mixed $value, integer $expire=0, ICacheDependency $dependency=NULL)
$id string ключ, идентифицирующий значение для кэширования
$value mixed значение для кэширования
$expire integer количество секунд, через которое кэшированное значение истечет. 0 означает, что никогда не истечёт.
$dependency ICacheDependency зависимость кэшированного элемента. Если зависимость изменится, элемент помечается как недействительный.
{return} boolean true, если значение успешно сохранено в кэш, иначе false
Исходный код: framework/caching/CDummyCache.php#94 (показать)
public function add($id,$value,$expire=0,$dependency=null)
{
    return 
true;
}

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

delete() метод

public boolean delete(string $id)
$id string ключ значения, которое нужно удалить
{return} boolean если удаление произошло без ошибок
Исходный код: framework/caching/CDummyCache.php#104 (показать)
public function delete($id)
{
    return 
true;
}

Удаляет значение с указанным ключом из кэша

flush() метод

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

Удаляет все значения из кэша. Будьте осторожны при выполнении этой операции, если кэш используется несколькими приложениями.

get() метод

public mixed get(string $id)
$id string ключ, идентифицирующий кэшированное значение
{return} смешанное сохранённое в кэше значение, false, если значение отсутствует в кэше, истекло или изменилась зависимость.
Исходный код: framework/caching/CDummyCache.php#46 (показать)
public function get($id)
{
    return 
false;
}

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

init() метод

public void init()
Исходный код: framework/caching/CDummyCache.php#34 (показать)
public function init()
{
    
parent::init();
    if(
$this->keyPrefix===null)
        
$this->keyPrefix=Yii::app()->getId();
}

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

mget() метод

public array mget(array $ids)
$ids массив список ключей, идентифицирующих кэшированные значения
{return} массив список кэшированных значений, соответствующих указанным ключам. Массив возвращается в виде пар (ключ, значение). Если значение не кэшировано или истекло, соответствующее значение массива будет false.
Исходный код: framework/caching/CDummyCache.php#61 (показать)
public function mget($ids)
{
    
$results=array();
    foreach(
$ids as $id)
        
$results[$id]=false;
    return 
$results;
}

Извлекает несколько значений из кэша по указанным ключам. Некоторые кэши (например, memcache, apc) позволяют извлекать несколько кэшированных значений одновременно, что может улучшить производительность, так как уменьшает затраты на коммуникацию. В случае, если кэш не поддерживает эту функцию напрямую, она будет моделироваться этим методом.

offsetExists() метод

public boolean offsetExists(string $id)
$id string ключ, идентифицирующий кэшированное значение
{return} boolean
Исходный код: framework/caching/CDummyCache.php#126 (показать)
public function offsetExists($id)
{
    return 
false;
}

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

offsetGet() метод

public mixed offsetGet(string $id)
$id string ключ, идентифицирующий кэшированное значение
{return} смешанное значение, хранящееся в кэше, false, если значение не найдено в кэше или истекло.
Исходный код: framework/caching/CDummyCache.php#137 (показать)
public function offsetGet($id)
{
    return 
false;
}

Извлекает значение из кэша по указанному ключу. Этот метод требуется интерфейсом ArrayAccess.

offsetSet() метод

public void offsetSet(string $id, mixed $value)
$id string ключ, идентифицирующий значение для кеширования
$value смешанное значение для кеширования
Исходный код: framework/caching/CDummyCache.php#150 (показать)
public function offsetSet($id, $value)
{
}

Сохраняет значение, идентифицируемое ключом, в кэше. Если кэш уже содержит такой ключ, существующее значение будет заменено новым. Для добавления истечения срока действия и зависимостей используйте метод set(). Этот метод требуется интерфейсом ArrayAccess.

offsetUnset() метод

public boolean offsetUnset(string $id)
$id string ключ значения, которое нужно удалить
{return} boolean если удаление произошло без ошибок
Исходный код: framework/caching/CDummyCache.php#160 (показать)
public function offsetUnset($id)
{
}

Удаляет значение с указанным ключом из кэша. Этот метод требуется интерфейсом ArrayAccess.

set() метод

public boolean set(string $id, mixed $value, integer $expire=0, ICacheDependency $dependency=NULL)
$id string ключ, идентифицирующий кэшируемое значение
$value смешанное кэшируемое значение
$expire целое количество секунд, в течение которых кэшированное значение будет действовать. 0 означает, что оно не будет истекать.
$dependency ICacheDependency зависимость от кэшируемого элемента. Если зависимость изменяется, элемент помечается как недействительный.
{return} boolean true, если значение успешно сохранено в кэше, false в противном случае
Исходный код: framework/caching/CDummyCache.php#80 (показать)
public function set($id,$value,$expire=0,$dependency=null)
{
    return 
true;
}

Сохраняет значение, идентифицируемое ключом, в кэше. Если кэш уже содержит такой ключ, существующее значение и время истечения срока действия будут заменены новыми.

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

Spec-Zone.ru

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