ViewEvent.php 1.29 KB
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\base;

/**
 * ViewEvent represents events triggered by the [[View]] component.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class ViewEvent extends Event
{
	/**
	 * @var string the rendering result of [[View::renderFile()]].
	 * Event handlers may modify this property and the modified output will be
	 * returned by [[View::renderFile()]]. This property is only used
	 * by [[View::EVENT_AFTER_RENDER]] event.
	 */
	public $output;
	/**
	 * @var string the view file path that is being rendered by [[View::renderFile()]].
	 */
	public $viewFile;
	/**
	 * @var boolean whether to continue rendering the view file. Event handlers of
	 * [[View::EVENT_BEFORE_RENDER]] may set this property to decide whether
	 * to continue rendering the current view file.
	 */
	public $isValid = true;

	/**
	 * Constructor.
	 * @param string $viewFile the view file path that is being rendered by [[View::renderFile()]].
	 * @param array $config name-value pairs that will be used to initialize the object properties
	 */
	public function __construct($viewFile, $config = [])
	{
		$this->viewFile = $viewFile;
		parent::__construct($config);
	}
}