3
* @link https://www.yiiframework.com/
4
* @copyright Copyright (c) 2008 Yii Software LLC
5
* @license https://www.yiiframework.com/license/
11
use yii\base\InvalidRouteException;
13
// define STDIN, STDOUT and STDERR if the PHP SAPI did not define them (e.g. creating console application in web env)
14
// https://www.php.net/manual/en/features.commandline.io-streams.php
15
defined('STDIN') or define('STDIN', fopen('php://stdin', 'r'));
16
defined('STDOUT') or define('STDOUT', fopen('php://stdout', 'w'));
17
defined('STDERR') or define('STDERR', fopen('php://stderr', 'w'));
20
* Application represents a console application.
22
* Application extends from [[\yii\base\Application]] by providing functionalities that are
23
* specific to console requests. In particular, it deals with console requests
24
* through a command-based approach:
26
* - A console application consists of one or several possible user commands;
27
* - Each user command is implemented as a class extending [[\yii\console\Controller]];
28
* - User specifies which command to run on the command line;
29
* - The command processes the user request with the specified parameters.
31
* The command classes should be under the namespace specified by [[controllerNamespace]].
32
* Their naming should follow the same naming convention as controllers. For example, the `help` command
33
* is implemented using the `HelpController` class.
35
* To run the console application, enter the following on the command line:
38
* yii <route> [--param1=value1 --param2 ...]
41
* where `<route>` refers to a controller route in the form of `ModuleID/ControllerID/ActionID`
42
* (e.g. `sitemap/create`), and `param1`, `param2` refers to a set of named parameters that
43
* will be used to initialize the controller action (e.g. `--since=0` specifies a `since` parameter
44
* whose value is 0 and a corresponding `$since` parameter is passed to the action method).
46
* A `help` command is provided by default, which lists available commands and shows their usage.
47
* To use this command, simply type:
53
* @property-read ErrorHandler $errorHandler The error handler application component.
54
* @property-read Request $request The request component.
55
* @property-read Response $response The response component.
57
* @author Qiang Xue <qiang.xue@gmail.com>
60
class Application extends \yii\base\Application
63
* The option name for specifying the application configuration file path.
65
const OPTION_APPCONFIG = 'appconfig';
68
* @var string the default route of this application. Defaults to 'help',
69
* meaning the `help` command.
71
public $defaultRoute = 'help';
73
* @var bool whether to enable the commands provided by the core framework.
76
public $enableCoreCommands = true;
78
* @var Controller the currently active controller instance
86
public function __construct($config = [])
88
$config = $this->loadConfig($config);
89
parent::__construct($config);
93
* Loads the configuration.
94
* This method will check if the command line option [[OPTION_APPCONFIG]] is specified.
95
* If so, the corresponding file will be loaded as the application configuration.
96
* Otherwise, the configuration provided as the parameter will be returned back.
97
* @param array $config the configuration provided in the constructor.
98
* @return array the actual configuration to be used by the application.
100
protected function loadConfig($config)
102
if (!empty($_SERVER['argv'])) {
103
$option = '--' . self::OPTION_APPCONFIG . '=';
104
foreach ($_SERVER['argv'] as $param) {
105
if (strpos($param, $option) !== false) {
106
$path = substr($param, strlen($option));
107
if (!empty($path) && is_file($file = Yii::getAlias($path))) {
108
return require $file;
111
exit("The configuration file does not exist: $path\n");
120
* Initialize the application.
122
public function init()
125
if ($this->enableCoreCommands) {
126
foreach ($this->coreCommands() as $id => $command) {
127
if (!isset($this->controllerMap[$id])) {
128
$this->controllerMap[$id] = $command;
132
// ensure we have the 'help' command so that we can list the available commands
133
if (!isset($this->controllerMap['help'])) {
134
$this->controllerMap['help'] = 'yii\console\controllers\HelpController';
139
* Handles the specified request.
140
* @param Request $request the request to be handled
141
* @return Response the resulting response
143
public function handleRequest($request)
145
list($route, $params) = $request->resolve();
146
$this->requestedRoute = $route;
147
$result = $this->runAction($route, $params);
148
if ($result instanceof Response) {
152
$response = $this->getResponse();
153
$response->exitStatus = $result;
159
* Runs a controller action specified by a route.
160
* This method parses the specified route and creates the corresponding child module(s), controller and action
161
* instances. It then calls [[Controller::runAction()]] to run the action with the given parameters.
162
* If the route is empty, the method will use [[defaultRoute]].
164
* For example, to run `public function actionTest($a, $b)` assuming that the controller has options the following
165
* code should be used:
168
* \Yii::$app->runAction('controller/test', ['option' => 'value', $a, $b]);
171
* @param string $route the route that specifies the action.
172
* @param array $params the parameters to be passed to the action
173
* @return int|Response|null the result of the action. This can be either an exit code or Response object.
174
* Exit code 0 means normal, and other values mean abnormal. Exit code of `null` is treated as `0` as well.
175
* @throws Exception if the route is invalid
177
public function runAction($route, $params = [])
180
$res = parent::runAction($route, $params);
181
return is_object($res) ? $res : (int) $res;
182
} catch (InvalidRouteException $e) {
183
throw new UnknownCommandException($route, $this, 0, $e);
188
* Returns the configuration of the built-in commands.
189
* @return array the configuration of the built-in commands.
191
public function coreCommands()
194
'asset' => 'yii\console\controllers\AssetController',
195
'cache' => 'yii\console\controllers\CacheController',
196
'fixture' => 'yii\console\controllers\FixtureController',
197
'help' => 'yii\console\controllers\HelpController',
198
'message' => 'yii\console\controllers\MessageController',
199
'migrate' => 'yii\console\controllers\MigrateController',
200
'serve' => 'yii\console\controllers\ServeController',
205
* Returns the error handler component.
206
* @return ErrorHandler the error handler application component.
208
public function getErrorHandler()
210
return $this->get('errorHandler');
214
* Returns the request component.
215
* @return Request the request component.
217
public function getRequest()
219
return $this->get('request');
223
* Returns the response component.
224
* @return Response the response component.
226
public function getResponse()
228
return $this->get('response');
234
public function coreComponents()
236
return array_merge(parent::coreComponents(), [
237
'request' => ['class' => 'yii\console\Request'],
238
'response' => ['class' => 'yii\console\Response'],
239
'errorHandler' => ['class' => 'yii\console\ErrorHandler'],