Application.php 3.68 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
 * @license http://www.yiiframework.com/license/
 */

namespace yii\web;
Qiang Xue committed
9

Qiang Xue committed
10
use Yii;
11 12
use yii\base\HttpException;
use yii\base\InvalidRouteException;
Qiang Xue committed
13 14 15 16 17 18 19 20 21

/**
 * Application is the base class for all application classes.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class Application extends \yii\base\Application
{
Qiang Xue committed
22 23 24 25
	/**
	 * @var string the default route of this application. Defaults to 'site'.
	 */
	public $defaultRoute = 'site';
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
	/**
	 * @var array the configuration specifying a controller action which should handle
	 * all user requests. This is mainly used when the application is in maintenance mode
	 * and needs to handle all incoming requests via a single action.
	 * The configuration is an array whose first element specifies the route of the action.
	 * The rest of the array elements (key-value pairs) specify the parameters to be bound
	 * to the action. For example,
	 *
	 * ~~~
	 * array(
	 *     'offline/notice',
	 *     'param1' => 'value1',
	 *     'param2' => 'value2',
	 * )
	 * ~~~
	 *
	 * Defaults to null, meaning catch-all is not effective.
	 */
	public $catchAll;

Qiang Xue committed
46

Qiang Xue committed
47 48 49
	/**
	 * Processes the request.
	 * @return integer the exit status of the controller action (0 means normal, non-zero values mean abnormal)
50
	 * @throws HttpException if the request cannot be resolved.
Qiang Xue committed
51 52 53
	 */
	public function processRequest()
	{
Qiang Xue committed
54 55 56
		$request = $this->getRequest();
		Yii::setAlias('@wwwroot', dirname($request->getScriptFile()));
		Yii::setAlias('@www', $request->getBaseUrl());
57 58 59 60 61 62
		if (empty($this->catchAll)) {
			list ($route, $params) = $request->resolve();
		} else {
			$route = $this->catchAll[0];
			$params = array_splice($this->catchAll, 1);
		}
63 64 65 66 67
		try {
			return $this->runAction($route, $params);
		} catch (InvalidRouteException $e) {
			throw new HttpException(404, $e->getMessage(), $e->getCode(), $e);
		}
Qiang Xue committed
68
	}
Qiang Xue committed
69

Qiang Xue committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
	private $_homeUrl;

	/**
	 * @return string the homepage URL
	 */
	public function getHomeUrl()
	{
		if ($this->_homeUrl === null) {
			if ($this->getUrlManager()->showScriptName) {
				return $this->getRequest()->getScriptUrl();
			} else {
				return $this->getRequest()->getBaseUrl() . '/';
			}
		} else {
			return $this->_homeUrl;
		}
	}

	/**
	 * @param string $value the homepage URL
	 */
	public function setHomeUrl($value)
	{
		$this->_homeUrl = $value;
	}

Qiang Xue committed
96 97 98 99 100 101 102 103 104
	/**
	 * Returns the request component.
	 * @return Request the request component
	 */
	public function getRequest()
	{
		return $this->getComponent('request');
	}

Qiang Xue committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
	/**
	 * Returns the response component.
	 * @return Response the response component
	 */
	public function getResponse()
	{
		return $this->getComponent('response');
	}

	/**
	 * Returns the session component.
	 * @return Session the session component
	 */
	public function getSession()
	{
		return $this->getComponent('session');
	}

123 124 125 126 127 128 129 130 131
	/**
	 * Returns the user component.
	 * @return User the user component
	 */
	public function getUser()
	{
		return $this->getComponent('user');
	}

Qiang Xue committed
132 133 134 135
	/**
	 * Returns the asset manager.
	 * @return AssetManager the asset manager component
	 */
136
	public function getAssetManager()
Qiang Xue committed
137
	{
138
		return $this->getComponent('assetManager');
Qiang Xue committed
139 140
	}

Qiang Xue committed
141 142 143 144 145 146 147 148 149 150 151 152 153 154
	/**
	 * Registers the core application components.
	 * @see setComponents
	 */
	public function registerCoreComponents()
	{
		parent::registerCoreComponents();
		$this->setComponents(array(
			'request' => array(
				'class' => 'yii\web\Request',
			),
			'response' => array(
				'class' => 'yii\web\Response',
			),
Qiang Xue committed
155 156 157
			'session' => array(
				'class' => 'yii\web\Session',
			),
158 159 160
			'user' => array(
				'class' => 'yii\web\User',
			),
161
			'assetManager' => array(
Qiang Xue committed
162 163
				'class' => 'yii\web\AssetManager',
			),
Qiang Xue committed
164 165
		));
	}
Qiang Xue committed
166
}