Application.php 22.1 KB
Newer Older
w  
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
w  
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

8 9
namespace yii\base;

Qiang Xue committed
10
use Yii;
.  
Qiang Xue committed
11

w  
Qiang Xue committed
12 13 14
/**
 * Application is the base class for all application classes.
 *
Carsten Brandt committed
15
 * @property \yii\web\AssetManager $assetManager The asset manager component. This property is read-only.
16 17
 * @property \yii\rbac\ManagerInterface $authManager The auth manager for this application. Null is returned
 * if auth manager is not configured. This property is read-only.
18
 * @property string $basePath The root directory of the application.
19
 * @property \yii\caching\Cache $cache The cache application component. Null if the component is not enabled.
20 21
 * This property is read-only.
 * @property \yii\db\Connection $db The database connection. This property is read-only.
Carsten Brandt committed
22 23
 * @property \yii\web\ErrorHandler|\yii\console\ErrorHandler $errorHandler The error handler application
 * component. This property is read-only.
24
 * @property \yii\base\Formatter|\yii\i18n\Formatter $formatter The formatter application component. This property is read-only.
25
 * @property \yii\i18n\I18N $i18n The internationalization component. This property is read-only.
26
 * @property \yii\log\Dispatcher $log The log dispatcher component. This property is read-only.
27
 * @property \yii\mail\MailerInterface $mailer The mailer interface. This property is read-only.
28
 * @property \yii\web\Request|\yii\console\Request $request The request component. This property is read-only.
Carsten Brandt committed
29 30
 * @property \yii\web\Response|\yii\console\Response $response The response component. This property is
 * read-only.
31 32
 * @property string $runtimePath The directory that stores runtime files. Defaults to the "runtime"
 * subdirectory under [[basePath]].
33
 * @property \yii\base\Security $security The security application component.
34
 * @property string $timeZone The time zone used by this application.
35 36 37 38
 * @property string $uniqueId The unique ID of the module. This property is read-only.
 * @property \yii\web\UrlManager $urlManager The URL manager for this application. This property is read-only.
 * @property string $vendorPath The directory that stores vendor files. Defaults to "vendor" directory under
 * [[basePath]].
Qiang Xue committed
39 40
 * @property View|\yii\web\View $view The view object that is used to render various view files. This property
 * is read-only.
41
 *
w  
Qiang Xue committed
42 43
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
w  
Qiang Xue committed
44
 */
45
abstract class Application extends Module
w  
Qiang Xue committed
46
{
47 48 49 50 51 52 53 54
    /**
     * @event Event an event raised before the application starts to handle a request.
     */
    const EVENT_BEFORE_REQUEST = 'beforeRequest';
    /**
     * @event Event an event raised after the application successfully handles a request (before the response is sent out).
     */
    const EVENT_AFTER_REQUEST = 'afterRequest';
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
    /**
     * Application state used by [[state]]: application just started.
     */
    const STATE_BEGIN = 0;
    /**
     * Application state used by [[state]]: application is initializing.
     */
    const STATE_INIT = 1;
    /**
     * Application state used by [[state]]: application is triggering [[EVENT_BEFORE_REQUEST]].
     */
    const STATE_BEFORE_REQUEST = 2;
    /**
     * Application state used by [[state]]: application is handling the request.
     */
    const STATE_HANDLING_REQUEST = 3;
    /**
     * Application state used by [[state]]: application is triggering [[EVENT_AFTER_REQUEST]]..
     */
    const STATE_AFTER_REQUEST = 4;
    /**
     * Application state used by [[state]]: application is about to send response.
     */
    const STATE_SENDING_RESPONSE = 5;
    /**
     * Application state used by [[state]]: application has ended.
     */
    const STATE_END = 6;

84
    /**
85
     * @var string the namespace that controller classes are located in.
86 87
     * This namespace will be used to load controller classes by prepending it to the controller class name.
     * The default namespace is `app\controllers`.
88
     *
89
     * Please refer to the [guide about class autoloading][guide-concept-autoloading] for more details.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
     */
    public $controllerNamespace = 'app\\controllers';
    /**
     * @var string the application name.
     */
    public $name = 'My Application';
    /**
     * @var string the version of this application.
     */
    public $version = '1.0';
    /**
     * @var string the charset currently used for the application.
     */
    public $charset = 'UTF-8';
    /**
Qiang Xue committed
105 106 107
     * @var string the language that is meant to be used for end users. It is recommended that you
     * use [IETF language tags](http://en.wikipedia.org/wiki/IETF_language_tag). For example, `en` stands
     * for English, while `en-US` stands for English (United States).
108 109
     * @see sourceLanguage
     */
110
    public $language = 'en-US';
111 112 113 114 115
    /**
     * @var string the language that the application is written in. This mainly refers to
     * the language that the messages and view files are written in.
     * @see language
     */
116
    public $sourceLanguage = 'en-US';
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
    /**
     * @var Controller the currently active controller instance
     */
    public $controller;
    /**
     * @var string|boolean the layout that should be applied for views in this application. Defaults to 'main'.
     * If this is false, layout will be disabled.
     */
    public $layout = 'main';
    /**
     * @var string the requested route
     */
    public $requestedRoute;
    /**
     * @var Action the requested Action. If null, it means the request cannot be resolved into an action.
     */
    public $requestedAction;
    /**
     * @var array the parameters supplied to the requested action.
     */
    public $requestedParams;
    /**
     * @var array list of installed Yii extensions. Each array element represents a single extension
     * with the following structure:
     *
     * ~~~
     * [
     *     'name' => 'extension name',
     *     'version' => 'version number',
146
     *     'bootstrap' => 'BootstrapClassName',  // optional, may also be a configuration array
Qiang Xue committed
147 148 149 150
     *     'alias' => [
     *         '@alias1' => 'to/path1',
     *         '@alias2' => 'to/path2',
     *     ],
151 152
     * ]
     * ~~~
153 154 155 156
     *
     * The "bootstrap" class listed above will be instantiated during the application
     * [[bootstrap()|bootstrapping process]]. If the class implements [[BootstrapInterface]],
     * its [[BootstrapInterface::bootstrap()|bootstrap()]] method will be also be called.
157
     *
Qiang Xue committed
158
     * If not set explicitly in the application config, this property will be populated with the contents of
159
     * `@vendor/yiisoft/extensions.php`.
160
     */
161
    public $extensions;
162
    /**
163
     * @var array list of components that should be run during the application [[bootstrap()|bootstrapping process]].
164
     *
165
     * Each component may be specified in one of the following formats:
166 167 168 169 170 171
     *
     * - an application component ID as specified via [[components]].
     * - a module ID as specified via [[modules]].
     * - a class name.
     * - a configuration array.
     *
172 173 174
     * During the bootstrapping process, each component will be instantiated. If the component class
     * implements [[BootstrapInterface]], its [[BootstrapInterface::bootstrap()|bootstrap()]] method
     * will be also be called.
175 176
     */
    public $bootstrap = [];
177 178 179 180
    /**
     * @var integer the current application state during a request handling life cycle.
     * This property is managed by the application. Do not modify this property.
     */
Qiang Xue committed
181
    public $state;
182 183 184 185


    /**
     * Constructor.
186 187
     * @param array $config name-value pairs that will be used to initialize the object properties.
     * Note that the configuration must contain both [[id]] and [[basePath]].
188 189 190 191 192
     * @throws InvalidConfigException if either [[id]] or [[basePath]] configuration is missing.
     */
    public function __construct($config = [])
    {
        Yii::$app = $this;
193
        $this->setInstance($this);
194

195 196
        $this->state = self::STATE_BEGIN;

197 198
        $this->preInit($config);

199 200
        $this->registerErrorHandler($config);

201 202 203 204 205 206 207 208
        Component::__construct($config);
    }

    /**
     * Pre-initializes the application.
     * This method is called at the beginning of the application constructor.
     * It initializes several important application properties.
     * If you override this method, please make sure you call the parent implementation.
209
     * @param array $config the application configuration
210 211 212 213 214
     * @throws InvalidConfigException if either [[id]] or [[basePath]] configuration is missing.
     */
    public function preInit(&$config)
    {
        if (!isset($config['id'])) {
215
            throw new InvalidConfigException('The "id" configuration for the Application is required.');
216 217 218 219 220
        }
        if (isset($config['basePath'])) {
            $this->setBasePath($config['basePath']);
            unset($config['basePath']);
        } else {
221
            throw new InvalidConfigException('The "basePath" configuration for the Application is required.');
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
        }

        if (isset($config['vendorPath'])) {
            $this->setVendorPath($config['vendorPath']);
            unset($config['vendorPath']);
        } else {
            // set "@vendor"
            $this->getVendorPath();
        }
        if (isset($config['runtimePath'])) {
            $this->setRuntimePath($config['runtimePath']);
            unset($config['runtimePath']);
        } else {
            // set "@runtime"
            $this->getRuntimePath();
        }

        if (isset($config['timeZone'])) {
            $this->setTimeZone($config['timeZone']);
            unset($config['timeZone']);
        } elseif (!ini_get('date.timezone')) {
            $this->setTimeZone('UTC');
        }
245 246

        // merge core components with custom components
Qiang Xue committed
247 248 249 250 251
        foreach ($this->coreComponents() as $id => $component) {
            if (!isset($config['components'][$id])) {
                $config['components'][$id] = $component;
            } elseif (is_array($config['components'][$id]) && !isset($config['components'][$id]['class'])) {
                $config['components'][$id]['class'] = $component['class'];
252 253
            }
        }
254 255 256 257 258 259 260
    }

    /**
     * @inheritdoc
     */
    public function init()
    {
261
        $this->state = self::STATE_INIT;
262
        $this->bootstrap();
263 264 265
    }

    /**
266 267 268
     * Initializes extensions and executes bootstrap components.
     * This method is called by [[init()]] after the application has been fully configured.
     * If you override this method, make sure you also call the parent implementation.
269
     */
270
    protected function bootstrap()
271
    {
272
        if ($this->extensions === null) {
273 274
            $file = Yii::getAlias('@vendor/yiisoft/extensions.php');
            $this->extensions = is_file($file) ? include($file) : [];
275
        }
276
        foreach ($this->extensions as $extension) {
277 278 279 280 281 282
            if (!empty($extension['alias'])) {
                foreach ($extension['alias'] as $name => $path) {
                    Yii::setAlias($name, $path);
                }
            }
            if (isset($extension['bootstrap'])) {
283 284
                $component = Yii::createObject($extension['bootstrap']);
                if ($component instanceof BootstrapInterface) {
285
                    Yii::trace("Bootstrap with " . get_class($component) . '::bootstrap()', __METHOD__);
286 287
                    $component->bootstrap($this);
                } else {
288
                    Yii::trace("Bootstrap with " . get_class($component), __METHOD__);
289
                }
290 291 292
            }
        }

293
        foreach ($this->bootstrap as $class) {
294
            $component = null;
295 296 297 298 299
            if (is_string($class)) {
                if ($this->has($class)) {
                    $component = $this->get($class);
                } elseif ($this->hasModule($class)) {
                    $component = $this->getModule($class);
300
                } elseif (strpos($class, '\\') === false) {
Qiang Xue committed
301
                    throw new InvalidConfigException("Unknown bootstrapping component ID: $class");
302 303 304 305 306 307 308
                }
            }
            if (!isset($component)) {
                $component = Yii::createObject($class);
            }

            if ($component instanceof BootstrapInterface) {
309
                Yii::trace("Bootstrap with " . get_class($component) . '::bootstrap()', __METHOD__);
310 311
                $component->bootstrap($this);
            } else {
312
                Yii::trace("Bootstrap with " . get_class($component), __METHOD__);
313 314
            }
        }
315 316
    }

317 318
    /**
     * Registers the errorHandler component as a PHP error handler.
319
     * @param array $config application config
320 321 322 323 324 325 326 327 328 329 330 331 332 333
     */
    protected function registerErrorHandler(&$config)
    {
        if (YII_ENABLE_ERROR_HANDLER) {
            if (!isset($config['components']['errorHandler']['class'])) {
                echo "Error: no errorHandler component is configured.\n";
                exit(1);
            }
            $this->set('errorHandler', $config['components']['errorHandler']);
            unset($config['components']['errorHandler']);
            $this->getErrorHandler()->register();
        }
    }

334 335 336 337 338 339 340 341 342 343 344 345 346
    /**
     * Returns an ID that uniquely identifies this module among all modules within the current application.
     * Since this is an application instance, it will always return an empty string.
     * @return string the unique ID of the module.
     */
    public function getUniqueId()
    {
        return '';
    }

    /**
     * Sets the root directory of the application and the @app alias.
     * This method can only be invoked at the beginning of the constructor.
347
     * @param string $path the root directory of the application.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
     * @property string the root directory of the application.
     * @throws InvalidParamException if the directory does not exist.
     */
    public function setBasePath($path)
    {
        parent::setBasePath($path);
        Yii::setAlias('@app', $this->getBasePath());
    }

    /**
     * Runs the application.
     * This is the main entrance of an application.
     * @return integer the exit status (0 means normal, non-zero values mean abnormal)
     */
    public function run()
    {
364 365 366 367
        try {

            $this->state = self::STATE_BEFORE_REQUEST;
            $this->trigger(self::EVENT_BEFORE_REQUEST);
368

369 370
            $this->state = self::STATE_HANDLING_REQUEST;
            $response = $this->handleRequest($this->getRequest());
371

372 373
            $this->state = self::STATE_AFTER_REQUEST;
            $this->trigger(self::EVENT_AFTER_REQUEST);
374

375 376
            $this->state = self::STATE_SENDING_RESPONSE;
            $response->send();
377

378
            $this->state = self::STATE_END;
379

380 381 382 383 384 385 386 387
            return $response->exitStatus;

        } catch (ExitException $e) {

            $this->end($e->statusCode, isset($response) ? $response : null);
            return $e->statusCode;

        }
388 389 390 391 392 393 394 395
    }

    /**
     * Handles the specified request.
     *
     * This method should return an instance of [[Response]] or its child class
     * which represents the handling result of the request.
     *
396
     * @param Request $request the request to be handled
397 398 399 400 401 402 403 404 405
     * @return Response the resulting response
     */
    abstract public function handleRequest($request);

    private $_runtimePath;

    /**
     * Returns the directory that stores runtime files.
     * @return string the directory that stores runtime files.
406
     * Defaults to the "runtime" subdirectory under [[basePath]].
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
     */
    public function getRuntimePath()
    {
        if ($this->_runtimePath === null) {
            $this->setRuntimePath($this->getBasePath() . DIRECTORY_SEPARATOR . 'runtime');
        }

        return $this->_runtimePath;
    }

    /**
     * Sets the directory that stores runtime files.
     * @param string $path the directory that stores runtime files.
     */
    public function setRuntimePath($path)
    {
        $this->_runtimePath = Yii::getAlias($path);
        Yii::setAlias('@runtime', $this->_runtimePath);
    }

    private $_vendorPath;

    /**
     * Returns the directory that stores vendor files.
     * @return string the directory that stores vendor files.
432
     * Defaults to "vendor" directory under [[basePath]].
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
     */
    public function getVendorPath()
    {
        if ($this->_vendorPath === null) {
            $this->setVendorPath($this->getBasePath() . DIRECTORY_SEPARATOR . 'vendor');
        }

        return $this->_vendorPath;
    }

    /**
     * Sets the directory that stores vendor files.
     * @param string $path the directory that stores vendor files.
     */
    public function setVendorPath($path)
    {
        $this->_vendorPath = Yii::getAlias($path);
        Yii::setAlias('@vendor', $this->_vendorPath);
    }

    /**
     * Returns the time zone used by this application.
     * This is a simple wrapper of PHP function date_default_timezone_get().
     * If time zone is not configured in php.ini or application config,
     * it will be set to UTC by default.
     * @return string the time zone used by this application.
     * @see http://php.net/manual/en/function.date-default-timezone-get.php
     */
    public function getTimeZone()
    {
        return date_default_timezone_get();
    }

    /**
     * Sets the time zone used by this application.
     * This is a simple wrapper of PHP function date_default_timezone_set().
     * Refer to the [php manual](http://www.php.net/manual/en/timezones.php) for available timezones.
     * @param string $value the time zone used by this application.
     * @see http://php.net/manual/en/function.date-default-timezone-set.php
     */
    public function setTimeZone($value)
    {
        date_default_timezone_set($value);
    }

    /**
     * Returns the database connection component.
     * @return \yii\db\Connection the database connection
     */
    public function getDb()
    {
484
        return $this->get('db');
485 486 487
    }

    /**
488 489
     * Returns the log dispatcher component.
     * @return \yii\log\Dispatcher the log dispatcher component
490 491 492
     */
    public function getLog()
    {
493
        return $this->get('log');
494 495 496 497
    }

    /**
     * Returns the error handler component.
498
     * @return \yii\web\ErrorHandler|\yii\console\ErrorHandler the error handler application component.
499 500 501
     */
    public function getErrorHandler()
    {
502
        return $this->get('errorHandler');
503 504 505 506 507 508 509 510
    }

    /**
     * Returns the cache component.
     * @return \yii\caching\Cache the cache application component. Null if the component is not enabled.
     */
    public function getCache()
    {
511
        return $this->get('cache', false);
512 513 514 515 516 517 518 519
    }

    /**
     * Returns the formatter component.
     * @return \yii\base\Formatter the formatter application component.
     */
    public function getFormatter()
    {
520
        return $this->get('formatter');
521 522 523 524 525 526 527 528
    }

    /**
     * Returns the request component.
     * @return \yii\web\Request|\yii\console\Request the request component
     */
    public function getRequest()
    {
529
        return $this->get('request');
530 531
    }

532 533 534 535 536 537 538 539 540
    /**
     * Returns the response component.
     * @return \yii\web\Response|\yii\console\Response the response component
     */
    public function getResponse()
    {
        return $this->get('response');
    }

541 542 543 544 545 546
    /**
     * Returns the view object.
     * @return View|\yii\web\View the view object that is used to render various view files.
     */
    public function getView()
    {
547
        return $this->get('view');
548 549 550 551 552 553 554 555
    }

    /**
     * Returns the URL manager for this application.
     * @return \yii\web\UrlManager the URL manager for this application.
     */
    public function getUrlManager()
    {
556
        return $this->get('urlManager');
557 558 559 560 561 562 563 564
    }

    /**
     * Returns the internationalization (i18n) component
     * @return \yii\i18n\I18N the internationalization component
     */
    public function getI18n()
    {
565
        return $this->get('i18n');
566 567 568 569 570 571
    }

    /**
     * Returns the mailer component.
     * @return \yii\mail\MailerInterface the mailer interface
     */
572
    public function getMailer()
573
    {
574
        return $this->get('mailer');
575 576 577 578
    }

    /**
     * Returns the auth manager for this application.
579
     * @return \yii\rbac\ManagerInterface the auth manager for this application.
580
     * Null is returned if auth manager is not configured.
581 582 583
     */
    public function getAuthManager()
    {
584
        return $this->get('authManager', false);
585 586
    }

587 588 589 590 591 592 593 594 595
    /**
     * Returns the asset manager.
     * @return \yii\web\AssetManager the asset manager component
     */
    public function getAssetManager()
    {
        return $this->get('assetManager');
    }

596 597 598 599 600 601 602 603 604
    /**
     * Returns the security component.
     * @return \yii\base\Security security component
     */
    public function getSecurity()
    {
        return $this->get('security');
    }

605
    /**
606 607
     * Returns the core application components.
     * @see set
608
     */
609
    public function coreComponents()
610
    {
611
        return [
612
            'log' => ['class' => 'yii\log\Dispatcher'],
613
            'view' => ['class' => 'yii\web\View'],
614 615
            'formatter' => ['class' => 'yii\base\Formatter'],
            'i18n' => ['class' => 'yii\i18n\I18N'],
616
            'mailer' => ['class' => 'yii\swiftmailer\Mailer'],
617
            'urlManager' => ['class' => 'yii\web\UrlManager'],
618
            'assetManager' => ['class' => 'yii\web\AssetManager'],
619
            'security' => ['class' => 'yii\base\Security'],
620
        ];
621 622
    }

623
    /**
Qiang Xue committed
624 625
     * Terminates the application.
     * This method replaces the `exit()` function by ensuring the application life cycle is completed
626
     * before terminating the application.
Qiang Xue committed
627
     * @param integer $status the exit status (value 0 means normal exit while other values mean abnormal exit).
628 629
     * @param Response $response the response to be sent. If not set, the default application [[response]] component will be used.
     * @throws ExitException if the application is in testing mode
Qiang Xue committed
630
     */
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
    public function end($status = 0, $response = null)
    {
        if ($this->state === self::STATE_BEFORE_REQUEST || $this->state === self::STATE_HANDLING_REQUEST) {
            $this->state = self::STATE_AFTER_REQUEST;
            $this->trigger(self::EVENT_AFTER_REQUEST);
        }

        if ($this->state !== self::STATE_SENDING_RESPONSE && $this->state !== self::STATE_END) {
            $this->state = self::STATE_END;
            $response = $response ? : $this->getResponse();
            $response->send();
        }

        if (YII_ENV_TEST) {
            throw new ExitException($status);
        } else {
            exit($status);
        }
    }
w  
Qiang Xue committed
650
}