mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-04 06:37:55 +08:00
54 lines
1.3 KiB
PHP
54 lines
1.3 KiB
PHP
<?php
|
|
/**
|
|
* @link http://www.yiiframework.com/
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
|
* @license http://www.yiiframework.com/license/
|
|
*/
|
|
|
|
namespace yii\widgets;
|
|
|
|
use yii\base\InvalidConfigException;
|
|
use yii\base\Widget;
|
|
|
|
/**
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
* @since 2.0
|
|
*/
|
|
class ContentDecorator extends Widget
|
|
{
|
|
/**
|
|
* @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 = [];
|
|
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
}
|