Block.php 948 Bytes
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
<?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\Widget;

/**
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
Qiang Xue committed
16
class Block extends Widget
Qiang Xue committed
17 18
{
	/**
Qiang Xue committed
19
	 * @var string the ID of this block.
Qiang Xue committed
20 21 22
	 */
	public $id;
	/**
Qiang Xue committed
23 24
	 * @var boolean whether to render the block content in place. Defaults to false,
	 * meaning the captured block content will not be displayed.
Qiang Xue committed
25 26 27 28
	 */
	public $renderInPlace = false;

	/**
Qiang Xue committed
29
	 * Starts recording a block.
Qiang Xue committed
30 31 32 33 34 35 36 37
	 */
	public function init()
	{
		ob_start();
		ob_implicit_flush(false);
	}

	/**
Qiang Xue committed
38 39
	 * Ends recording a block.
	 * This method stops output buffering and saves the rendering result as a named block in the controller.
Qiang Xue committed
40 41 42
	 */
	public function run()
	{
Qiang Xue committed
43 44 45
		$block = ob_get_clean();
		if ($this->renderInPlace) {
			echo $block;
Qiang Xue committed
46
		}
Qiang Xue committed
47
		$this->view->blocks[$this->id] = $block;
Qiang Xue committed
48
	}
Zander Baldwin committed
49
}