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.

156 lines
4.9 KiB

13 years ago
<?php
/**
* Console Application class file.
*
* @link http://www.yiiframework.com/
* @copyright Copyright &copy; 2008 Yii Software LLC
13 years ago
* @license http://www.yiiframework.com/license/
*/
namespace yii\console;
use yii\base\Exception;
13 years ago
use yii\util\ReflectionHelper;
13 years ago
/**
* Application represents a console application.
13 years ago
*
* Application extends from [[yii\base\Application]] by providing functionalities that are
13 years ago
* specific to console requests. In particular, it deals with console requests
* through a command-based approach:
*
* - A console application consists of one or several possible user commands;
13 years ago
* - Each user command is implemented as a class extending [[\yii\console\Controller]];
* - User specifies which command to run on the command line;
* - The command processes the user request with the specified parameters.
*
13 years ago
* The command classes reside in the directory specified by [[controllerPath]].
* Their naming should follow the same naming convention as controllers. For example, the `help` command
13 years ago
* is implemented using the `HelpController` class.
13 years ago
*
* To run the console application, enter the following on the command line:
*
* ~~~
* yiic <route> [--param1=value1 --param2 ...]
* ~~~
*
13 years ago
* where `<route>` 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).
13 years ago
*
* A `help` command is provided by default, which lists available commands and shows their usage.
13 years ago
* To use this command, simply type:
*
* ~~~
13 years ago
* yiic help
* ~~~
13 years ago
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
class Application extends \yii\base\Application
{
/**
* @var string the default route of this application. Defaults to 'help',
* meaning the `help` command.
13 years ago
*/
public $defaultRoute = 'help';
13 years ago
/**
* @var boolean whether to enable the commands provided by the core framework.
* Defaults to true.
13 years ago
*/
public $enableCoreCommands = true;
13 years ago
/**
* Initialize the application.
*/
13 years ago
public function init()
{
parent::init();
if ($this->enableCoreCommands) {
foreach ($this->coreCommands() as $id => $command) {
12 years ago
if (!isset($this->controllerMap[$id])) {
$this->controllerMap[$id] = $command;
}
}
}
// ensure we have the 'help' command so that we can list the available commands
12 years ago
if (!isset($this->controllerMap['help'])) {
$this->controllerMap['help'] = 'yii\console\controllers\HelpController';
13 years ago
}
}
/**
13 years ago
* 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
13 years ago
*/
13 years ago
public function processRequest()
13 years ago
{
/** @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.');
}
13 years ago
}
/**
* 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 */
13 years ago
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;
13 years ago
}
/**
* Returns the configuration of the built-in commands.
* @return array the configuration of the built-in commands.
*/
public function coreCommands()
13 years ago
{
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',
);
13 years ago
}
/**
* 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',
),
));
}
13 years ago
}