COutputProcessor.php
1.96 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<?php
/**
* COutputProcessor class file.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.yiiframework.com/
* @copyright Copyright © 2008-2011 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
/**
* COutputProcessor transforms the content into a different format.
*
* COutputProcessor captures the output generated by an action or a view fragment
* and passes it to its {@link onProcessOutput} event handlers for further processing.
*
* The event handler may process the output and store it back to the {@link COutputEvent::output}
* property. By setting the {@link CEvent::handled handled} property of the event parameter
* to true, the output will not be echoed anymore. Otherwise (by default), the output will be echoed.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id$
* @package system.web.widgets
* @since 1.0
*/
class COutputProcessor extends CFilterWidget
{
/**
* Initializes the widget.
* This method starts the output buffering.
*/
public function init()
{
ob_start();
ob_implicit_flush(false);
}
/**
* Executes the widget.
* This method stops output buffering and processes the captured output.
*/
public function run()
{
$output=ob_get_clean();
$this->processOutput($output);
}
/**
* Processes the captured output.
*
* The default implementation raises an {@link onProcessOutput} event.
* If the event is not handled by any event handler, the output will be echoed.
*
* @param string $output the captured output to be processed
*/
public function processOutput($output)
{
if($this->hasEventHandler('onProcessOutput'))
{
$event=new COutputEvent($this,$output);
$this->onProcessOutput($event);
if(!$event->handled)
echo $output;
}
else
echo $output;
}
/**
* Raised when the output has been captured.
* @param COutputEvent $event event parameter
*/
public function onProcessOutput($event)
{
$this->raiseEvent('onProcessOutput',$event);
}
}