mirror of
https://github.com/yiisoft/yii2.git
synced 2025-10-31 10:39:59 +08:00
244 lines
8.2 KiB
PHP
244 lines
8.2 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @link https://www.yiiframework.com/
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
|
* @license https://www.yiiframework.com/license/
|
|
*/
|
|
|
|
namespace yii\console;
|
|
|
|
use Yii;
|
|
use yii\base\InvalidRouteException;
|
|
|
|
// define STDIN, STDOUT and STDERR if the PHP SAPI did not define them (e.g. creating console application in web env)
|
|
// https://www.php.net/manual/en/features.commandline.io-streams.php
|
|
defined('STDIN') or define('STDIN', fopen('php://stdin', 'r'));
|
|
defined('STDOUT') or define('STDOUT', fopen('php://stdout', 'w'));
|
|
defined('STDERR') or define('STDERR', fopen('php://stderr', 'w'));
|
|
|
|
/**
|
|
* Application represents a console application.
|
|
*
|
|
* Application extends from [[\yii\base\Application]] by providing functionalities that are
|
|
* 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;
|
|
* - 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.
|
|
*
|
|
* The command classes should be under the namespace specified by [[controllerNamespace]].
|
|
* Their naming should follow the same naming convention as controllers. For example, the `help` command
|
|
* is implemented using the `HelpController` class.
|
|
*
|
|
* To run the console application, enter the following on the command line:
|
|
*
|
|
* ```
|
|
* yii <route> [--param1=value1 --param2 ...]
|
|
* ```
|
|
*
|
|
* 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).
|
|
*
|
|
* A `help` command is provided by default, which lists available commands and shows their usage.
|
|
* To use this command, simply type:
|
|
*
|
|
* ```
|
|
* yii help
|
|
* ```
|
|
*
|
|
* @property-read ErrorHandler $errorHandler The error handler application component.
|
|
* @property-read Request $request The request component.
|
|
* @property-read Response $response The response component.
|
|
*
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
* @since 2.0
|
|
*/
|
|
class Application extends \yii\base\Application
|
|
{
|
|
/**
|
|
* The option name for specifying the application configuration file path.
|
|
*/
|
|
const OPTION_APPCONFIG = 'appconfig';
|
|
|
|
/**
|
|
* @var string the default route of this application. Defaults to 'help',
|
|
* meaning the `help` command.
|
|
*/
|
|
public $defaultRoute = 'help';
|
|
/**
|
|
* @var bool whether to enable the commands provided by the core framework.
|
|
* Defaults to true.
|
|
*/
|
|
public $enableCoreCommands = true;
|
|
/**
|
|
* @var Controller the currently active controller instance
|
|
*/
|
|
public $controller;
|
|
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function __construct($config = [])
|
|
{
|
|
$config = $this->loadConfig($config);
|
|
parent::__construct($config);
|
|
}
|
|
|
|
/**
|
|
* Loads the configuration.
|
|
* This method will check if the command line option [[OPTION_APPCONFIG]] is specified.
|
|
* If so, the corresponding file will be loaded as the application configuration.
|
|
* Otherwise, the configuration provided as the parameter will be returned back.
|
|
* @param array $config the configuration provided in the constructor.
|
|
* @return array the actual configuration to be used by the application.
|
|
*/
|
|
protected function loadConfig($config)
|
|
{
|
|
if (!empty($_SERVER['argv'])) {
|
|
$option = '--' . self::OPTION_APPCONFIG . '=';
|
|
foreach ($_SERVER['argv'] as $param) {
|
|
if (strpos($param, $option) !== false) {
|
|
$path = substr($param, strlen($option));
|
|
if (!empty($path) && is_file($file = Yii::getAlias($path))) {
|
|
return require $file;
|
|
}
|
|
|
|
exit("The configuration file does not exist: $path\n");
|
|
}
|
|
}
|
|
}
|
|
|
|
return $config;
|
|
}
|
|
|
|
/**
|
|
* 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';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handles the specified request.
|
|
* @param Request $request the request to be handled
|
|
* @return Response the resulting response
|
|
*/
|
|
public function handleRequest($request)
|
|
{
|
|
list($route, $params) = $request->resolve();
|
|
$this->requestedRoute = $route;
|
|
$result = $this->runAction($route, $params);
|
|
if ($result instanceof Response) {
|
|
return $result;
|
|
}
|
|
|
|
$response = $this->getResponse();
|
|
$response->exitStatus = $result;
|
|
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Runs a controller action specified by a route.
|
|
* This method parses the specified route and creates the corresponding child module(s), controller and action
|
|
* instances. It then calls [[Controller::runAction()]] to run the action with the given parameters.
|
|
* If the route is empty, the method will use [[defaultRoute]].
|
|
*
|
|
* For example, to run `public function actionTest($a, $b)` assuming that the controller has options the following
|
|
* code should be used:
|
|
*
|
|
* ```php
|
|
* \Yii::$app->runAction('controller/test', ['option' => 'value', $a, $b]);
|
|
* ```
|
|
*
|
|
* @param string $route the route that specifies the action.
|
|
* @param array $params the parameters to be passed to the action
|
|
* @return int|Response|null the result of the action. This can be either an exit code or Response object.
|
|
* Exit code 0 means normal, and other values mean abnormal. Exit code of `null` is treated as `0` as well.
|
|
* @throws Exception if the route is invalid
|
|
*/
|
|
public function runAction($route, $params = [])
|
|
{
|
|
try {
|
|
$res = parent::runAction($route, $params);
|
|
return is_object($res) ? $res : (int) $res;
|
|
} catch (InvalidRouteException $e) {
|
|
throw new UnknownCommandException($route, $this, 0, $e);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the configuration of the built-in commands.
|
|
* @return array the configuration of the built-in commands.
|
|
*/
|
|
public function coreCommands()
|
|
{
|
|
return [
|
|
'asset' => 'yii\console\controllers\AssetController',
|
|
'cache' => 'yii\console\controllers\CacheController',
|
|
'fixture' => 'yii\console\controllers\FixtureController',
|
|
'help' => 'yii\console\controllers\HelpController',
|
|
'message' => 'yii\console\controllers\MessageController',
|
|
'migrate' => 'yii\console\controllers\MigrateController',
|
|
'serve' => 'yii\console\controllers\ServeController',
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Returns the error handler component.
|
|
* @return ErrorHandler the error handler application component.
|
|
*/
|
|
public function getErrorHandler()
|
|
{
|
|
return $this->get('errorHandler');
|
|
}
|
|
|
|
/**
|
|
* Returns the request component.
|
|
* @return Request the request component.
|
|
*/
|
|
public function getRequest()
|
|
{
|
|
return $this->get('request');
|
|
}
|
|
|
|
/**
|
|
* Returns the response component.
|
|
* @return Response the response component.
|
|
*/
|
|
public function getResponse()
|
|
{
|
|
return $this->get('response');
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function coreComponents()
|
|
{
|
|
return array_merge(parent::coreComponents(), [
|
|
'request' => ['class' => 'yii\console\Request'],
|
|
'response' => ['class' => 'yii\console\Response'],
|
|
'errorHandler' => ['class' => 'yii\console\ErrorHandler'],
|
|
]);
|
|
}
|
|
}
|