CClipWidget
| Пакет | system.web.widgets |
|---|---|
| Наследование | класс CClipWidget » CWidget » CBaseController » CComponent |
| С версии | 1.0 |
| Исходный код | framework/web/widgets/CClipWidget.php |
CClipWidget сохраняет свой контент и делает его доступным в других местах.
Контент, рендеренный между вызовами init() и run(), сохраняется как клип в контроллере. Клип получает имя, основанное на идентификаторе виджета.
Для краткого использования CClipWidget см. CBaseController::beginClip и CBaseController::endClip.
Контент, рендеренный между вызовами init() и run(), сохраняется как клип в контроллере. Клип получает имя, основанное на идентификаторе виджета.
Для краткого использования CClipWidget см. CBaseController::beginClip и CBaseController::endClip.
Свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| actionPrefix | строка | Префикс к идентификаторам действий. | CWidget |
| controller | CController | Возвращает контроллер, к которому принадлежит этот виджет. | CWidget |
| id | строка | Возвращает идентификатор виджета или генерирует новый, если запрошено. | CWidget |
| owner | CBaseController | Возвращает владельца/создателя этого виджета. | CWidget |
| renderClip | логическое значение | Определяет, следует ли отображать содержимое клипа на месте. | CClipWidget |
| skin | смешанный тип | Имя используемой темы для этого виджета. | CWidget |
| viewPath | строка | Возвращает директорию, содержащую файлы представления для этого виджета. | CWidget |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с заданным именем, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CWidget |
| __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 |
| getController() | Возвращает контроллер, к которому принадлежит этот виджет. | CWidget |
| getEventHandlers() | Возвращает список прикрепленных обработчиков событий для события. | CComponent |
| getId() | Возвращает идентификатор виджета или генерирует новый, если это необходимо. | CWidget |
| getOwner() | Возвращает владельца/создателя этого виджета. | CWidget |
| getViewFile() | Ищет файл сценария представления по имени представления. | CWidget |
| getViewPath() | Возвращает директорию, содержащую файлы представлений для этого виджета. | CWidget |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, имеет ли указанное событие прикрепленные обработчики. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| init() | Начинает запись клипа. | CClipWidget |
| raiseEvent() | Вызывает событие. | CComponent |
| render() | Отрисовывает представление. | CWidget |
| renderFile() | Отрисовывает файл представления. | CBaseController |
| renderInternal() | Отрисовывает файл представления. | CBaseController |
| run() | Заканчивает запись клипа. Этот метод останавливает буферизацию вывода и сохраняет результат отрисовки как именованный клип в контроллере. | CClipWidget |
| setId() | Устанавливает идентификатор виджета. | CWidget |
| widget() | Создаёт виджет и выполняет его. | CBaseController |
Подробное описание свойств
renderClip свойство
public boolean $renderClip;
определяет, нужно ли отрисовывать содержимое клипа на месте. По умолчанию false, что означает, что захваченный клип не будет отображаться.
Подробное описание методов
init() метод
public void init() |
Исходный код: framework/web/widgets/CClipWidget.php#35 (показать)
public function init()
{
ob_start();
ob_implicit_flush(false);
}
Начинает запись клипа.
run() метод
public void run() |
Исходный код: framework/web/widgets/CClipWidget.php#45 (показать)
public function run()
{
$clip=ob_get_clean();
if($this->renderClip)
echo $clip;
$this->getController()->getClips()->add($this->getId(),$clip);
}
Заканчивает запись клипа. Этот метод останавливает буферизацию вывода и сохраняет результат отрисовки как именованный клип в контроллере.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CClipWidget
