View.php 23.4 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 8 9
 * @license http://www.yiiframework.com/license/
 */

namespace yii\base;

Qiang Xue committed
10
use Yii;
Qiang Xue committed
11
use yii\base\Application;
Qiang Xue committed
12
use yii\helpers\FileHelper;
13
use yii\helpers\Html;
14 15 16
use yii\widgets\Block;
use yii\widgets\ContentDecorator;
use yii\widgets\FragmentCache;
Qiang Xue committed
17

Qiang Xue committed
18
/**
Qiang Xue committed
19
 * View represents a view object in the MVC pattern.
Qiang Xue committed
20
 *
Qiang Xue committed
21
 * View provides a set of methods (e.g. [[render()]]) for rendering purpose.
Qiang Xue committed
22
 *
Qiang Xue committed
23 24 25 26 27
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class View extends Component
{
28 29 30 31 32 33 34 35
	/**
	 * @event ViewEvent an event that is triggered by [[beginPage()]].
	 */
	const EVENT_BEGIN_PAGE = 'beginPage';
	/**
	 * @event ViewEvent an event that is triggered by [[endPage()]].
	 */
	const EVENT_END_PAGE = 'endPage';
36
	/**
37
	 * @event ViewEvent an event that is triggered by [[renderFile()]] right before it renders a view file.
38 39 40
	 */
	const EVENT_BEFORE_RENDER = 'beforeRender';
	/**
41
	 * @event ViewEvent an event that is triggered by [[renderFile()]] right after it renders a view file.
42 43 44
	 */
	const EVENT_AFTER_RENDER = 'afterRender';

Qiang Xue committed
45
	/**
46 47
	 * The location of registered JavaScript code block or files.
	 * This means the location is in the head section.
Qiang Xue committed
48
	 */
49 50 51 52 53 54 55 56 57 58 59
	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;
60 61 62 63 64
	/**
	 * The location of registered JavaScript code block.
	 * This means the JavaScript code block will be enclosed within `jQuery(document).ready()`.
	 */
	const POS_READY = 4;
65 66 67 68 69 70 71 72
	/**
	 * This is internally used as the placeholder for receiving the content registered for the head section.
	 */
	const PL_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 PL_BODY_BEGIN = '<![CDATA[YII-BLOCK-BODY-BEGIN]]>';
Qiang Xue committed
73
	/**
74
	 * This is internally used as the placeholder for receiving the content registered for the end of the body section.
Qiang Xue committed
75
	 */
76 77 78 79 80 81 82 83
	const PL_BODY_END = '<![CDATA[YII-BLOCK-BODY-END]]>';


	/**
	 * @var object the context under which the [[renderFile()]] method is being invoked.
	 * This can be a controller, a widget, or any other object.
	 */
	public $context;
Qiang Xue committed
84
	/**
Qiang Xue committed
85
	 * @var mixed custom parameters that are shared among view templates.
Qiang Xue committed
86
	 */
Qiang Xue committed
87
	public $params;
Qiang Xue committed
88
	/**
Qiang Xue committed
89 90
	 * @var array a list of available renderers indexed by their corresponding supported file extensions.
	 * Each renderer may be a view renderer object or the configuration for creating the renderer object.
91 92 93
	 * The default setting supports both Smarty and Twig (their corresponding file extension is "tpl"
	 * and "twig" respectively. Please refer to [[SmartyRenderer]] and [[TwigRenderer]] on how to install
	 * the needed libraries for these template engines.
Qiang Xue committed
94 95 96
	 *
	 * If no renderer is available for the given view file, the view file will be treated as a normal PHP
	 * and rendered via [[renderPhpFile()]].
Qiang Xue committed
97
	 */
98 99 100 101 102 103 104 105
	public $renderers = array(
		'tpl' => array(
			'class' => 'yii\renderers\SmartyRenderer',
		),
		'twig' => array(
			'class' => 'yii\renderers\TwigRenderer',
		),
	);
106
	/**
107
	 * @var Theme|array the theme object or the configuration array for creating the theme object.
Qiang Xue committed
108
	 * If not set, it means theming is not enabled.
109
	 */
Qiang Xue committed
110
	public $theme;
Qiang Xue committed
111
	/**
Qiang Xue committed
112 113
	 * @var array a list of named output blocks. The keys are the block names and the values
	 * are the corresponding block content. You can call [[beginBlock()]] and [[endBlock()]]
114
	 * to capture small fragments of a view. They can be later accessed somewhere else
Qiang Xue committed
115 116
	 * through this property.
	 */
Qiang Xue committed
117
	public $blocks;
Qiang Xue committed
118 119
	/**
	 * @var array a list of currently active fragment cache widgets. This property
120 121
	 * is used internally to implement the content caching feature. Do not modify it directly.
	 * @internal
Qiang Xue committed
122 123 124 125
	 */
	public $cacheStack = array();
	/**
	 * @var array a list of placeholders for embedding dynamic contents. This property
126 127
	 * is used internally to implement the content caching feature. Do not modify it directly.
	 * @internal
Qiang Xue committed
128
	 */
Qiang Xue committed
129
	public $dynamicPlaceholders = array();
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 162 163 164 165 166 167 168 169
	/**
	 * @var array the registered asset bundles. The keys are the bundle names, and the values
	 * are the corresponding [[AssetBundle]] objects.
	 * @see registerAssetBundle
	 */
	public $assetBundles;
	/**
	 * @var string the page title
	 */
	public $title;
	/**
	 * @var array the registered meta tags.
	 * @see registerMetaTag
	 */
	public $metaTags;
	/**
	 * @var array the registered link tags.
	 * @see registerLinkTag
	 */
	public $linkTags;
	/**
	 * @var array the registered CSS code blocks.
	 * @see registerCss
	 */
	public $css;
	/**
	 * @var array the registered CSS files.
	 * @see registerCssFile
	 */
	public $cssFiles;
	/**
	 * @var array the registered JS code blocks
	 * @see registerJs
	 */
	public $js;
	/**
	 * @var array the registered JS files.
	 * @see registerJsFile
	 */
	public $jsFiles;
Qiang Xue committed
170 171


Qiang Xue committed
172
	/**
Qiang Xue committed
173
	 * Initializes the view component.
Qiang Xue committed
174
	 */
Qiang Xue committed
175
	public function init()
Qiang Xue committed
176
	{
Qiang Xue committed
177 178
		parent::init();
		if (is_array($this->theme)) {
179 180 181
			if (!isset($this->theme['class'])) {
				$this->theme['class'] = 'yii\base\Theme';
			}
Qiang Xue committed
182
			$this->theme = Yii::createObject($this->theme);
Qiang Xue committed
183 184 185
		}
	}

Qiang Xue committed
186
	/**
Qiang Xue committed
187
	 * Renders a view.
Qiang Xue committed
188
	 *
Qiang Xue committed
189
	 * This method delegates the call to the [[context]] object:
Qiang Xue committed
190
	 *
Qiang Xue committed
191 192 193 194 195 196
	 * - If [[context]] is a controller, the [[Controller::renderPartial()]] method will be called;
	 * - If [[context]] is a widget, the [[Widget::render()]] method will be called;
	 * - Otherwise, an InvalidCallException exception will be thrown.
	 *
	 * @param string $view the view name. Please refer to [[Controller::findViewFile()]]
	 * and [[Widget::findViewFile()]] on how to specify this parameter.
Qiang Xue committed
197
	 * @param array $params the parameters (name-value pairs) that will be extracted and made available in the view file.
198
	 * @return string the rendering result
Qiang Xue committed
199
	 * @throws InvalidCallException if [[context]] is neither a controller nor a widget.
Qiang Xue committed
200 201
	 * @throws InvalidParamException if the view cannot be resolved or the view file does not exist.
	 * @see renderFile
Qiang Xue committed
202
	 */
Qiang Xue committed
203
	public function render($view, $params = array())
Qiang Xue committed
204
	{
Qiang Xue committed
205 206 207 208 209 210 211
		if ($this->context instanceof Controller) {
			return $this->context->renderPartial($view, $params);
		} elseif ($this->context instanceof Widget) {
			return $this->context->render($view, $params);
		} else {
			throw new InvalidCallException('View::render() is not supported for the current context.');
		}
Qiang Xue committed
212 213
	}

Qiang Xue committed
214 215
	/**
	 * Renders a view file.
Qiang Xue committed
216
	 *
Qiang Xue committed
217 218
	 * If [[theme]] is enabled (not null), it will try to render the themed version of the view file as long
	 * as it is available.
Qiang Xue committed
219
	 *
Qiang Xue committed
220 221 222 223 224 225
	 * The method will call [[FileHelper::localize()]] to localize the view file.
	 *
	 * If [[renderer]] is enabled (not null), the method will use it to render the view file.
	 * Otherwise, it will simply include the view file as a normal PHP file, capture its output and
	 * return it as a string.
	 *
Qiang Xue committed
226
	 * @param string $viewFile the view file. This can be either a file path or a path alias.
Qiang Xue committed
227
	 * @param array $params the parameters (name-value pairs) that will be extracted and made available in the view file.
Qiang Xue committed
228 229
	 * @param object $context the context that the view should use for rendering the view. If null,
	 * existing [[context]] will be used.
Qiang Xue committed
230
	 * @return string the rendering result
Qiang Xue committed
231
	 * @throws InvalidParamException if the view file does not exist
Qiang Xue committed
232
	 */
Qiang Xue committed
233
	public function renderFile($viewFile, $params = array(), $context = null)
Qiang Xue committed
234
	{
Qiang Xue committed
235 236 237 238 239 240 241 242 243 244
		$viewFile = Yii::getAlias($viewFile);
		if (is_file($viewFile)) {
			if ($this->theme !== null) {
				$viewFile = $this->theme->applyTo($viewFile);
			}
			$viewFile = FileHelper::localize($viewFile);
		} else {
			throw new InvalidParamException("The view file does not exist: $viewFile");
		}

Qiang Xue committed
245
		$oldContext = $this->context;
Qiang Xue committed
246 247 248
		if ($context !== null) {
			$this->context = $context;
		}
Qiang Xue committed
249

250 251
		$output = '';
		if ($this->beforeRender($viewFile)) {
Qiang Xue committed
252 253 254 255 256 257 258 259
			$ext = pathinfo($viewFile, PATHINFO_EXTENSION);
			if (isset($this->renderers[$ext])) {
				if (is_array($this->renderers[$ext])) {
					$this->renderers[$ext] = Yii::createObject($this->renderers[$ext]);
				}
				/** @var ViewRenderer $renderer */
				$renderer = $this->renderers[$ext];
				$output = $renderer->render($this, $viewFile, $params);
260 261 262 263
			} else {
				$output = $this->renderPhpFile($viewFile, $params);
			}
			$this->afterRender($viewFile, $output);
Qiang Xue committed
264
		}
Qiang Xue committed
265 266 267 268

		$this->context = $oldContext;

		return $output;
Qiang Xue committed
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
	/**
	 * This method is invoked right before [[renderFile()]] renders a view file.
	 * The default implementation will trigger the [[EVENT_BEFORE_RENDER]] event.
	 * If you override this method, make sure you call the parent implementation first.
	 * @param string $viewFile the view file to be rendered
	 * @return boolean whether to continue rendering the view file.
	 */
	public function beforeRender($viewFile)
	{
		$event = new ViewEvent($viewFile);
		$this->trigger(self::EVENT_BEFORE_RENDER, $event);
		return $event->isValid;
	}

	/**
	 * This method is invoked right after [[renderFile()]] renders a view file.
	 * The default implementation will trigger the [[EVENT_AFTER_RENDER]] event.
	 * If you override this method, make sure you call the parent implementation first.
	 * @param string $viewFile the view file to be rendered
	 * @param string $output the rendering result of the view file. Updates to this parameter
	 * will be passed back and returned by [[renderFile()]].
	 */
	public function afterRender($viewFile, &$output)
	{
		if ($this->hasEventHandlers(self::EVENT_AFTER_RENDER)) {
			$event = new ViewEvent($viewFile);
			$event->output = $output;
			$this->trigger(self::EVENT_AFTER_RENDER, $event);
			$output = $event->output;
		}
	}

Qiang Xue committed
303
	/**
Qiang Xue committed
304 305 306 307 308 309
	 * Renders a view file as a PHP script.
	 *
	 * This method treats the view file as a PHP script and includes the file.
	 * It extracts the given parameters and makes them available in the view file.
	 * The method captures the output of the included view file and returns it as a string.
	 *
Qiang Xue committed
310 311
	 * This method should mainly be called by view renderer or [[renderFile()]].
	 *
Qiang Xue committed
312 313 314
	 * @param string $_file_ the view file.
	 * @param array $_params_ the parameters (name-value pairs) that will be extracted and made available in the view file.
	 * @return string the rendering result
Qiang Xue committed
315
	 */
Qiang Xue committed
316
	public function renderPhpFile($_file_, $_params_ = array())
Qiang Xue committed
317
	{
Qiang Xue committed
318 319 320 321 322
		ob_start();
		ob_implicit_flush(false);
		extract($_params_, EXTR_OVERWRITE);
		require($_file_);
		return ob_get_clean();
Qiang Xue committed
323 324
	}

Qiang Xue committed
325 326 327 328 329 330 331 332 333
	/**
	 * Renders dynamic content returned by the given PHP statements.
	 * This method is mainly used together with content caching (fragment caching and page caching)
	 * when some portions of the content (called *dynamic content*) should not be cached.
	 * The dynamic content must be returned by some PHP statements.
	 * @param string $statements the PHP statements for generating the dynamic content.
	 * @return string the placeholder of the dynamic content, or the dynamic content if there is no
	 * active content cache currently.
	 */
Qiang Xue committed
334 335
	public function renderDynamic($statements)
	{
Qiang Xue committed
336 337
		if (!empty($this->cacheStack)) {
			$n = count($this->dynamicPlaceholders);
Qiang Xue committed
338
			$placeholder = "<![CDATA[YII-DYNAMIC-$n]]>";
Qiang Xue committed
339
			$this->addDynamicPlaceholder($placeholder, $statements);
Qiang Xue committed
340 341 342 343 344 345
			return $placeholder;
		} else {
			return $this->evaluateDynamicContent($statements);
		}
	}

Qiang Xue committed
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
	/**
	 * Adds a placeholder for dynamic content.
	 * This method is internally used.
	 * @param string $placeholder the placeholder name
	 * @param string $statements the PHP statements for generating the dynamic content
	 */
	public function addDynamicPlaceholder($placeholder, $statements)
	{
		foreach ($this->cacheStack as $cache) {
			$cache->dynamicPlaceholders[$placeholder] = $statements;
		}
		$this->dynamicPlaceholders[$placeholder] = $statements;
	}

	/**
	 * Evaluates the given PHP statements.
	 * This method is mainly used internally to implement dynamic content feature.
	 * @param string $statements the PHP statements to be evaluated.
	 * @return mixed the return value of the PHP statements.
	 */
Qiang Xue committed
366 367 368 369 370
	public function evaluateDynamicContent($statements)
	{
		return eval($statements);
	}

Qiang Xue committed
371
	/**
Qiang Xue committed
372
	 * Begins recording a block.
373
	 * This method is a shortcut to beginning [[Block]]
Qiang Xue committed
374 375 376
	 * @param string $id the block ID.
	 * @param boolean $renderInPlace whether to render the block content in place.
	 * Defaults to false, meaning the captured block will not be displayed.
377
	 * @return Block the Block widget instance
Qiang Xue committed
378
	 */
Qiang Xue committed
379
	public function beginBlock($id, $renderInPlace = false)
Qiang Xue committed
380
	{
381
		return Block::begin(array(
Qiang Xue committed
382 383
			'id' => $id,
			'renderInPlace' => $renderInPlace,
384
			'view' => $this,
Qiang Xue committed
385 386 387 388
		));
	}

	/**
Qiang Xue committed
389
	 * Ends recording a block.
Qiang Xue committed
390
	 */
Qiang Xue committed
391
	public function endBlock()
Qiang Xue committed
392
	{
393
		Block::end();
Qiang Xue committed
394 395
	}

Qiang Xue committed
396 397
	/**
	 * Begins the rendering of content that is to be decorated by the specified view.
Qiang Xue committed
398
	 * This method can be used to implement nested layout. For example, a layout can be embedded
399
	 * in another layout file specified as '@app/view/layouts/base.php' like the following:
Qiang Xue committed
400 401
	 *
	 * ~~~
402
	 * <?php $this->beginContent('@app/view/layouts/base.php'); ?>
Qiang Xue committed
403 404 405 406 407 408
	 * ...layout content here...
	 * <?php $this->endContent(); ?>
	 * ~~~
	 *
	 * @param string $viewFile 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.
resurtm committed
409
	 * @param array $params the variables (name => value) to be extracted and made available in the decorative view.
410 411
	 * @return ContentDecorator the ContentDecorator widget instance
	 * @see ContentDecorator
Qiang Xue committed
412
	 */
Qiang Xue committed
413
	public function beginContent($viewFile, $params = array())
Qiang Xue committed
414
	{
415
		return ContentDecorator::begin(array(
Qiang Xue committed
416
			'viewFile' => $viewFile,
Qiang Xue committed
417
			'params' => $params,
418
			'view' => $this,
Qiang Xue committed
419 420 421 422 423 424 425 426
		));
	}

	/**
	 * Ends the rendering of content.
	 */
	public function endContent()
	{
427
		ContentDecorator::end();
Qiang Xue committed
428 429
	}

430 431 432 433 434 435 436 437
	/**
	 * Begins fragment caching.
	 * This method will display cached content if it is available.
	 * If not, it will start caching and would expect an [[endCache()]]
	 * call to end the cache and save the content into cache.
	 * A typical usage of fragment caching is as follows,
	 *
	 * ~~~
resurtm committed
438
	 * if ($this->beginCache($id)) {
439 440 441 442 443 444
	 *     // ...generate content here
	 *     $this->endCache();
	 * }
	 * ~~~
	 *
	 * @param string $id a unique ID identifying the fragment to be cached.
445
	 * @param array $properties initial property values for [[FragmentCache]]
446 447 448 449 450 451
	 * @return boolean whether you should generate the content for caching.
	 * False if the cached version is available.
	 */
	public function beginCache($id, $properties = array())
	{
		$properties['id'] = $id;
452
		$properties['view'] = $this;
453
		/** @var $cache FragmentCache */
454
		$cache = FragmentCache::begin($properties);
Qiang Xue committed
455
		if ($cache->getCachedContent() !== false) {
456 457 458 459 460 461 462 463 464 465 466 467
			$this->endCache();
			return false;
		} else {
			return true;
		}
	}

	/**
	 * Ends fragment caching.
	 */
	public function endCache()
	{
468
		FragmentCache::end();
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 496 497 498


	private $_assetManager;

	/**
	 * 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 beginning of an HTML page.
	 */
	public function beginPage()
	{
		ob_start();
		ob_implicit_flush(false);
499 500

		$this->trigger(self::EVENT_BEGIN_PAGE);
501 502 503 504 505 506 507
	}

	/**
	 * Marks the ending of an HTML page.
	 */
	public function endPage()
	{
508 509
		$this->trigger(self::EVENT_END_PAGE);

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 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
		$content = ob_get_clean();
		echo strtr($content, array(
			self::PL_HEAD => $this->renderHeadHtml(),
			self::PL_BODY_BEGIN => $this->renderBodyBeginHtml(),
			self::PL_BODY_END => $this->renderBodyEndHtml(),
		));

		unset(
			$this->assetBundles,
			$this->metaTags,
			$this->linkTags,
			$this->css,
			$this->cssFiles,
			$this->js,
			$this->jsFiles
		);
	}

	/**
	 * Marks the beginning of an HTML body section.
	 */
	public function beginBody()
	{
		echo self::PL_BODY_BEGIN;
	}

	/**
	 * Marks the ending of an HTML body section.
	 */
	public function endBody()
	{
		echo self::PL_BODY_END;
	}

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

	/**
	 * Registers the named asset bundle.
	 * All dependent asset bundles will be registered.
	 * @param string $name the name of the asset bundle.
Qiang Xue committed
556
	 * @throws InvalidConfigException if the asset bundle does not exist or a circular dependency is detected
557 558 559 560 561 562 563 564 565 566 567 568 569 570
	 */
	public function registerAssetBundle($name)
	{
		if (!isset($this->assetBundles[$name])) {
			$am = $this->getAssetManager();
			$bundle = $am->getBundle($name);
			if ($bundle !== null) {
				$this->assetBundles[$name] = false;
				$bundle->registerAssets($this);
				$this->assetBundles[$name] = true;
			} else {
				throw new InvalidConfigException("Unknown asset bundle: $name");
			}
		} elseif ($this->assetBundles[$name] === false) {
Qiang Xue committed
571
			throw new InvalidConfigException("A circular dependency is detected for bundle '$name'.");
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
		}
	}

	/**
	 * 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 = array(), $key = null)
	{
617
		$key = $key ?: md5($css);
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
		$this->css[$key] = Html::style($css, $options);
	}

	/**
	 * Registers a CSS file.
	 * @param string $url the CSS file to be registered.
	 * @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.
	 */
	public function registerCssFile($url, $options = array(), $key = null)
	{
		$key = $key ?: $url;
		$this->cssFiles[$key] = Html::cssFile($url, $options);
	}

	/**
	 * Registers a JS code block.
	 * @param string $js the JS code block to be registered
638 639
	 * @param integer $position the position at which the JS script tag should be inserted
	 * in a page. The possible values are:
640 641 642 643
	 *
	 * - [[POS_HEAD]]: in the head section
	 * - [[POS_BEGIN]]: at the beginning of the body section
	 * - [[POS_END]]: at the end of the body section
644 645
	 * - [[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.
646 647 648 649 650
	 *
	 * @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.
	 */
651
	public function registerJs($js, $position = self::POS_READY, $key = null)
652
	{
653
		$key = $key ?: md5($js);
654 655 656 657
		$this->js[$position][$key] = $js;
		if ($position === self::POS_READY) {
			$this->registerAssetBundle('yii/jquery');
		}
658 659 660 661 662 663 664 665 666 667 668
	}

	/**
	 * Registers a JS file.
	 * @param string $url the JS file to be registered.
	 * @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
669
	 * - [[POS_END]]: at the end of the body section. This is the default value.
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
	 *
	 * @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.
	 */
	public function registerJsFile($url, $options = array(), $key = null)
	{
		$position = isset($options['position']) ? $options['position'] : self::POS_END;
		unset($options['position']);
		$key = $key ?: $url;
		$this->jsFiles[$position][$key] = Html::jsFile($url, $options);
	}

	/**
	 * 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 = array();
		if (!empty($this->metaTags)) {
Qiang Xue committed
692
			$lines[] = implode("\n", $this->metaTags);
693 694
		}
		if (!empty($this->linkTags)) {
Qiang Xue committed
695
			$lines[] = implode("\n", $this->linkTags);
696 697 698 699 700 701 702 703 704 705 706
		}
		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])) {
707
			$lines[] = Html::script(implode("\n", $this->js[self::POS_HEAD]), array('type' => 'text/javascript'));
708
		}
709
		return empty($lines) ? '' : implode("\n", $lines) . "\n";
710 711 712 713 714 715 716 717 718 719 720 721 722 723
	}

	/**
	 * 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 = array();
		if (!empty($this->jsFiles[self::POS_BEGIN])) {
			$lines[] = implode("\n", $this->jsFiles[self::POS_BEGIN]);
		}
		if (!empty($this->js[self::POS_BEGIN])) {
724
			$lines[] = Html::script(implode("\n", $this->js[self::POS_BEGIN]), array('type' => 'text/javascript'));
725
		}
726
		return empty($lines) ? '' : implode("\n", $lines) . "\n";
727 728 729 730 731 732 733 734 735 736 737 738 739 740
	}

	/**
	 * 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.
	 * @return string the rendered content
	 */
	protected function renderBodyEndHtml()
	{
		$lines = array();
		if (!empty($this->jsFiles[self::POS_END])) {
			$lines[] = implode("\n", $this->jsFiles[self::POS_END]);
		}
		if (!empty($this->js[self::POS_END])) {
741 742 743
			$lines[] = Html::script(implode("\n", $this->js[self::POS_END]), array('type' => 'text/javascript'));
		}
		if (!empty($this->js[self::POS_READY])) {
744
			$js = "jQuery(document).ready(function(){\n" . implode("\n", $this->js[self::POS_READY]) . "\n});";
745
			$lines[] = Html::script($js, array('type' => 'text/javascript'));
746
		}
747
		return empty($lines) ? '' : implode("\n", $lines) . "\n";
748
	}
Zander Baldwin committed
749
}