View.php 17.1 KB
Newer Older
Alexander Makarov committed
1 2 3 4 5 6 7 8 9 10 11
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\web;

use Yii;
use yii\helpers\Html;
12
use yii\base\InvalidConfigException;
Alexander Makarov committed
13 14 15 16 17 18

/**
 * View represents a view object in the MVC pattern.
 *
 * View provides a set of methods (e.g. [[render()]]) for rendering purpose.
 *
19
 * View is configured as an application component in [[\yii\base\Application]] by default.
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
 * You can access that instance via `Yii::$app->view`.
 *
 * You can modify its configuration by adding an array to your application config under `components`
 * as it is shown in the following example:
 *
 * ~~~
 * 'view' => [
 *     'theme' => 'app\themes\MyTheme',
 *     'renderers' => [
 *         // you may add Smarty or Twig renderer here
 *     ]
 *     // ...
 * ]
 * ~~~
 *
Alexander Makarov committed
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
 * @property \yii\web\AssetManager $assetManager The asset manager. Defaults to the "assetManager" application
 * component.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class View extends \yii\base\View
{
	const EVENT_BEGIN_BODY = 'beginBody';
	/**
	 * @event Event an event that is triggered by [[endBody()]].
	 */
	const EVENT_END_BODY = 'endBody';

	/**
	 * The location of registered JavaScript code block or files.
	 * This means the location is in the head section.
	 */
	const POS_HEAD = 1;
	/**
	 * The location of registered JavaScript code block or files.
	 * This means the location is at the beginning of the body section.
	 */
	const POS_BEGIN = 2;
	/**
	 * The location of registered JavaScript code block or files.
	 * This means the location is at the end of the body section.
	 */
	const POS_END = 3;
	/**
	 * The location of registered JavaScript code block.
	 * This means the JavaScript code block will be enclosed within `jQuery(document).ready()`.
	 */
	const POS_READY = 4;
69 70 71 72 73
	/**
	 * The location of registered JavaScript code block.
	 * This means the JavaScript code block will be enclosed within `jQuery(window).load()`.
	 */
	const POS_LOAD = 5;
Alexander Makarov committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
	/**
	 * This is internally used as the placeholder for receiving the content registered for the head section.
	 */
	const PH_HEAD = '<![CDATA[YII-BLOCK-HEAD]]>';
	/**
	 * This is internally used as the placeholder for receiving the content registered for the beginning of the body section.
	 */
	const PH_BODY_BEGIN = '<![CDATA[YII-BLOCK-BODY-BEGIN]]>';
	/**
	 * This is internally used as the placeholder for receiving the content registered for the end of the body section.
	 */
	const PH_BODY_END = '<![CDATA[YII-BLOCK-BODY-END]]>';

	/**
	 * @var AssetBundle[] list of the registered asset bundles. The keys are the bundle names, and the values
	 * are the registered [[AssetBundle]] objects.
Taras Gudz committed
90
	 * @see registerAssetBundle()
Alexander Makarov committed
91 92 93 94 95 96 97 98
	 */
	public $assetBundles = [];
	/**
	 * @var string the page title
	 */
	public $title;
	/**
	 * @var array the registered meta tags.
Taras Gudz committed
99
	 * @see registerMetaTag()
Alexander Makarov committed
100 101 102 103
	 */
	public $metaTags;
	/**
	 * @var array the registered link tags.
Taras Gudz committed
104
	 * @see registerLinkTag()
Alexander Makarov committed
105 106 107 108
	 */
	public $linkTags;
	/**
	 * @var array the registered CSS code blocks.
Taras Gudz committed
109
	 * @see registerCss()
Alexander Makarov committed
110 111 112 113
	 */
	public $css;
	/**
	 * @var array the registered CSS files.
Taras Gudz committed
114
	 * @see registerCssFile()
Alexander Makarov committed
115 116 117 118
	 */
	public $cssFiles;
	/**
	 * @var array the registered JS code blocks
Taras Gudz committed
119
	 * @see registerJs()
Alexander Makarov committed
120 121 122 123
	 */
	public $js;
	/**
	 * @var array the registered JS files.
Taras Gudz committed
124
	 * @see registerJsFile()
Alexander Makarov committed
125 126 127 128 129
	 */
	public $jsFiles;

	private $_assetManager;

130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
	/**
	 * Renders a view in response to an AJAX request.
	 *
	 * This method is similar to [[render()]] except that it will surround the view being rendered
	 * with the calls of [[beginPage()]], [[head()]], [[beginBody()]], [[endBody()]] and [[endPage()]].
	 * By doing so, the method is able to inject into the rendering result with JS/CSS scripts and files
	 * that are registered with the view.
	 *
	 * @param string $view the view name. Please refer to [[render()]] on how to specify this parameter.
	 * @param array $params the parameters (name-value pairs) that will be extracted and made available in the view file.
	 * @param object $context the context that the view should use for rendering the view. If null,
	 * existing [[context]] will be used.
	 * @return string the rendering result
	 * @see render()
	 */
	public function renderAjax($view, $params = [], $context = null)
	{
		$viewFile = $this->findViewFile($view, $context);

		ob_start();
		ob_implicit_flush(false);

		$this->beginPage();
		$this->head();
		$this->beginBody();
		echo $this->renderFile($viewFile, $params, $context);
		$this->endBody();
		$this->endPage(true);

		return ob_get_clean();
	}

Alexander Makarov committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
	/**
	 * Registers the asset manager being used by this view object.
	 * @return \yii\web\AssetManager the asset manager. Defaults to the "assetManager" application component.
	 */
	public function getAssetManager()
	{
		return $this->_assetManager ?: Yii::$app->getAssetManager();
	}

	/**
	 * Sets the asset manager.
	 * @param \yii\web\AssetManager $value the asset manager
	 */
	public function setAssetManager($value)
	{
		$this->_assetManager = $value;
	}

	/**
	 * Marks the ending of an HTML page.
182 183 184
	 * @param boolean $ajaxMode whether the view is rendering in AJAX mode.
	 * If true, the JS scripts registered at [[POS_READY]] and [[POS_LOAD]] positions
	 * will be rendered at the end of the view like normal scripts.
Alexander Makarov committed
185
	 */
186
	public function endPage($ajaxMode = false)
Alexander Makarov committed
187 188 189 190 191 192 193 194 195 196
	{
		$this->trigger(self::EVENT_END_PAGE);

		$content = ob_get_clean();
		foreach (array_keys($this->assetBundles) as $bundle) {
			$this->registerAssetFiles($bundle);
		}
		echo strtr($content, [
			self::PH_HEAD => $this->renderHeadHtml(),
			self::PH_BODY_BEGIN => $this->renderBodyBeginHtml(),
197
			self::PH_BODY_END => $this->renderBodyEndHtml($ajaxMode),
Alexander Makarov committed
198 199
		]);

200 201 202 203 204 205 206 207
		$this->clear();
	}

	/**
	 * Clears up the registered meta tags, link tags, css/js scripts and files.
	 */
	public function clear()
	{
208 209 210 211 212 213
		$this->metaTags = null;
		$this->linkTags = null;
		$this->css = null;
		$this->cssFiles = null;
		$this->js = null;
		$this->jsFiles = null;
Alexander Makarov committed
214 215 216 217 218 219 220 221 222 223 224 225 226
	}

	/**
	 * Registers all files provided by an asset bundle including depending bundles files.
	 * Removes a bundle from [[assetBundles]] once files are registered.
	 * @param string $name name of the bundle to register
	 */
	private function registerAssetFiles($name)
	{
		if (!isset($this->assetBundles[$name])) {
			return;
		}
		$bundle = $this->assetBundles[$name];
227 228 229 230 231
		if ($bundle) {
			foreach ($bundle->depends as $dep) {
				$this->registerAssetFiles($dep);
			}
			$bundle->registerAssetFiles($this);
Alexander Makarov committed
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
		}
		unset($this->assetBundles[$name]);
	}

	/**
	 * Marks the beginning of an HTML body section.
	 */
	public function beginBody()
	{
		echo self::PH_BODY_BEGIN;
		$this->trigger(self::EVENT_BEGIN_BODY);
	}

	/**
	 * Marks the ending of an HTML body section.
	 */
	public function endBody()
	{
		$this->trigger(self::EVENT_END_BODY);
		echo self::PH_BODY_END;
	}

	/**
	 * Marks the position of an HTML head section.
	 */
	public function head()
	{
		echo self::PH_HEAD;
	}

	/**
	 * Registers the named asset bundle.
	 * All dependent asset bundles will be registered.
	 * @param string $name the name of the asset bundle.
	 * @param integer|null $position if set, this forces a minimum position for javascript files.
	 * This will adjust depending assets javascript file position or fail if requirement can not be met.
	 * If this is null, asset bundles position settings will not be changed.
	 * See [[registerJsFile]] for more details on javascript position.
	 * @return AssetBundle the registered asset bundle instance
	 * @throws InvalidConfigException if the asset bundle does not exist or a circular dependency is detected
	 */
	public function registerAssetBundle($name, $position = null)
	{
		if (!isset($this->assetBundles[$name])) {
			$am = $this->getAssetManager();
			$bundle = $am->getBundle($name);
			$this->assetBundles[$name] = false;
			// register dependencies
			$pos = isset($bundle->jsOptions['position']) ? $bundle->jsOptions['position'] : null;
			foreach ($bundle->depends as $dep) {
				$this->registerAssetBundle($dep, $pos);
			}
			$this->assetBundles[$name] = $bundle;
		} elseif ($this->assetBundles[$name] === false) {
			throw new InvalidConfigException("A circular dependency is detected for bundle '$name'.");
		} else {
			$bundle = $this->assetBundles[$name];
		}

		if ($position !== null) {
			$pos = isset($bundle->jsOptions['position']) ? $bundle->jsOptions['position'] : null;
			if ($pos === null) {
				$bundle->jsOptions['position'] = $pos = $position;
			} elseif ($pos > $position) {
				throw new InvalidConfigException("An asset bundle that depends on '$name' has a higher javascript file position configured than '$name'.");
			}
			// update position for all dependencies
			foreach ($bundle->depends as $dep) {
				$this->registerAssetBundle($dep, $pos);
			}
		}
		return $bundle;
	}

	/**
	 * Registers a meta tag.
	 * @param array $options the HTML attributes for the meta tag.
	 * @param string $key the key that identifies the meta tag. If two meta tags are registered
	 * with the same key, the latter will overwrite the former. If this is null, the new meta tag
	 * will be appended to the existing ones.
	 */
	public function registerMetaTag($options, $key = null)
	{
		if ($key === null) {
			$this->metaTags[] = Html::tag('meta', '', $options);
		} else {
			$this->metaTags[$key] = Html::tag('meta', '', $options);
		}
	}

	/**
	 * Registers a link tag.
	 * @param array $options the HTML attributes for the link tag.
	 * @param string $key the key that identifies the link tag. If two link tags are registered
	 * with the same key, the latter will overwrite the former. If this is null, the new link tag
	 * will be appended to the existing ones.
	 */
	public function registerLinkTag($options, $key = null)
	{
		if ($key === null) {
			$this->linkTags[] = Html::tag('link', '', $options);
		} else {
			$this->linkTags[$key] = Html::tag('link', '', $options);
		}
	}

	/**
	 * Registers a CSS code block.
	 * @param string $css the CSS code block to be registered
	 * @param array $options the HTML attributes for the style tag.
	 * @param string $key the key that identifies the CSS code block. If null, it will use
	 * $css as the key. If two CSS code blocks are registered with the same key, the latter
	 * will overwrite the former.
	 */
	public function registerCss($css, $options = [], $key = null)
	{
		$key = $key ?: md5($css);
		$this->css[$key] = Html::style($css, $options);
	}

	/**
	 * Registers a CSS file.
	 * @param string $url the CSS file to be registered.
355
	 * @param array $depends the names of the asset bundles that this CSS file depends on
Alexander Makarov committed
356 357 358 359 360
	 * @param array $options the HTML attributes for the link tag.
	 * @param string $key the key that identifies the CSS script file. If null, it will use
	 * $url as the key. If two CSS files are registered with the same key, the latter
	 * will overwrite the former.
	 */
361
	public function registerCssFile($url, $depends = [], $options = [], $key = null)
Alexander Makarov committed
362
	{
363
		$url = Yii::getAlias($url);
Alexander Makarov committed
364
		$key = $key ?: $url;
365 366 367 368 369 370 371 372 373 374 375
		if (empty($depends)) {
			$this->cssFiles[$key] = Html::cssFile($url, $options);
		} else {
			$am = Yii::$app->getAssetManager();
			$am->bundles[$key] = new AssetBundle([
				'css' => [$url],
				'cssOptions' => $options,
				'depends' => (array)$depends,
			]);
			$this->registerAssetBundle($key);
		}
Alexander Makarov committed
376 377 378 379 380 381 382 383 384 385 386
	}

	/**
	 * Registers a JS code block.
	 * @param string $js the JS code block to be registered
	 * @param integer $position the position at which the JS script tag should be inserted
	 * in a page. The possible values are:
	 *
	 * - [[POS_HEAD]]: in the head section
	 * - [[POS_BEGIN]]: at the beginning of the body section
	 * - [[POS_END]]: at the end of the body section
387 388
	 * - [[POS_LOAD]]: enclosed within jQuery(window).load().
	 *   Note that by using this position, the method will automatically register the jQuery js file.
Alexander Makarov committed
389 390 391 392 393 394 395 396 397 398 399
	 * - [[POS_READY]]: enclosed within jQuery(document).ready(). This is the default value.
	 *   Note that by using this position, the method will automatically register the jQuery js file.
	 *
	 * @param string $key the key that identifies the JS code block. If null, it will use
	 * $js as the key. If two JS code blocks are registered with the same key, the latter
	 * will overwrite the former.
	 */
	public function registerJs($js, $position = self::POS_READY, $key = null)
	{
		$key = $key ?: md5($js);
		$this->js[$position][$key] = $js;
400
		if ($position === self::POS_READY || $position === self::POS_LOAD) {
Alexander Makarov committed
401 402 403 404 405 406 407
			JqueryAsset::register($this);
		}
	}

	/**
	 * Registers a JS file.
	 * @param string $url the JS file to be registered.
408
	 * @param array $depends the names of the asset bundles that this JS file depends on
Alexander Makarov committed
409 410 411 412 413 414 415 416 417 418 419 420
	 * @param array $options the HTML attributes for the script tag. A special option
	 * named "position" is supported which specifies where the JS script tag should be inserted
	 * in a page. The possible values of "position" are:
	 *
	 * - [[POS_HEAD]]: in the head section
	 * - [[POS_BEGIN]]: at the beginning of the body section
	 * - [[POS_END]]: at the end of the body section. This is the default value.
	 *
	 * @param string $key the key that identifies the JS script file. If null, it will use
	 * $url as the key. If two JS files are registered with the same key, the latter
	 * will overwrite the former.
	 */
421
	public function registerJsFile($url, $depends = [], $options = [], $key = null)
Alexander Makarov committed
422
	{
423
		$url = Yii::getAlias($url);
Alexander Makarov committed
424
		$key = $key ?: $url;
425 426 427 428 429 430 431 432 433 434 435 436 437
		if (empty($depends)) {
			$position = isset($options['position']) ? $options['position'] : self::POS_END;
			unset($options['position']);
			$this->jsFiles[$position][$key] = Html::jsFile($url, $options);
		} else {
			$am = Yii::$app->getAssetManager();
			$am->bundles[$key] = new AssetBundle([
				'js' => [$url],
				'jsOptions' => $options,
				'depends' => (array)$depends,
			]);
			$this->registerAssetBundle($key);
		}
Alexander Makarov committed
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
	}

	/**
	 * Renders the content to be inserted in the head section.
	 * The content is rendered using the registered meta tags, link tags, CSS/JS code blocks and files.
	 * @return string the rendered content
	 */
	protected function renderHeadHtml()
	{
		$lines = [];
		if (!empty($this->metaTags)) {
			$lines[] = implode("\n", $this->metaTags);
		}

		$request = Yii::$app->getRequest();
		if ($request instanceof \yii\web\Request && $request->enableCsrfValidation) {
			$lines[] = Html::tag('meta', '', ['name' => 'csrf-var', 'content' => $request->csrfVar]);
455
			$lines[] = Html::tag('meta', '', ['name' => 'csrf-token', 'content' => $request->getCsrfToken()]);
Alexander Makarov committed
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
		}

		if (!empty($this->linkTags)) {
			$lines[] = implode("\n", $this->linkTags);
		}
		if (!empty($this->cssFiles)) {
			$lines[] = implode("\n", $this->cssFiles);
		}
		if (!empty($this->css)) {
			$lines[] = implode("\n", $this->css);
		}
		if (!empty($this->jsFiles[self::POS_HEAD])) {
			$lines[] = implode("\n", $this->jsFiles[self::POS_HEAD]);
		}
		if (!empty($this->js[self::POS_HEAD])) {
			$lines[] = Html::script(implode("\n", $this->js[self::POS_HEAD]), ['type' => 'text/javascript']);
		}
		return empty($lines) ? '' : implode("\n", $lines);
	}

	/**
	 * Renders the content to be inserted at the beginning of the body section.
	 * The content is rendered using the registered JS code blocks and files.
	 * @return string the rendered content
	 */
	protected function renderBodyBeginHtml()
	{
		$lines = [];
		if (!empty($this->jsFiles[self::POS_BEGIN])) {
			$lines[] = implode("\n", $this->jsFiles[self::POS_BEGIN]);
		}
		if (!empty($this->js[self::POS_BEGIN])) {
			$lines[] = Html::script(implode("\n", $this->js[self::POS_BEGIN]), ['type' => 'text/javascript']);
		}
		return empty($lines) ? '' : implode("\n", $lines);
	}

	/**
	 * Renders the content to be inserted at the end of the body section.
	 * The content is rendered using the registered JS code blocks and files.
496 497 498
	 * @param boolean $ajaxMode whether the view is rendering in AJAX mode.
	 * If true, the JS scripts registered at [[POS_READY]] and [[POS_LOAD]] positions
	 * will be rendered at the end of the view like normal scripts.
Alexander Makarov committed
499 500
	 * @return string the rendered content
	 */
501
	protected function renderBodyEndHtml($ajaxMode)
Alexander Makarov committed
502 503
	{
		$lines = [];
504

Alexander Makarov committed
505 506 507
		if (!empty($this->jsFiles[self::POS_END])) {
			$lines[] = implode("\n", $this->jsFiles[self::POS_END]);
		}
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534

		if ($ajaxMode) {
			$scripts = [];
			if (!empty($this->js[self::POS_END])) {
				$scripts[] = implode("\n", $this->js[self::POS_END]);
			}
			if (!empty($this->js[self::POS_READY])) {
				$scripts[] = implode("\n", $this->js[self::POS_READY]);
			}
			if (!empty($this->js[self::POS_LOAD])) {
				$scripts[] = implode("\n", $this->js[self::POS_LOAD]);
			}
			if (!empty($scripts)) {
				$lines[] = Html::script(implode("\n", $scripts), ['type' => 'text/javascript']);
			}
		} else {
			if (!empty($this->js[self::POS_END])) {
				$lines[] = Html::script(implode("\n", $this->js[self::POS_END]), ['type' => 'text/javascript']);
			}
			if (!empty($this->js[self::POS_READY])) {
				$js = "jQuery(document).ready(function(){\n" . implode("\n", $this->js[self::POS_READY]) . "\n});";
				$lines[] = Html::script($js, ['type' => 'text/javascript']);
			}
			if (!empty($this->js[self::POS_LOAD])) {
				$js = "jQuery(window).load(function(){\n" . implode("\n", $this->js[self::POS_LOAD]) . "\n});";
				$lines[] = Html::script($js, ['type' => 'text/javascript']);
			}
535
		}
536

Alexander Makarov committed
537 538 539
		return empty($lines) ? '' : implode("\n", $lines);
	}
}