yiisoft /
yii2
Complex classes like Application often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Application, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 48 | abstract class Application extends Module |
||
| 49 | { |
||
| 50 | /** |
||
| 51 | * @event Event an event raised before the application starts to handle a request. |
||
| 52 | */ |
||
| 53 | const EVENT_BEFORE_REQUEST = 'beforeRequest'; |
||
| 54 | /** |
||
| 55 | * @event Event an event raised after the application successfully handles a request (before the response is sent out). |
||
| 56 | */ |
||
| 57 | const EVENT_AFTER_REQUEST = 'afterRequest'; |
||
| 58 | /** |
||
| 59 | * Application state used by [[state]]: application just started. |
||
| 60 | */ |
||
| 61 | const STATE_BEGIN = 0; |
||
| 62 | /** |
||
| 63 | * Application state used by [[state]]: application is initializing. |
||
| 64 | */ |
||
| 65 | const STATE_INIT = 1; |
||
| 66 | /** |
||
| 67 | * Application state used by [[state]]: application is triggering [[EVENT_BEFORE_REQUEST]]. |
||
| 68 | */ |
||
| 69 | const STATE_BEFORE_REQUEST = 2; |
||
| 70 | /** |
||
| 71 | * Application state used by [[state]]: application is handling the request. |
||
| 72 | */ |
||
| 73 | const STATE_HANDLING_REQUEST = 3; |
||
| 74 | /** |
||
| 75 | * Application state used by [[state]]: application is triggering [[EVENT_AFTER_REQUEST]].. |
||
| 76 | */ |
||
| 77 | const STATE_AFTER_REQUEST = 4; |
||
| 78 | /** |
||
| 79 | * Application state used by [[state]]: application is about to send response. |
||
| 80 | */ |
||
| 81 | const STATE_SENDING_RESPONSE = 5; |
||
| 82 | /** |
||
| 83 | * Application state used by [[state]]: application has ended. |
||
| 84 | */ |
||
| 85 | const STATE_END = 6; |
||
| 86 | |||
| 87 | /** |
||
| 88 | * @var string the namespace that controller classes are located in. |
||
| 89 | * This namespace will be used to load controller classes by prepending it to the controller class name. |
||
| 90 | * The default namespace is `app\controllers`. |
||
| 91 | * |
||
| 92 | * Please refer to the [guide about class autoloading](guide:concept-autoloading.md) for more details. |
||
| 93 | */ |
||
| 94 | public $controllerNamespace = 'app\\controllers'; |
||
| 95 | /** |
||
| 96 | * @var string the application name. |
||
| 97 | */ |
||
| 98 | public $name = 'My Application'; |
||
| 99 | /** |
||
| 100 | * @var string the charset currently used for the application. |
||
| 101 | */ |
||
| 102 | public $charset = 'UTF-8'; |
||
| 103 | /** |
||
| 104 | * @var string the language that is meant to be used for end users. It is recommended that you |
||
| 105 | * use [IETF language tags](http://en.wikipedia.org/wiki/IETF_language_tag). For example, `en` stands |
||
| 106 | * for English, while `en-US` stands for English (United States). |
||
| 107 | * @see sourceLanguage |
||
| 108 | */ |
||
| 109 | public $language = 'en-US'; |
||
| 110 | /** |
||
| 111 | * @var string the language that the application is written in. This mainly refers to |
||
| 112 | * the language that the messages and view files are written in. |
||
| 113 | * @see language |
||
| 114 | */ |
||
| 115 | public $sourceLanguage = 'en-US'; |
||
| 116 | /** |
||
| 117 | * @var Controller the currently active controller instance |
||
| 118 | */ |
||
| 119 | public $controller; |
||
| 120 | /** |
||
| 121 | * @var string|bool the layout that should be applied for views in this application. Defaults to 'main'. |
||
| 122 | * If this is false, layout will be disabled. |
||
| 123 | */ |
||
| 124 | public $layout = 'main'; |
||
| 125 | /** |
||
| 126 | * @var string the requested route |
||
| 127 | */ |
||
| 128 | public $requestedRoute; |
||
| 129 | /** |
||
| 130 | * @var Action the requested Action. If null, it means the request cannot be resolved into an action. |
||
| 131 | */ |
||
| 132 | public $requestedAction; |
||
| 133 | /** |
||
| 134 | * @var array the parameters supplied to the requested action. |
||
| 135 | */ |
||
| 136 | public $requestedParams; |
||
| 137 | /** |
||
| 138 | * @var array list of installed Yii extensions. Each array element represents a single extension |
||
| 139 | * with the following structure: |
||
| 140 | * |
||
| 141 | * ```php |
||
| 142 | * [ |
||
| 143 | * 'name' => 'extension name', |
||
| 144 | * 'version' => 'version number', |
||
| 145 | * 'bootstrap' => 'BootstrapClassName', // optional, may also be a configuration array |
||
| 146 | * 'alias' => [ |
||
| 147 | * '@alias1' => 'to/path1', |
||
| 148 | * '@alias2' => 'to/path2', |
||
| 149 | * ], |
||
| 150 | * ] |
||
| 151 | * ``` |
||
| 152 | * |
||
| 153 | * The "bootstrap" class listed above will be instantiated during the application |
||
| 154 | * [[bootstrap()|bootstrapping process]]. If the class implements [[BootstrapInterface]], |
||
| 155 | * its [[BootstrapInterface::bootstrap()|bootstrap()]] method will be also be called. |
||
| 156 | * |
||
| 157 | * If not set explicitly in the application config, this property will be populated with the contents of |
||
| 158 | * `@vendor/yiisoft/extensions.php`. |
||
| 159 | */ |
||
| 160 | public $extensions; |
||
| 161 | /** |
||
| 162 | * @var array list of components that should be run during the application [[bootstrap()|bootstrapping process]]. |
||
| 163 | * |
||
| 164 | * Each component may be specified in one of the following formats: |
||
| 165 | * |
||
| 166 | * - an application component ID as specified via [[components]]. |
||
| 167 | * - a module ID as specified via [[modules]]. |
||
| 168 | * - a class name. |
||
| 169 | * - a configuration array. |
||
| 170 | * |
||
| 171 | * During the bootstrapping process, each component will be instantiated. If the component class |
||
| 172 | * implements [[BootstrapInterface]], its [[BootstrapInterface::bootstrap()|bootstrap()]] method |
||
| 173 | * will be also be called. |
||
| 174 | */ |
||
| 175 | public $bootstrap = []; |
||
| 176 | /** |
||
| 177 | * @var int the current application state during a request handling life cycle. |
||
| 178 | * This property is managed by the application. Do not modify this property. |
||
| 179 | */ |
||
| 180 | public $state; |
||
| 181 | /** |
||
| 182 | * @var array list of loaded modules indexed by their class names. |
||
| 183 | */ |
||
| 184 | public $loadedModules = []; |
||
| 185 | |||
| 186 | |||
| 187 | /** |
||
| 188 | * Constructor. |
||
| 189 | * @param array $config name-value pairs that will be used to initialize the object properties. |
||
| 190 | * Note that the configuration must contain both [[id]] and [[basePath]]. |
||
| 191 | * @throws InvalidConfigException if either [[id]] or [[basePath]] configuration is missing. |
||
| 192 | */ |
||
| 193 | 2197 | public function __construct($config = []) |
|
| 206 | |||
| 207 | /** |
||
| 208 | * Pre-initializes the application. |
||
| 209 | * This method is called at the beginning of the application constructor. |
||
| 210 | * It initializes several important application properties. |
||
| 211 | * If you override this method, please make sure you call the parent implementation. |
||
| 212 | * @param array $config the application configuration |
||
| 213 | * @throws InvalidConfigException if either [[id]] or [[basePath]] configuration is missing. |
||
| 214 | */ |
||
| 215 | 2197 | public function preInit(&$config) |
|
| 264 | |||
| 265 | /** |
||
| 266 | * @inheritdoc |
||
| 267 | */ |
||
| 268 | 2197 | public function init() |
|
| 273 | |||
| 274 | /** |
||
| 275 | * Initializes extensions and executes bootstrap components. |
||
| 276 | * This method is called by [[init()]] after the application has been fully configured. |
||
| 277 | * If you override this method, make sure you also call the parent implementation. |
||
| 278 | */ |
||
| 279 | 2197 | protected function bootstrap() |
|
| 325 | |||
| 326 | /** |
||
| 327 | * Registers the errorHandler component as a PHP error handler. |
||
| 328 | * @param array $config application config |
||
| 329 | */ |
||
| 330 | 2197 | protected function registerErrorHandler(&$config) |
|
| 342 | |||
| 343 | /** |
||
| 344 | * Returns an ID that uniquely identifies this module among all modules within the current application. |
||
| 345 | * Since this is an application instance, it will always return an empty string. |
||
| 346 | * @return string the unique ID of the module. |
||
| 347 | */ |
||
| 348 | public function getUniqueId() |
||
| 352 | |||
| 353 | /** |
||
| 354 | * Sets the root directory of the application and the @app alias. |
||
| 355 | * This method can only be invoked at the beginning of the constructor. |
||
| 356 | * @param string $path the root directory of the application. |
||
| 357 | * @property string the root directory of the application. |
||
| 358 | * @throws InvalidParamException if the directory does not exist. |
||
| 359 | */ |
||
| 360 | 2197 | public function setBasePath($path) |
|
| 365 | |||
| 366 | /** |
||
| 367 | * Runs the application. |
||
| 368 | * This is the main entrance of an application. |
||
| 369 | * @return int the exit status (0 means normal, non-zero values mean abnormal) |
||
| 370 | */ |
||
| 371 | public function run() |
||
| 398 | |||
| 399 | /** |
||
| 400 | * Handles the specified request. |
||
| 401 | * |
||
| 402 | * This method should return an instance of [[Response]] or its child class |
||
| 403 | * which represents the handling result of the request. |
||
| 404 | * |
||
| 405 | * @param Request $request the request to be handled |
||
| 406 | * @return Response the resulting response |
||
| 407 | */ |
||
| 408 | abstract public function handleRequest($request); |
||
| 409 | |||
| 410 | private $_runtimePath; |
||
| 411 | |||
| 412 | /** |
||
| 413 | * Returns the directory that stores runtime files. |
||
| 414 | * @return string the directory that stores runtime files. |
||
| 415 | * Defaults to the "runtime" subdirectory under [[basePath]]. |
||
| 416 | */ |
||
| 417 | 2197 | public function getRuntimePath() |
|
| 425 | |||
| 426 | /** |
||
| 427 | * Sets the directory that stores runtime files. |
||
| 428 | * @param string $path the directory that stores runtime files. |
||
| 429 | */ |
||
| 430 | 2197 | public function setRuntimePath($path) |
|
| 435 | |||
| 436 | private $_vendorPath; |
||
| 437 | |||
| 438 | /** |
||
| 439 | * Returns the directory that stores vendor files. |
||
| 440 | * @return string the directory that stores vendor files. |
||
| 441 | * Defaults to "vendor" directory under [[basePath]]. |
||
| 442 | */ |
||
| 443 | public function getVendorPath() |
||
| 451 | |||
| 452 | /** |
||
| 453 | * Sets the directory that stores vendor files. |
||
| 454 | * @param string $path the directory that stores vendor files. |
||
| 455 | */ |
||
| 456 | 2197 | public function setVendorPath($path) |
|
| 463 | |||
| 464 | /** |
||
| 465 | * Returns the time zone used by this application. |
||
| 466 | * This is a simple wrapper of PHP function date_default_timezone_get(). |
||
| 467 | * If time zone is not configured in php.ini or application config, |
||
| 468 | * it will be set to UTC by default. |
||
| 469 | * @return string the time zone used by this application. |
||
| 470 | * @see http://php.net/manual/en/function.date-default-timezone-get.php |
||
| 471 | */ |
||
| 472 | 258 | public function getTimeZone() |
|
| 476 | |||
| 477 | /** |
||
| 478 | * Sets the time zone used by this application. |
||
| 479 | * This is a simple wrapper of PHP function date_default_timezone_set(). |
||
| 480 | * Refer to the [php manual](http://www.php.net/manual/en/timezones.php) for available timezones. |
||
| 481 | * @param string $value the time zone used by this application. |
||
| 482 | * @see http://php.net/manual/en/function.date-default-timezone-set.php |
||
| 483 | */ |
||
| 484 | 363 | public function setTimeZone($value) |
|
| 488 | |||
| 489 | /** |
||
| 490 | * Returns the database connection component. |
||
| 491 | * @return \yii\db\Connection the database connection. |
||
| 492 | */ |
||
| 493 | 34 | public function getDb() |
|
| 497 | |||
| 498 | /** |
||
| 499 | * Returns the log dispatcher component. |
||
| 500 | * @return \yii\log\Dispatcher the log dispatcher application component. |
||
| 501 | */ |
||
| 502 | public function getLog() |
||
| 506 | |||
| 507 | /** |
||
| 508 | * Returns the error handler component. |
||
| 509 | * @return \yii\web\ErrorHandler|\yii\console\ErrorHandler the error handler application component. |
||
| 510 | */ |
||
| 511 | public function getErrorHandler() |
||
| 515 | |||
| 516 | /** |
||
| 517 | * Returns the cache component. |
||
| 518 | * @return \yii\caching\Cache the cache application component. Null if the component is not enabled. |
||
| 519 | */ |
||
| 520 | 1 | public function getCache() |
|
| 524 | |||
| 525 | /** |
||
| 526 | * Returns the formatter component. |
||
| 527 | * @return \yii\i18n\Formatter the formatter application component. |
||
| 528 | */ |
||
| 529 | 14 | public function getFormatter() |
|
| 533 | |||
| 534 | /** |
||
| 535 | * Returns the request component. |
||
| 536 | * @return \yii\web\Request|\yii\console\Request the request component. |
||
| 537 | */ |
||
| 538 | public function getRequest() |
||
| 542 | |||
| 543 | /** |
||
| 544 | * Returns the response component. |
||
| 545 | * @return \yii\web\Response|\yii\console\Response the response component. |
||
| 546 | */ |
||
| 547 | public function getResponse() |
||
| 551 | |||
| 552 | /** |
||
| 553 | * Returns the view object. |
||
| 554 | * @return View|\yii\web\View the view application component that is used to render various view files. |
||
| 555 | */ |
||
| 556 | 23 | public function getView() |
|
| 560 | |||
| 561 | /** |
||
| 562 | * Returns the URL manager for this application. |
||
| 563 | * @return \yii\web\UrlManager the URL manager for this application. |
||
| 564 | */ |
||
| 565 | 27 | public function getUrlManager() |
|
| 569 | |||
| 570 | /** |
||
| 571 | * Returns the internationalization (i18n) component |
||
| 572 | * @return \yii\i18n\I18N the internationalization application component. |
||
| 573 | */ |
||
| 574 | 572 | public function getI18n() |
|
| 578 | |||
| 579 | /** |
||
| 580 | * Returns the mailer component. |
||
| 581 | * @return \yii\mail\MailerInterface the mailer application component. |
||
| 582 | */ |
||
| 583 | public function getMailer() |
||
| 587 | |||
| 588 | /** |
||
| 589 | * Returns the auth manager for this application. |
||
| 590 | * @return \yii\rbac\ManagerInterface the auth manager application component. |
||
| 591 | * Null is returned if auth manager is not configured. |
||
| 592 | */ |
||
| 593 | public function getAuthManager() |
||
| 597 | |||
| 598 | /** |
||
| 599 | * Returns the asset manager. |
||
| 600 | * @return \yii\web\AssetManager the asset manager application component. |
||
| 601 | */ |
||
| 602 | 2 | public function getAssetManager() |
|
| 606 | |||
| 607 | /** |
||
| 608 | * Returns the security component. |
||
| 609 | * @return \yii\base\Security the security application component. |
||
| 610 | */ |
||
| 611 | 28 | public function getSecurity() |
|
| 615 | |||
| 616 | /** |
||
| 617 | * Returns the configuration of core application components. |
||
| 618 | * @see set() |
||
| 619 | */ |
||
| 620 | 2197 | public function coreComponents() |
|
| 633 | |||
| 634 | /** |
||
| 635 | * Terminates the application. |
||
| 636 | * This method replaces the `exit()` function by ensuring the application life cycle is completed |
||
| 637 | * before terminating the application. |
||
| 638 | * @param int $status the exit status (value 0 means normal exit while other values mean abnormal exit). |
||
| 639 | * @param Response $response the response to be sent. If not set, the default application [[response]] component will be used. |
||
| 640 | * @throws ExitException if the application is in testing mode |
||
| 641 | */ |
||
| 642 | 3 | public function end($status = 0, $response = null) |
|
| 661 | |||
| 662 | /** |
||
| 663 | * Configures [[Yii::$container]] with the $config |
||
| 664 | * |
||
| 665 | * @param array $config values given in terms of name-value pairs |
||
| 666 | * @since 2.0.11 |
||
| 667 | */ |
||
| 668 | 1 | public function setContainer($config) |
|
| 672 | } |
||
| 673 |
Loading history...
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..