You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

301 lines
9.1 KiB

13 years ago
<?php
/**
* Controller class file.
*
* @link http://www.yiiframework.com/
* @copyright Copyright &copy; 2008-2012 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\base;
/**
13 years ago
* Controller is the base class for classes containing controller logic.
13 years ago
*
13 years ago
* Controller implements the action life cycles, which consist of the following steps:
13 years ago
*
13 years ago
* 1. [[authorize]]
* 2. [[beforeAction]]
* 3. [[beforeRender]]
* 4. [[afterRender]]
* 5. [[afterAction]]
13 years ago
*
13 years ago
* @property array $actionParams the request parameters (name-value pairs) to be used for action parameter binding
* @property string $route the route (module ID, controller ID and action ID) of the current request.
* @property string $uniqueId the controller ID that is prefixed with the module ID (if any).
13 years ago
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
abstract class Controller extends Component implements Initable
{
/**
13 years ago
* @var string ID of this controller
*/
public $id;
/**
* @var Module $module the module that this controller belongs to.
*/
public $module;
/**
13 years ago
* @var string the name of the default action. Defaults to 'index'.
*/
public $defaultAction = 'index';
/**
* @var Action the action that is currently being executed
*/
public $action;
13 years ago
/**
13 years ago
* @param string $id ID of this controller
* @param Module $module the module that this controller belongs to.
13 years ago
*/
13 years ago
public function __construct($id, $module)
13 years ago
{
13 years ago
$this->id = $id;
$this->module = $module;
13 years ago
}
/**
* Initializes the controller.
13 years ago
* This method is called by the application before the controller starts to execute an action.
13 years ago
* You may override this method to perform the needed initialization for the controller.
*/
public function init()
{
}
/**
* Returns a list of external action classes.
* Array keys are action IDs, and array values are the corresponding
13 years ago
* action class names or action configuration arrays. For example,
*
* ~~~
13 years ago
* return array(
13 years ago
* 'action1'=>'@application/components/Action1',
* 'action2'=>array(
* 'class'=>'@application/components/Action2',
* 'property1'=>'value1',
* 'property2'=>'value2',
* ),
13 years ago
* );
13 years ago
* ~~~
13 years ago
*
13 years ago
* [[\Yii::createObject()]] will be invoked to create the requested action
* using the configuration provided here.
13 years ago
*
13 years ago
* Derived classes may override this method to declare external actions.
13 years ago
*
13 years ago
* Note, in order to inherit actions defined in the parent class, a child class needs to
* merge the parent actions with child actions using functions like `array_merge()`.
13 years ago
*
* @return array list of external action classes
* @see createAction
*/
public function actions()
{
return array();
}
/**
13 years ago
* Creates an action with the specified ID and runs it.
* If the action does not exist, [[missingAction()]] will be invoked.
13 years ago
* @param string $actionID action ID
13 years ago
* @return integer the exit status of the action. 0 means normal, other values mean abnormal.
13 years ago
* @see createAction
* @see runAction
13 years ago
* @see missingAction
13 years ago
*/
public function run($actionID)
{
if (($action = $this->createAction($actionID)) !== null) {
13 years ago
return $this->runAction($action);
} else {
13 years ago
$this->missingAction($actionID);
13 years ago
return 1;
13 years ago
}
}
/**
13 years ago
* Runs the action.
* @param Action $action action to run
13 years ago
* @return integer the exit status of the action. 0 means normal, other values mean abnormal.
13 years ago
*/
public function runAction($action)
{
$priorAction = $this->action;
$this->action = $action;
13 years ago
$exitStatus = 1;
if ($this->authorize($action)) {
$params = $action->normalizeParams($this->getActionParams());
if ($params !== false) {
if ($this->beforeAction($action)) {
$exitStatus = (int)call_user_func_array(array($action, 'run'), $params);
$this->afterAction($action);
}
13 years ago
} else {
$this->invalidActionParams($action);
13 years ago
}
}
$this->action = $priorAction;
13 years ago
return $exitStatus;
13 years ago
}
/**
* 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
13 years ago
*/
public function getActionParams()
{
return array();
13 years ago
}
/**
13 years ago
* Creates the action instance based on the action ID.
13 years ago
* The action can be either an inline action or an object.
13 years ago
* The latter is created by looking up the action map specified in [[actions]].
* @param string $actionID ID of the action. If empty, it will take the value of [[defaultAction]].
* @return Action the action instance, null if the action does not exist.
13 years ago
* @see actions
*/
public function createAction($actionID)
{
if ($actionID === '') {
$actionID = $this->defaultAction;
}
13 years ago
if (method_exists($this, 'action' . $actionID) && strcasecmp($actionID, 's')) {
return new InlineAction($actionID, $this);
} else {
$actions = $this->actions();
if (isset($actions[$actionID])) {
return \Yii::createObject($actions[$actionID], $actionID, $this);
13 years ago
}
}
13 years ago
return null;
13 years ago
}
/**
13 years ago
* This method is invoked when the request parameters do not satisfy the requirement of the specified action.
* The default implementation will throw an exception.
* @param Action $action the action being executed
* @throws Exception whenever this method is invoked
13 years ago
*/
13 years ago
public function invalidActionParams($action)
13 years ago
{
13 years ago
throw new Exception(\Yii::t('yii', 'Your request is invalid.'));
13 years ago
}
/**
* Handles the request whose action is not recognized.
* This method is invoked when the controller cannot find the requested action.
* The default implementation simply throws an exception.
* @param string $actionID the missing action name
13 years ago
* @throws Exception whenever this method is invoked
13 years ago
*/
public function missingAction($actionID)
{
13 years ago
throw new Exception(\Yii::t('yii', 'The system is unable to find the requested action "{action}".',
13 years ago
array('{action}' => $actionID == '' ? $this->defaultAction : $actionID)));
}
/**
* @return string the controller ID that is prefixed with the module ID (if any).
*/
public function getUniqueId()
{
13 years ago
return $this->module instanceof Application ? $this->id : $this->module->getUniqueId() . '/' . $this->id;
13 years ago
}
/**
13 years ago
* Returns the route of the current request.
13 years ago
* @return string the route (module ID, controller ID and action ID) of the current request.
*/
public function getRoute()
{
13 years ago
return $this->action !== null ? $this->getUniqueId() . '/' . $this->action->id : $this->getUniqueId();
13 years ago
}
/**
* Processes the request using another controller action.
* @param string $route the route of the new controller action. This can be an action ID, or a complete route
13 years ago
* with module ID (optional in the current module), controller ID and action ID. If the former,
* the action is assumed to be located within the current controller.
13 years ago
* @param boolean $exit whether to end the application after this call. Defaults to true.
*/
public function forward($route, $exit = true)
{
if (strpos($route, '/') === false) {
13 years ago
$status = $this->run($route);
} else {
if ($route[0] !== '/' && !$this->module instanceof Application) {
$route = '/' . $this->module->getUniqueId() . '/' . $route;
13 years ago
}
13 years ago
$status = \Yii::$application->runController($route);
13 years ago
}
if ($exit) {
13 years ago
\Yii::$application->end($status);
13 years ago
}
}
/**
* This method is invoked when checking the access for the action to be executed.
* @param Action $action the action to be executed.
* @return boolean whether the action is allowed to be executed.
*/
public function authorize(Action $action)
{
$event = new ActionEvent($action);
$this->trigger(__METHOD__, $event);
return $event->isValid;
}
/**
13 years ago
* 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.
13 years ago
*/
public function beforeAction(Action $action)
13 years ago
{
$event = new ActionEvent($action);
$this->trigger(__METHOD__, $event);
return $event->isValid;
13 years ago
}
/**
* 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.
13 years ago
*/
public function afterAction(Action $action)
{
$event = new ActionEvent($action);
$this->trigger(__METHOD__, $event);
}
/**
* This method is invoked right before an action renders its result using [[render()]].
* @param Action $action the action to be executed.
* @return boolean whether the action should continue to render.
*/
public function beforeRender(Action $action)
{
$event = new ActionEvent($action);
$this->trigger(__METHOD__, $event);
return $event->isValid;
}
/**
* This method is invoked right after an action renders its result using [[render()]].
* @param Action $action the action just executed.
*/
public function afterRender(Action $action)
13 years ago
{
$event = new ActionEvent($action);
$this->trigger(__METHOD__, $event);
13 years ago
}
}