[--param1=value1 --param2 ...] * ~~~ * * where `` refers to a controller route in the form of `ModuleID/ControllerID/ActionID` * (e.g. `sitemap/create`), and `param1`, `param2` refers to a set of named parameters that * will be used to initialize the controller action (e.g. `--since=0` specifies a `since` parameter * whose value is 0 and a corresponding `$since` parameter is passed to the action method). * * A `help` command is provided by default, which lists available commands and shows their usage. * To use this command, simply type: * * ~~~ * yiic help * ~~~ * * @author Qiang Xue * @since 2.0 */ class Application extends \yii\base\Application { /** * @var string the default route of this application. Defaults to 'help', * meaning the `help` command. */ public $defaultRoute = 'help'; /** * @var boolean whether to enable the commands provided by the core framework. * Defaults to true. */ public $enableCoreCommands = true; /** * Initialize the application. */ public function init() { parent::init(); if ($this->enableCoreCommands) { foreach ($this->coreCommands() as $id => $command) { if (!isset($this->controllerMap[$id])) { $this->controllerMap[$id] = $command; } } } // ensure we have the 'help' command so that we can list the available commands if (!isset($this->controllerMap['help'])) { $this->controllerMap['help'] = 'yii\console\controllers\HelpController'; } } /** * Processes the request. * The request is represented in terms of a controller route and action parameters. * @return integer the exit status of the controller action (0 means normal, non-zero values mean abnormal) * @throws Exception if the route cannot be resolved into a controller */ public function processRequest() { /** @var $request Request */ $request = $this->getRequest(); if ($request->getIsConsoleRequest()) { return $this->runController($request->route, $request->params); } else { die('This script must be run from the command line.'); } } /** * Runs a controller with the given route and parameters. * @param string $route the route (e.g. `post/create`) * @param array $params the parameters to be passed to the controller action * @return integer the exit status (0 means normal, non-zero values mean abnormal) * @throws Exception if the route cannot be resolved into a controller */ public function runController($route, $params = array()) { $result = $this->createController($route); if ($result === false) { throw new Exception(\Yii::t('yii', 'Unable to resolve the request.')); } /** @var $controller \yii\console\Controller */ list($controller, $action) = $result; $priorController = $this->controller; $this->controller = $controller; $params = ReflectionHelper::initObjectWithParams($controller, $params); $status = $controller->run($action, $params); $this->controller = $priorController; return $status; } /** * Returns the configuration of the built-in commands. * @return array the configuration of the built-in commands. */ public function coreCommands() { return array( 'message' => 'yii\console\controllers\MessageController', 'help' => 'yii\console\controllers\HelpController', 'migrate' => 'yii\console\controllers\MigrateController', 'shell' => 'yii\console\controllers\ShellController', 'create' => 'yii\console\controllers\CreateController', ); } /** * Registers the core application components. * @see setComponents */ public function registerCoreComponents() { parent::registerCoreComponents(); $this->setComponents(array( 'request' => array( 'class' => 'yii\console\Request', ), 'response' => array( 'class' => 'yii\console\Response', ), )); } }