| 包 | system.web.widgets |
|---|---|
| 继承 | class CClipWidget » CWidget » CBaseController » CComponent |
| 源自 | 1.0 |
| 版本 | $Id: CClipWidget.PHP 2799 2011-01-01 19:31:13Z qiang.xue $ |
| 源码 |
CClipWidget 记录下它的内容，使之可以在其他地方使用。
在CClipWidget的init()和run()调用之间出现的内容， 将作为所属控制器的一个Clip保存起来。这个Clip在widget ID之后被命名。
参见 CBaseController::beginClip 和 CBaseController::endClip 以了解CClipWidget的快捷使用格式。
在CClipWidget的init()和run()调用之间出现的内容， 将作为所属控制器的一个Clip保存起来。这个Clip在widget ID之后被命名。
参见 CBaseController::beginClip 和 CBaseController::endClip 以了解CClipWidget的快捷使用格式。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| actionPrefix | string | actions的ID的前缀。 当微件在CController::actions中声明了 动作提供者，可以为其动作的ID指定前缀以区别 于别的微件或控制器。当微件用于控制器 的视图中时，必须配置同样的前缀。 | CWidget |
| controller | CController | 返回此微件所属的控制器。 | CWidget |
| id | string | 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 | CWidget |
| owner | CBaseController | 返回此微件的所有者或创建者。 | CWidget |
| renderClip | boolean | 是否在当前位置显示Clip的内容。默认值为false， 表示已捕获的Clip将不会被显示。 | CClipWidget |
| skin | mixed | 微件使用的皮肤的名称。默认为“default”。 如果此属性设置为false，微件将不会有皮肤被使用。 | CWidget |
| viewPath | string | 返回包含此微件所需的视图文件的路径。 | CWidget |
公共方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| __call() | 如果类中没有调的方法名，则调用这个方法。 | CComponent |
| __construct() | 构造器。 | CWidget |
| __get() | 返回一个属性值、一个事件处理程序列表或一个行为名称。 | CComponent |
| __isset() | 检查一个属性是否为null。 | CComponent |
| __set() | 设置一个组件的属性值。 | CComponent |
| __unset() | 设置一个组件的属性为null。 | CComponent |
| actions() | 返回此widget使用的动作的列表。 | CWidget |
| asa() | 返回这个名字的行为对象。 | CComponent |
| attachBehavior() | 附加一个行为到组件。 | CComponent |
| attachBehaviors() | 附加一个行为列表到组件。 | CComponent |
| attachEventHandler() | 为事件附加一个事件处理程序。 | CComponent |
| beginCache() | Begins fragment caching. | CBaseController |
| beginClip() | Begins recording a clip. | CBaseController |
| beginContent() | Begins the rendering of content that is to be decorated by the specified view. | CBaseController |
| beginWidget() | Creates a widget and executes it. | CBaseController |
| canGetProperty() | 确定属性是否可读。 | CComponent |
| canSetProperty() | 确定属性是否可写。 | CComponent |
| createWidget() | Creates a widget and initializes it. | CBaseController |
| detachBehavior() | 从组件中分离一个行为。 | CComponent |
| detachBehaviors() | 从组件中分离所有行为。 | CComponent |
| detachEventHandler() | 分离一个存在的事件处理程序。 | CComponent |
| disableBehavior() | 禁用一个附加行为。 | CComponent |
| disableBehaviors() | 禁用组件附加的所有行为。 | CComponent |
| enableBehavior() | 启用一个附加行为。 | CComponent |
| enableBehaviors() | 启用组件附加的所有行为。 | CComponent |
| endCache() | Ends fragment caching. | CBaseController |
| endClip() | Ends recording a clip. | CBaseController |
| endContent() | Ends the rendering of content. | CBaseController |
| endWidget() | Ends the execution of the named widget. | CBaseController |
| evaLuateExpression() | 计算一个PHP表达式，或根据组件上下文执行回调。 | CComponent |
| getController() | 返回此微件所属的控制器。 | CWidget |
| getEventHandlers() | 返回一个事件的附加处理程序列表。 | CComponent |
| getId() | 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 | CWidget |
| getOwner() | 返回此微件的所有者或创建者。 | CWidget |
| getViewFile() | 根据视图名查找视图文件。 | CWidget |
| getViewPath() | 返回包含此微件所需的视图文件的路径。 | CWidget |
| hasEvent() | 确定一个事件是否定义。 | CComponent |
| hasEventHandler() | 检查事件是否有附加的处理程序。 | CComponent |
| hasProperty() | 确定属性是否被定义。 | CComponent |
| init() | 开始记录一个Clip。 | CClipWidget |
| raiseEvent() | 发起一个事件。 | CComponent |
| render() | 渲染一个视图。 | CWidget |
| renderFile() | Renders a view file. | CBaseController |
| renderInternal() | Renders a view file. | CBaseController |
| run() | 结束一个Clip的记录。 | CClipWidget |
| setId() | 设置此微件的ID。 | CWidget |
| widget() | Creates a widget and executes it. | CBaseController |
属性详细
renderClip
属性
public boolean $renderClip;
是否在当前位置显示Clip的内容。默认值为false， 表示已捕获的Clip将不会被显示。
方法详细
init()
方法
|
public void init()
|
public function init()
{
ob_start();
ob_implicit_flush(false);
}
开始记录一个Clip。
run()
方法
|
public void run()
|
public function run()
{
$clip=ob_get_clean();
if($this->renderClip)
echo $clip;
$this->getController()->getClips()->add($this->getId(),$clip);
}
结束一个Clip的记录。 此方法停止记录输出缓冲区并将渲染结果作为所属控制器的一个被命名的Clip保存。