| 包 | system.web.widgets |
|---|---|
| 继承 | class COutputProcessor » CFilterWidget » CWidget » CBaseController » CComponent |
| 实现 | IFilter |
| 子类 | CContentDecorator, CHTMLPurifier, Cmarkdown, CTextHighlighter |
| 源自 | 1.0 |
| 版本 | $Id: COutputProcessor.PHP 2799 2011-01-01 19:31:13Z qiang.xue $ |
| 源码 |
COutputProcessor 将内容转换为不同的格式。
COutputProcessor 获取一个动作或视图片段生成的输出并传递到 它的onProcessOutput事件处理器进行进一步的处理。
事件处理器可以对输出进行处理并将处理结果保存到COutputEvent::output 属性中。通过设置事件参数的handled属性为真， 输出将不会被显示。否则（默认情况)，输出将被显示出来。
COutputProcessor 获取一个动作或视图片段生成的输出并传递到 它的onProcessOutput事件处理器进行进一步的处理。
事件处理器可以对输出进行处理并将处理结果保存到COutputEvent::output 属性中。通过设置事件参数的handled属性为真， 输出将不会被显示。否则（默认情况)，输出将被显示出来。
公共属性
| 属性 | 类型 | 描述 | 定义在 |
|---|---|---|---|
| actionPrefix | string | actions的ID的前缀。 当微件在CController::actions中声明了 动作提供者，可以为其动作的ID指定前缀以区别 于别的微件或控制器。当微件用于控制器 的视图中时，必须配置同样的前缀。 | CWidget |
| controller | CController | 返回此微件所属的控制器。 | CWidget |
| id | string | 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 | CWidget |
| isFilter | boolean | 这个widget是否作为一个过滤器使用。 | CFilterWidget |
| owner | CBaseController | 返回此微件的所有者或创建者。 | CWidget |
| skin | mixed | 微件使用的皮肤的名称。默认为“default”。 如果此属性设置为false，微件将不会有皮肤被使用。 | CWidget |
| stopAction | boolean | 当这个widget用作一个过滤器时是否停止动作的执行。 此属性应当仅在CWidget::init方法中进行改变。 默认值是false，表示动作将会被执行。 | CFilterWidget |
| viewPath | string | 返回包含此微件所需的视图文件的路径。 | CWidget |
公共方法
| 方法 | 描述 | 定义在 |
|---|---|---|
| __call() | 如果类中没有调的方法名，则调用这个方法。 | CComponent |
| __construct() | 构造器。 | CFilterWidget |
| __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 |
| filter() | 执行过滤。 | CFilterWidget |
| getController() | 返回此微件所属的控制器。 | CWidget |
| getEventHandlers() | 返回一个事件的附加处理程序列表。 | CComponent |
| getId() | 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 | CWidget |
| getIsFilter() | 检查这个widget是否作为一个过滤器使用。 | CFilterWidget |
| getOwner() | 返回此微件的所有者或创建者。 | CWidget |
| getViewFile() | 根据视图名查找视图文件。 | CWidget |
| getViewPath() | 返回包含此微件所需的视图文件的路径。 | CWidget |
| hasEvent() | 确定一个事件是否定义。 | CComponent |
| hasEventHandler() | 检查事件是否有附加的处理程序。 | CComponent |
| hasProperty() | 确定属性是否被定义。 | CComponent |
| init() | 初始化此小物件。 | COutputProcessor |
| onProcessOutput() | 当获取到输出时激发。 | COutputProcessor |
| processOutput() | 处理获取的输出。 | COutputProcessor |
| raiseEvent() | 发起一个事件。 | CComponent |
| render() | 渲染一个视图。 | CWidget |
| renderFile() | Renders a view file. | CBaseController |
| renderInternal() | Renders a view file. | CBaseController |
| run() | 运行此小物件。 | COutputProcessor |
| setId() | 设置此微件的ID。 | CWidget |
| widget() | Creates a widget and executes it. | CBaseController |
事件
| 事件 | 描述 | 定义在 |
|---|---|---|
| onProcessOutput | 当获取到输出时激发。 | COutputProcessor |
方法详细
init()
方法
|
public void init()
|
public function init()
{
ob_start();
ob_implicit_flush(false);
}
初始化此小物件。 此方法开始对输出进行缓冲。
onProcessOutput()
方法
|
public void onProcessOutput(COutputEvent $event)
| ||
| $event | COutputEvent | 事件参数 |
public function onProcessOutput($event)
{
$this->raiseEvent('onProcessOutput',$event);
}
当获取到输出时激发。
processOutput()
方法
|
public void processOutput(string $output)
| ||
| $output | string | 需要处理的获取的输出 |
public function processOutput($output)
{
if($this->hasEventHandler('onProcessOutput'))
{
$event=new COutputEvent($this,$output);
$this->onProcessOutput($event);
if(!$event->handled)
echo $output;
}
else
echo $output;
}
处理获取的输出。
默认的实现是激发一个onProcessOutput事件。
如果该事件未被任何事件处理器处理，输出将直接被显示。
run()
方法
|
public void run()
|
public function run()
{
$output=ob_get_clean();
$this->processOutput($output);
}
运行此小物件。 此方法停止对输出的缓冲并对获取的输出内容进行处理。