Application.php 4.37 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
use yii\base\InvalidRouteException;
Qiang Xue committed
12 13

/**
14
 * Application is the base class for all web application classes.
Qiang Xue committed
15
 *
16
 * @property AssetManager $assetManager The asset manager component. This property is read-only.
17
 * @property string $homeUrl The homepage URL.
18 19 20 21
 * @property Request $request The request component. This property is read-only.
 * @property Response $response The response component. This property is read-only.
 * @property Session $session The session component. This property is read-only.
 * @property User $user The user component. This property is read-only.
22
 *
Qiang Xue committed
23 24 25 26 27
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class Application extends \yii\base\Application
{
Qiang Xue committed
28 29 30 31
	/**
	 * @var string the default route of this application. Defaults to 'site'.
	 */
	public $defaultRoute = 'site';
32 33 34 35 36 37 38 39 40
	/**
	 * @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,
	 *
	 * ~~~
Alexander Makarov committed
41
	 * [
42 43 44
	 *     'offline/notice',
	 *     'param1' => 'value1',
	 *     'param2' => 'value2',
Alexander Makarov committed
45
	 * ]
46 47
	 * ~~~
	 *
48
	 * Defaults to null, meaning catch-all is not used.
49 50
	 */
	public $catchAll;
51 52 53 54
	/**
	 * @var Controller the currently active controller instance
	 */
	public $controller;
55

Qiang Xue committed
56

Qiang Xue committed
57
	/**
58 59 60 61
	 * Handles the specified request.
	 * @param Request $request the request to be handled
	 * @return Response the resulting response
	 * @throws HttpException if the requested route is invalid
Qiang Xue committed
62
	 */
63
	public function handleRequest($request)
Qiang Xue committed
64
	{
65 66
		Yii::setAlias('@webroot', dirname($request->getScriptFile()));
		Yii::setAlias('@web', $request->getBaseUrl());
67

68 69 70 71 72 73
		if (empty($this->catchAll)) {
			list ($route, $params) = $request->resolve();
		} else {
			$route = $this->catchAll[0];
			$params = array_splice($this->catchAll, 1);
		}
74
		try {
Qiang Xue committed
75
			Yii::trace("Route requested: '$route'", __METHOD__);
Qiang Xue committed
76
			$this->requestedRoute = $route;
77 78 79 80 81 82
			$result = $this->runAction($route, $params);
			if ($result instanceof Response) {
				return $result;
			} else {
				$response = $this->getResponse();
				if ($result !== null) {
83
					$response->data = $result;
84 85 86
				}
				return $response;
			}
87 88 89
		} catch (InvalidRouteException $e) {
			throw new HttpException(404, $e->getMessage(), $e->getCode(), $e);
		}
Qiang Xue committed
90
	}
Qiang Xue committed
91

Qiang Xue committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
	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
118 119 120 121 122 123 124 125 126
	/**
	 * Returns the request component.
	 * @return Request the request component
	 */
	public function getRequest()
	{
		return $this->getComponent('request');
	}

127 128 129 130 131 132 133 134 135
	/**
	 * Returns the response component.
	 * @return Response the response component
	 */
	public function getResponse()
	{
		return $this->getComponent('response');
	}

Qiang Xue committed
136 137 138 139 140 141 142 143 144
	/**
	 * Returns the session component.
	 * @return Session the session component
	 */
	public function getSession()
	{
		return $this->getComponent('session');
	}

145 146 147 148 149 150 151 152 153
	/**
	 * Returns the user component.
	 * @return User the user component
	 */
	public function getUser()
	{
		return $this->getComponent('user');
	}

Qiang Xue committed
154 155 156 157
	/**
	 * Returns the asset manager.
	 * @return AssetManager the asset manager component
	 */
158
	public function getAssetManager()
Qiang Xue committed
159
	{
160
		return $this->getComponent('assetManager');
Qiang Xue committed
161 162
	}

Qiang Xue committed
163 164 165 166 167 168 169
	/**
	 * Registers the core application components.
	 * @see setComponents
	 */
	public function registerCoreComponents()
	{
		parent::registerCoreComponents();
Alexander Makarov committed
170 171 172 173 174 175 176
		$this->setComponents([
			'request' => ['class' => 'yii\web\Request'],
			'response' => ['class' => 'yii\web\Response'],
			'session' => ['class' => 'yii\web\Session'],
			'user' => ['class' => 'yii\web\User'],
			'assetManager' => ['class' => 'yii\web\AssetManager'],
		]);
Qiang Xue committed
177
	}
Qiang Xue committed
178
}