ContentDecorator.php 1.33 KB
Newer Older
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
8 9 10 11 12
namespace yii\widgets;

use yii\base\InvalidConfigException;
use yii\base\Widget;

Qiang Xue committed
13 14
/**
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
15
 * @since 2.0
Qiang Xue committed
16
 */
Qiang Xue committed
17
class ContentDecorator extends Widget
Qiang Xue committed
18
{
19 20 21 22 23 24 25 26 27
    /**
     * @var string the view file that will be used to decorate the content enclosed by this widget.
     * This can be specified as either the view file path or path alias.
     */
    public $viewFile;
    /**
     * @var array the parameters (name => value) to be extracted and made available in the decorative view.
     */
    public $params = [];
Qiang Xue committed
28

29

30 31 32 33 34 35 36 37 38 39 40
    /**
     * Starts recording a clip.
     */
    public function init()
    {
        if ($this->viewFile === null) {
            throw new InvalidConfigException('ContentDecorator::viewFile must be set.');
        }
        ob_start();
        ob_implicit_flush(false);
    }
Qiang Xue committed
41

42 43 44 45 46 47 48 49 50 51 52
    /**
     * Ends recording a clip.
     * This method stops output buffering and saves the rendering result as a named clip in the controller.
     */
    public function run()
    {
        $params = $this->params;
        $params['content'] = ob_get_clean();
        // render under the existing context
        echo $this->view->renderFile($this->viewFile, $params);
    }
Qiang Xue committed
53
}