Yii Framework v1.1.10 类参考
CClipWidget
| 包 | system.web.widgets |
|---|---|
| 继承 | class CClipWidget » CWidget » CBaseController » CComponent |
| 源自 | 1.0 |
| 版本 | $Id: CClipWidget.php 2799 2011-01-01 19:31:13Z qiang.xue $ |
| 源码 | framework/web/widgets/CClipWidget.php |
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 |
公共方法
属性详细
renderClip
属性
public boolean $renderClip;
是否在当前位置显示Clip的内容。默认值为false， 表示已捕获的Clip将不会被显示。
方法详细
init()
方法
|
public void init()
|
源码： framework/web/widgets/CClipWidget.php#36 (显示)
public function init()
{
ob_start();
ob_implicit_flush(false);
}
开始记录一个Clip。
run()
方法
|
public void run()
|
源码： framework/web/widgets/CClipWidget.php#46 (显示)
public function run()
{
$clip=ob_get_clean();
if($this->renderClip)
echo $clip;
$this->getController()->getClips()->add($this->getId(),$clip);
}
结束一个Clip的记录。 此方法停止记录输出缓冲区并将渲染结果作为所属控制器的一个被命名的Clip保存。