Spec-Zone.ru › Yii 1.1

CFilterWidget

Пакет system.web.widgets
Наследование класс CFilterWidget » CWidget » CBaseController » CComponent
Реализует IFilter
Подклассы COutputCache, COutputProcessor
С версии 1.0
Исходный код framework/web/widgets/CFilterWidget.php
CFilterWidget — базовый класс для виджетов, которые также могут использоваться в качестве фильтров.

Производные классы могут потребовать переопределения следующих методов:
  • CWidget::init() : вызывается, когда этот объект используется как виджет и требует инициализации.
  • CWidget::run() : вызывается, когда этот объект используется как виджет.
  • filter() : метод фильтрации, вызываемый, когда этот объект используется как фильтр действия.


CFilterWidget предоставляет все свойства и методы CWidget и CFilter.

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

Свойство Тип Описание Определено
actionPrefix строка Префикс к идентификаторам действий. CWidget
controller CController Возвращает контроллер, к которому принадлежит этот виджет. CWidget
id строка Возвращает идентификатор виджета или генерирует новый, если запрошено. CWidget
isFilter булево указывает, используется ли этот виджет в качестве фильтра. CFilterWidget
owner CBaseController Возвращает владельца/создателя этого виджета. CWidget
skin смешанный тип Имя используемой темы этого виджета. CWidget
stopAction булево Останавливать ли выполнение действия, когда этот виджет используется в качестве фильтра. CFilterWidget
viewPath строка Возвращает директорию, содержащую файлы представления для этого виджета. CWidget

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

Метод Описание Определено в
__call() Вызывает метод с заданным именем, который не является методом класса. CComponent
__construct() Конструктор. CFilterWidget
__get() Возвращает значение свойства, список обработчиков событий или поведение по его имени. CComponent
__isset() Проверяет, является ли значение свойства нулевым. CComponent
__set() Устанавливает значение свойства компонента. CComponent
__unset() Устанавливает свойство компонента в значение null. CComponent
actions() Возвращает список действий, используемых этим виджетом. CWidget
asa() Возвращает объект поведения с заданным именем. CComponent
attachBehavior() Прикрепляет поведение к этому компоненту. CComponent
attachBehaviors() Прикрепляет список поведений к компоненту. CComponent
attachEventHandler() Прикрепляет обработчик событий к событию. CComponent
beginCache() Начинает кэширование фрагмента. CBaseController
beginClip() Начинает запись клипа. CBaseController
beginContent() Начинает отображение содержимого, которое должно быть оформлено указанным представлением. CBaseController
beginWidget() Создаёт виджет и выполняет его. CBaseController
canGetProperty() Определяет, можно ли прочитать свойство. CComponent
canSetProperty() Определяет, можно ли установить свойство. CComponent
createWidget() Создаёт виджет и инициализирует его. CBaseController
detachBehavior() Открепляет поведение от компонента. CComponent
detachBehaviors() Открепляет все поведения от компонента. CComponent
detachEventHandler() Открепляет существующий обработчик событий. CComponent
disableBehavior() Отключает прикреплённое поведение. CComponent
disableBehaviors() Отключает все прикреплённые к этому компоненту поведения. CComponent
enableBehavior() Включает прикреплённое поведение. CComponent
enableBehaviors() Включает все прикреплённые к этому компоненту поведения. CComponent
endCache() Завершает кэширование фрагмента. CBaseController
endClip() Завершает запись клипа. CBaseController
endContent() Завершает отображение содержимого. CBaseController
endWidget() Завершает выполнение указанного виджета. CBaseController
evaluateExpression() Вычисляет выражение PHP или обратный вызов в контексте этого компонента. CComponent
filter() Выполняет фильтрацию. CFilterWidget
getController() Возвращает контроллер, к которому принадлежит этот виджет. CWidget
getEventHandlers() Возвращает список прикреплённых обработчиков событий для события. CComponent
getId() Возвращает идентификатор виджета или генерирует новый, если запрошено. CWidget
getIsFilter() Проверяет, используется ли этот виджет в качестве фильтра. CFilterWidget
getOwner() Возвращает владельца/создателя этого виджета. CWidget
getViewFile() Ищет файл сценария представления в соответствии с именем представления. CWidget
getViewPath() Возвращает каталог, содержащий файлы представлений для этого виджета. CWidget
hasEvent() Определяет, определено ли событие. CComponent
hasEventHandler() Проверяет, есть ли прикреплённые обработчики к указанному событию. CComponent
hasProperty() Определяет, определено ли свойство. CComponent
init() Инициализирует виджет. CWidget
raiseEvent() Вызывает событие. CComponent
render() Отображает представление. CWidget
renderFile() Отображает файл представления. CBaseController
renderInternal() Отображает файл представления. CBaseController
run() Выполняет виджет. CWidget
setId() Устанавливает идентификатор виджета. CWidget
widget() Создаёт виджет и выполняет его. CBaseController

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

isFilter свойство только для чтения

public boolean getIsFilter()

указывает, используется ли этот виджет в качестве фильтра.

stopAction свойство

public boolean $stopAction;

определяет, следует ли остановить выполнение действия, когда этот виджет используется в качестве фильтра. Это свойство должно изменяться только в методе CWidget::init. По умолчанию значение false, что означает, что действие должно быть выполнено.

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

__construct() метод

public void __construct(CBaseController $owner=NULL)
$owner CBaseController владелец/создатель этого виджета. Это может быть либо виджет, либо контроллер.
Исходный код: framework/web/widgets/CFilterWidget.php#44 (показать)
public function __construct($owner=null)
{
    
parent::__construct($owner);
    
$this->_isFilter=($owner===null);
}

Конструктор.

filter() метод

public void filter(CFilterChain $filterChain)
$filterChain CFilterChain цепь фильтров, на которой находится фильтр.
Исходный код: framework/web/widgets/CFilterWidget.php#65 (показать)
public function filter($filterChain)
{
    
$this->init();
    if(!
$this->stopAction)
    {
        
$filterChain->run();
        
$this->run();
    }
}

Выполняет фильтрацию. Стандартная реализация просто вызывает init(), CFilterChain::run() и run(). Производные классы могут переопределить этот метод, чтобы изменить это поведение.

getIsFilter() метод

public boolean getIsFilter()
{return} boolean является ли данный виджет фильтром.
Исходный код: framework/web/widgets/CFilterWidget.php#53 (показать)
public function getIsFilter()
{
    return 
$this->_isFilter;
}

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

Spec-Zone.ru

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