Application::coreComponents() - Code Metrics - Inspection of "Merge branch 'master' into php-74-ci" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — php-74-ci ( 3d1af5...9001b7 )

by Alexander

created 2019-12-06 15:16 UTC

Application::coreComponents() A

↳ Parent: Application

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	0
dl	0
loc	6
ccs	3
cts	3
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://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://secure.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 ErrorHandler $errorHandler The error handler application component. This property is read-only.
 * @property Request $request The request component. This property is read-only.
 * @property Response $response The response component. This property is read-only.
 *
 * @author Qiang Xue <[email protected]>
 * @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 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 treaded 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'],
        ]);
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\console;
9
10		use Yii;
11		use yii\base\InvalidRouteException;
12
13		// define STDIN, STDOUT and STDERR if the PHP SAPI did not define them (e.g. creating console application in web env)
14		// https://secure.php.net/manual/en/features.commandline.io-streams.php
15	1	defined('STDIN') or define('STDIN', fopen('php://stdin', 'r'));
16	1	defined('STDOUT') or define('STDOUT', fopen('php://stdout', 'w'));
17	1	defined('STDERR') or define('STDERR', fopen('php://stderr', 'w'));
18
19		/**
20		* Application represents a console application.
21		*
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:
25		*
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.
30		*
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.
34		*
35		* To run the console application, enter the following on the command line:
36		*
37		* ```
38		* yii <route> [--param1=value1 --param2 ...]
39		* ```
40		*
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).
45		*
46		* A `help` command is provided by default, which lists available commands and shows their usage.
47		* To use this command, simply type:
48		*
49		* ```
50		* yii help
51		* ```
52		*
53		* @property ErrorHandler $errorHandler The error handler application component. This property is read-only.
54		* @property Request $request The request component. This property is read-only.
55		* @property Response $response The response component. This property is read-only.
56		*
57		* @author Qiang Xue <[email protected]>
58		* @since 2.0
59		*/
60		class Application extends \yii\base\Application
61		{
62		/**
63		* The option name for specifying the application configuration file path.
64		*/
65		const OPTION_APPCONFIG = 'appconfig';
66
67		/**
68		* @var string the default route of this application. Defaults to 'help',
69		* meaning the `help` command.
70		*/
71		public $defaultRoute = 'help';
72		/**
73		* @var bool whether to enable the commands provided by the core framework.
74		* Defaults to true.
75		*/
76		public $enableCoreCommands = true;
77		/**
78		* @var Controller the currently active controller instance
79		*/
80		public $controller;
81
82
83		/**
84		* {@inheritdoc}
85		*/
86	3309	public function __construct($config = [])
87		{
88	3309	$config = $this->loadConfig($config);
89	3309	parent::__construct($config);
90	3309	}
91
92		/**
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.
99		*/
100	3309	protected function loadConfig($config)
101		{
102	3309	if (!empty($_SERVER['argv'])) {
103	3309	$option = '--' . self::OPTION_APPCONFIG . '=';
104	3309	foreach ($_SERVER['argv'] as $param) {
105	3309	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;
109		}
110
111		exit("The configuration file does not exist: $path\n");
		0 ignored issues – show Best Practice introduced 2019-02-03 21:14 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
112		}
113		}
114		}
115
116	3309	return $config;
117		}
118
119		/**
120		* Initialize the application.
121		*/
122	3309	public function init()
123		{
124	3309	parent::init();
125	3309	if ($this->enableCoreCommands) {
126	3291	foreach ($this->coreCommands() as $id => $command) {
127	3291	if (!isset($this->controllerMap[$id])) {
128	3291	$this->controllerMap[$id] = $command;
129		}
130		}
131		}
132		// ensure we have the 'help' command so that we can list the available commands
133	3309	if (!isset($this->controllerMap['help'])) {
134	24	$this->controllerMap['help'] = 'yii\console\controllers\HelpController';
135		}
136	3309	}
137
138		/**
139		* Handles the specified request.
140		* @param Request $request the request to be handled
141		* @return Response the resulting response
142		*/
143	1	public function handleRequest($request)
144		{
145	1	list($route, $params) = $request->resolve();
146	1	$this->requestedRoute = $route;
147	1	$result = $this->runAction($route, $params);
148	1	if ($result instanceof Response) {
		0 ignored issues – show introduced 2019-02-03 21:14 UTC by Report Bug Copy Issue Report `$result` is never a sub-type of `yii\console\Response`. Loading history...
149	1	return $result;
150		}
151
152	1	$response = $this->getResponse();
153	1	$response->exitStatus = $result;
154
155	1	return $response;
156		}
157
158		/**
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]].
163		*
164		* For example, to run `public function actionTest($a, $b)` assuming that the controller has options the following
165		* code should be used:
166		*
167		* ```php
168		* \Yii::$app->runAction('controller/test', ['option' => 'value', $a, $b]);
169		* ```
170		*
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 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 treaded as `0` as well.
175		* @throws Exception if the route is invalid
176		*/
177	9	public function runAction($route, $params = [])
178		{
179		try {
180	9	$res = parent::runAction($route, $params);
181	9	return is_object($res) ? $res : (int) $res;
182		} catch (InvalidRouteException $e) {
183		throw new UnknownCommandException($route, $this, 0, $e);
184		}
185		}
186
187		/**
188		* Returns the configuration of the built-in commands.
189		* @return array the configuration of the built-in commands.
190		*/
191	3291	public function coreCommands()
192		{
193		return [
194	3291	'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',
201		];
202		}
203
204		/**
205		* Returns the error handler component.
206		* @return ErrorHandler the error handler application component.
207		*/
208		public function getErrorHandler()
209		{
210		return $this->get('errorHandler');
		0 ignored issues – show Bug Best Practice introduced 2019-02-03 21:14 UTC by Report Bug Copy Issue Report The expression `return $this->get('errorHandler')` also could return the type `mixed` which is incompatible with the documented return type `yii\console\ErrorHandler`. Loading history...
211		}
212
213		/**
214		* Returns the request component.
215		* @return Request the request component.
216		*/
217	88	public function getRequest()
218		{
219	88	return $this->get('request');
		0 ignored issues – show Bug Best Practice introduced 2019-02-03 21:14 UTC by Report Bug Copy Issue Report The expression `return $this->get('request')` also could return the type `mixed` which is incompatible with the documented return type `yii\console\Request`. Loading history...
220		}
221
222		/**
223		* Returns the response component.
224		* @return Response the response component.
225		*/
226	3	public function getResponse()
227		{
228	3	return $this->get('response');
		0 ignored issues – show Bug Best Practice introduced 2019-02-03 21:14 UTC by Report Bug Copy Issue Report The expression `return $this->get('response')` also could return the type `mixed` which is incompatible with the documented return type `yii\console\Response`. Loading history...
229		}
230
231		/**
232		* {@inheritdoc}
233		*/
234	3309	public function coreComponents()
235		{
236	3309	return array_merge(parent::coreComponents(), [
237	3309	'request' => ['class' => 'yii\console\Request'],
238		'response' => ['class' => 'yii\console\Response'],
239		'errorHandler' => ['class' => 'yii\console\ErrorHandler'],
240		]);
241		}
242		}
243

yiisoft / yii2

Push — php-74-ci ( 3d1af5...9001b7 )

Application::coreComponents() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like