Controller.php 15.3 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 11
use Yii;

Qiang Xue committed
12
/**
Qiang Xue committed
13
 * Controller is the base class for classes containing controller logic.
Qiang Xue committed
14 15 16 17
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
18
class Controller extends Component
Qiang Xue committed
19
{
20 21 22 23 24 25 26 27 28
	/**
	 * @event ActionEvent an event raised right before executing a controller action.
	 * You may set [[ActionEvent::isValid]] to be false to cancel the action execution.
	 */
	const EVENT_BEFORE_ACTION = 'beforeAction';
	/**
	 * @event ActionEvent an event raised right after executing a controller action.
	 */
	const EVENT_AFTER_ACTION = 'afterAction';
Qiang Xue committed
29
	/**
Qiang Xue committed
30
	 * @var string the ID of this controller
Qiang Xue committed
31 32 33 34 35 36
	 */
	public $id;
	/**
	 * @var Module $module the module that this controller belongs to.
	 */
	public $module;
Qiang Xue committed
37
	/**
Qiang Xue committed
38 39
	 * @var string the ID of the action that is used when the action ID is not specified
	 * in the request. Defaults to 'index'.
Qiang Xue committed
40 41
	 */
	public $defaultAction = 'index';
Qiang Xue committed
42
	/**
Qiang Xue committed
43 44 45 46 47 48 49 50 51 52 53
	 * @var string|boolean the name of the layout to be applied to this controller's views.
	 * This property mainly affects the behavior of [[render()]].
	 * Defaults to null, meaning the actual layout value should inherit that from [[module]]'s layout value.
	 * If false, no layout will be applied.
	 */
	public $layout;
	/**
	 * @var Action the action that is currently being executed. This property will be set
	 * by [[run()]] when it is called by [[Application]] to run an action.
	 */
	public $action;
Qiang Xue committed
54 55 56 57 58
	/**
	 * @var View the view object that can be used to render views or view files.
	 */
	private $_view;

Qiang Xue committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75

	/**
	 * @param string $id the ID of this controller
	 * @param Module $module the module that this controller belongs to.
	 * @param array $config name-value pairs that will be used to initialize the object properties
	 */
	public function __construct($id, $module, $config = array())
	{
		$this->id = $id;
		$this->module = $module;
		parent::__construct($config);
	}

	/**
	 * Declares external actions for the controller.
	 * This method is meant to be overwritten to declare external actions for the controller.
	 * It should return an array, with array keys being action IDs, and array values the corresponding
Qiang Xue committed
76 77 78 79
	 * action class names or action configuration arrays. For example,
	 *
	 * ~~~
	 * return array(
Qiang Xue committed
80
	 *     'action1' => '@app/components/Action1',
Qiang Xue committed
81
	 *     'action2' => array(
Qiang Xue committed
82
	 *         'class' => '@app/components/Action2',
Qiang Xue committed
83 84 85 86 87 88
	 *         'property1' => 'value1',
	 *         'property2' => 'value2',
	 *     ),
	 * );
	 * ~~~
	 *
Qiang Xue committed
89
	 * [[\Yii::createObject()]] will be used later to create the requested action
Qiang Xue committed
90
	 * using the configuration provided here.
91
	 */
Qiang Xue committed
92
	public function actions()
Qiang Xue committed
93
	{
Qiang Xue committed
94
		return array();
Qiang Xue committed
95 96 97
	}

	/**
Qiang Xue committed
98
	 * Runs an action within this controller with the specified action ID and parameters.
Qiang Xue committed
99 100
	 * If the action ID is empty, the method will use [[defaultAction]].
	 * @param string $id the ID of the action to be executed.
Qiang Xue committed
101
	 * @param array $params the parameters (name-value pairs) to be passed to the action.
102
	 * @return mixed the result of the action
Qiang Xue committed
103
	 * @throws InvalidRouteException if the requested action ID cannot be resolved into an action successfully.
Qiang Xue committed
104
	 * @see createAction
Qiang Xue committed
105
	 */
Qiang Xue committed
106
	public function runAction($id, $params = array())
Qiang Xue committed
107
	{
Qiang Xue committed
108 109
		$action = $this->createAction($id);
		if ($action !== null) {
Qiang Xue committed
110
			Yii::trace("Route to run: " . $action->getUniqueId(), __METHOD__);
Qiang Xue committed
111 112 113
			if (Yii::$app->requestedAction === null) {
				Yii::$app->requestedAction = $action;
			}
Qiang Xue committed
114 115
			$oldAction = $this->action;
			$this->action = $action;
116
			$result = null;
Qiang Xue committed
117
			$event = new ActionEvent($action);
118
			Yii::$app->trigger(Application::EVENT_BEFORE_ACTION, $event);
Qiang Xue committed
119 120 121
			if ($event->isValid && $this->module->beforeAction($action) && $this->beforeAction($action)) {
				$result = $action->runWithParams($params);
				$this->afterAction($action, $result);
122
				$this->module->afterAction($action, $result);
Qiang Xue committed
123 124 125
				$event = new ActionEvent($action);
				$event->result = &$result;
				Yii::$app->trigger(Application::EVENT_AFTER_ACTION, $event);
Qiang Xue committed
126
			}
Qiang Xue committed
127
			$this->action = $oldAction;
128
			return $result;
Qiang Xue committed
129
		} else {
Qiang Xue committed
130
			throw new InvalidRouteException('Unable to resolve the request: ' . $this->getUniqueId() . '/' . $id);
Qiang Xue committed
131
		}
Qiang Xue committed
132
	}
Qiang Xue committed
133

Qiang Xue committed
134 135 136 137 138 139 140
	/**
	 * Runs a request specified in terms of a route.
	 * The route can be either an ID of an action within this controller or a complete route consisting
	 * of module IDs, controller ID and action ID. If the route starts with a slash '/', the parsing of
	 * the route will start from the application; otherwise, it will start from the parent module of this controller.
	 * @param string $route the route to be handled, e.g., 'view', 'comment/view', '/admin/comment/view'.
	 * @param array $params the parameters to be passed to the action.
Qiang Xue committed
141
	 * @return mixed the result of the action
Qiang Xue committed
142 143 144 145 146 147 148 149 150 151 152
	 * @see runAction
	 * @see forward
	 */
	public function run($route, $params = array())
	{
		$pos = strpos($route, '/');
		if ($pos === false) {
			return $this->runAction($route, $params);
		} elseif ($pos > 0) {
			return $this->module->runAction($route, $params);
		} else {
Qiang Xue committed
153
			return Yii::$app->runAction(ltrim($route, '/'), $params);
Qiang Xue committed
154 155
		}
	}
Qiang Xue committed
156

Qiang Xue committed
157 158 159 160 161 162 163 164 165
	/**
	 * Binds the parameters to the action.
	 * This method is invoked by [[Action]] when it begins to run with the given parameters.
	 * @param Action $action the action to be bound with parameters
	 * @param array $params the parameters to be bound to the action
	 * @return array the valid parameters that the action can run with.
	 */
	public function bindActionParams($action, $params)
	{
166
		return array();
Qiang Xue committed
167 168
	}

Qiang Xue committed
169
	/**
Qiang Xue committed
170 171 172 173 174 175 176 177
	 * Creates an action based on the given action ID.
	 * The method first checks if the action ID has been declared in [[actions()]]. If so,
	 * it will use the configuration declared there to create the action object.
	 * If not, it will look for a controller method whose name is in the format of `actionXyz`
	 * where `Xyz` stands for the action ID. If found, an [[InlineAction]] representing that
	 * method will be created and returned.
	 * @param string $id the action ID
	 * @return Action the newly created action instance. Null if the ID doesn't resolve into any action.
Qiang Xue committed
178
	 */
Qiang Xue committed
179
	public function createAction($id)
Qiang Xue committed
180
	{
Qiang Xue committed
181 182 183 184
		if ($id === '') {
			$id = $this->defaultAction;
		}

Qiang Xue committed
185 186 187 188
		$actionMap = $this->actions();
		if (isset($actionMap[$id])) {
			return Yii::createObject($actionMap[$id], $id, $this);
		} elseif (preg_match('/^[a-z0-9\\-_]+$/', $id)) {
189
			$methodName = 'action' . str_replace(' ', '', ucwords(implode(' ', explode('-', $id))));
Qiang Xue committed
190 191 192
			if (method_exists($this, $methodName)) {
				$method = new \ReflectionMethod($this, $methodName);
				if ($method->getName() === $methodName) {
Qiang Xue committed
193
					return new InlineAction($id, $this, $methodName);
Qiang Xue committed
194 195
				}
			}
Qiang Xue committed
196
		}
Qiang Xue committed
197 198 199 200 201 202 203 204 205 206 207
		return null;
	}

	/**
	 * This method is invoked right before an action is to be executed (after all possible filters.)
	 * You may override this method to do last-minute preparation for the action.
	 * @param Action $action the action to be executed.
	 * @return boolean whether the action should continue to be executed.
	 */
	public function beforeAction($action)
	{
208 209 210
		$event = new ActionEvent($action);
		$this->trigger(self::EVENT_BEFORE_ACTION, $event);
		return $event->isValid;
Qiang Xue committed
211 212 213 214 215 216
	}

	/**
	 * This method is invoked right after an action is executed.
	 * You may override this method to do some postprocessing for the action.
	 * @param Action $action the action just executed.
217
	 * @param mixed $result the action return result.
Qiang Xue committed
218
	 */
219
	public function afterAction($action, &$result)
Qiang Xue committed
220
	{
221 222 223
		$event = new ActionEvent($action);
		$event->result = & $result;
		$this->trigger(self::EVENT_AFTER_ACTION, $event);
Qiang Xue committed
224 225 226 227 228 229 230 231 232 233 234 235
	}

	/**
	 * Returns the request parameters that will be used for action parameter binding.
	 * Default implementation simply returns an empty array.
	 * Child classes may override this method to customize the parameters to be provided
	 * for action parameter binding (e.g. `$_GET`).
	 * @return array the request parameters (name-value pairs) to be used for action parameter binding
	 */
	public function getActionParams()
	{
		return array();
Qiang Xue committed
236 237 238 239 240 241 242
	}

	/**
	 * @return string the controller ID that is prefixed with the module ID (if any).
	 */
	public function getUniqueId()
	{
Qiang Xue committed
243
		return $this->module instanceof Application ? $this->id : $this->module->getUniqueId() . '/' . $this->id;
Qiang Xue committed
244 245 246
	}

	/**
Qiang Xue committed
247
	 * Returns the route of the current request.
Qiang Xue committed
248 249 250 251
	 * @return string the route (module ID, controller ID and action ID) of the current request.
	 */
	public function getRoute()
	{
Qiang Xue committed
252
		return $this->action !== null ? $this->action->getUniqueId() : $this->getUniqueId();
Qiang Xue committed
253 254
	}

Qiang Xue committed
255 256
	/**
	 * Renders a view and applies layout if available.
Qiang Xue committed
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
	 *
	 * The view to be rendered can be specified in one of the following formats:
	 *
	 * - path alias (e.g. "@app/views/site/index");
	 * - absolute path within application (e.g. "//site/index"): the view name starts with double slashes.
	 *   The actual view file will be looked for under the [[Application::viewPath|view path]] of the application.
	 * - absolute path within module (e.g. "/site/index"): the view name starts with a single slash.
	 *   The actual view file will be looked for under the [[Module::viewPath|view path]] of [[module]].
	 * - relative path (e.g. "index"): the actual view file will be looked for under [[viewPath]].
	 *
	 * To determine which layout should be applied, the following two steps are conducted:
	 *
	 * 1. In the first step, it determines the layout name and the context module:
	 *
	 * - If [[layout]] is specified as a string, use it as the layout name and [[module]] as the context module;
	 * - If [[layout]] is null, search through all ancestor modules of this controller and find the first
	 *   module whose [[Module::layout|layout]] is not null. The layout and the corresponding module
	 *   are used as the layout name and the context module, respectively. If such a module is not found
	 *   or the corresponding layout is not a string, it will return false, meaning no applicable layout.
	 *
	 * 2. In the second step, it determines the actual layout file according to the previously found layout name
	 *    and context module. The layout name can be
	 *
	 * - a path alias (e.g. "@app/views/layouts/main");
	 * - an absolute path (e.g. "/main"): the layout name starts with a slash. The actual layout file will be
	 *   looked for under the [[Application::layoutPath|layout path]] of the application;
	 * - a relative path (e.g. "main"): the actual layout layout file will be looked for under the
Qiang Xue committed
284
	 *   [[Module::layoutPath|layout path]] of the context module.
Qiang Xue committed
285 286 287
	 *
	 * If the layout name does not contain a file extension, it will use the default one `.php`.
	 *
Qiang Xue committed
288 289 290 291 292
	 * @param string $view the view name. Please refer to [[findViewFile()]] on how to specify a view name.
	 * @param array $params the parameters (name-value pairs) that should be made available in the view.
	 * These parameters will not be available in the layout.
	 * @return string the rendering result.
	 * @throws InvalidParamException if the view file or the layout file does not exist.
Qiang Xue committed
293
	 */
Qiang Xue committed
294 295
	public function render($view, $params = array())
	{
Qiang Xue committed
296 297
		$viewFile = $this->findViewFile($view);
		$output = $this->getView()->renderFile($viewFile, $params, $this);
Qiang Xue committed
298
		$layoutFile = $this->findLayoutFile();
Qiang Xue committed
299
		if ($layoutFile !== false) {
Qiang Xue committed
300
			return $this->getView()->renderFile($layoutFile, array('content' => $output), $this);
Qiang Xue committed
301 302 303
		} else {
			return $output;
		}
Qiang Xue committed
304 305
	}

Qiang Xue committed
306 307 308
	/**
	 * Renders a view.
	 * This method differs from [[render()]] in that it does not apply any layout.
Qiang Xue committed
309
	 * @param string $view the view name. Please refer to [[render()]] on how to specify a view name.
Qiang Xue committed
310 311 312 313
	 * @param array $params the parameters (name-value pairs) that should be made available in the view.
	 * @return string the rendering result.
	 * @throws InvalidParamException if the view file does not exist.
	 */
Qiang Xue committed
314 315
	public function renderPartial($view, $params = array())
	{
Qiang Xue committed
316 317
		$viewFile = $this->findViewFile($view);
		return $this->getView()->renderFile($viewFile, $params, $this);
Qiang Xue committed
318 319
	}

Qiang Xue committed
320 321 322 323 324 325 326
	/**
	 * Renders a view file.
	 * @param string $file the view file to be rendered. This can be either a file path or a path alias.
	 * @param array $params the parameters (name-value pairs) that should be made available in the view.
	 * @return string the rendering result.
	 * @throws InvalidParamException if the view file does not exist.
	 */
Qiang Xue committed
327 328
	public function renderFile($file, $params = array())
	{
Qiang Xue committed
329 330 331 332 333 334 335
		return $this->getView()->renderFile($file, $params, $this);
	}

	/**
	 * Returns the view object that can be used to render views or view files.
	 * The [[render()]], [[renderPartial()]] and [[renderFile()]] methods will use
	 * this view object to implement the actual view rendering.
336
	 * If not set, it will default to the "view" application component.
Qiang Xue committed
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
	 * @return View the view object that can be used to render views or view files.
	 */
	public function getView()
	{
		if ($this->_view === null) {
			$this->_view = Yii::$app->getView();
		}
		return $this->_view;
	}

	/**
	 * Sets the view object to be used by this controller.
	 * @param View $view the view object that can be used to render views or view files.
	 */
	public function setView($view)
	{
		$this->_view = $view;
Qiang Xue committed
354
	}
Qiang Xue committed
355 356 357 358 359 360 361 362 363 364 365

	/**
	 * Returns the directory containing view files for this controller.
	 * The default implementation returns the directory named as controller [[id]] under the [[module]]'s
	 * [[viewPath]] directory.
	 * @return string the directory containing the view files for this controller.
	 */
	public function getViewPath()
	{
		return $this->module->getViewPath() . DIRECTORY_SEPARATOR . $this->id;
	}
Qiang Xue committed
366

Qiang Xue committed
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
	/**
	 * Finds the view file based on the given view name.
	 * @param string $view the view name or the path alias of the view file. Please refer to [[render()]]
	 * on how to specify this parameter.
	 * @return string the view file path. Note that the file may not exist.
	 */
	protected function findViewFile($view)
	{
		if (strncmp($view, '@', 1) === 0) {
			// e.g. "@app/views/main"
			$file = Yii::getAlias($view);
		} elseif (strncmp($view, '//', 2) === 0) {
			// e.g. "//layouts/main"
			$file = Yii::$app->getViewPath() . DIRECTORY_SEPARATOR . ltrim($view, '/');
		} elseif (strncmp($view, '/', 1) === 0) {
			// e.g. "/site/index"
			$file = $this->module->getViewPath() . DIRECTORY_SEPARATOR . ltrim($view, '/');
		} else {
			$file = $this->getViewPath() . DIRECTORY_SEPARATOR . $view;
		}

Qiang Xue committed
388
		return pathinfo($file, PATHINFO_EXTENSION) === '' ? $file . '.php' : $file;
Qiang Xue committed
389 390
	}

Qiang Xue committed
391 392 393
	/**
	 * Finds the applicable layout file.
	 * @return string|boolean the layout file path, or false if layout is not needed.
Qiang Xue committed
394
	 * Please refer to [[render()]] on how to specify this parameter.
Qiang Xue committed
395 396 397 398
	 * @throws InvalidParamException if an invalid path alias is used to specify the layout
	 */
	protected function findLayoutFile()
	{
Qiang Xue committed
399
		$module = $this->module;
Qiang Xue committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
		if (is_string($this->layout)) {
			$view = $this->layout;
		} elseif ($this->layout === null) {
			while ($module !== null && $module->layout === null) {
				$module = $module->module;
			}
			if ($module !== null && is_string($module->layout)) {
				$view = $module->layout;
			}
		}

		if (!isset($view)) {
			return false;
		}

		if (strncmp($view, '@', 1) === 0) {
			$file = Yii::getAlias($view);
		} elseif (strncmp($view, '/', 1) === 0) {
			$file = Yii::$app->getLayoutPath() . DIRECTORY_SEPARATOR . $view;
		} else {
			$file = $module->getLayoutPath() . DIRECTORY_SEPARATOR . $view;
		}

Qiang Xue committed
423
		if (pathinfo($file, PATHINFO_EXTENSION) === '') {
Qiang Xue committed
424 425 426 427
			$file .= '.php';
		}
		return $file;
	}
Qiang Xue committed
428
}