You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
623 lines
21 KiB
623 lines
21 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\base; |
|
|
|
use Yii; |
|
|
|
/** |
|
* Application is the base class for all application classes. |
|
* |
|
* @property \yii\web\AssetManager $assetManager The asset manager component. This property is read-only. |
|
* @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. |
|
* @property string $basePath The root directory of the application. |
|
* @property \yii\caching\Cache $cache The cache application component. Null if the component is not enabled. |
|
* This property is read-only. |
|
* @property \yii\db\Connection $db The database connection. This property is read-only. |
|
* @property \yii\web\ErrorHandler|\yii\console\ErrorHandler $errorHandler The error handler application |
|
* component. This property is read-only. |
|
* @property \yii\base\Formatter $formatter The formatter application component. This property is read-only. |
|
* @property \yii\i18n\I18N $i18n The internationalization component. This property is read-only. |
|
* @property \yii\log\Dispatcher $log The log dispatcher component. This property is read-only. |
|
* @property \yii\mail\MailerInterface $mail The mailer interface. This property is read-only. |
|
* @property \yii\web\Request|\yii\console\Request $request The request component. This property is read-only. |
|
* @property \yii\web\Response|\yii\console\Response $response The response component. This property is |
|
* read-only. |
|
* @property string $runtimePath The directory that stores runtime files. Defaults to the "runtime" |
|
* subdirectory under [[basePath]]. |
|
* @property string $timeZone The time zone used by this application. |
|
* @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]]. |
|
* @property View|\yii\web\View $view The view object that is used to render various view files. This property |
|
* is read-only. |
|
* |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
abstract class Application extends Module |
|
{ |
|
/** |
|
* @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'; |
|
/** |
|
* 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; |
|
|
|
/** |
|
* @var string the namespace that controller classes are in. If not set, |
|
* it will use the "app\controllers" namespace. |
|
*/ |
|
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'; |
|
/** |
|
* @var string the language that is meant to be used for end users. |
|
* @see sourceLanguage |
|
*/ |
|
public $language = 'en'; |
|
/** |
|
* @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 |
|
*/ |
|
public $sourceLanguage = 'en'; |
|
/** |
|
* @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', |
|
* 'bootstrap' => 'BootstrapClassName', // optional, may also be a configuration array |
|
* 'alias' => [ |
|
* '@alias1' => 'to/path1', |
|
* '@alias2' => 'to/path2', |
|
* ], |
|
* ] |
|
* ~~~ |
|
* |
|
* 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. |
|
*/ |
|
public $extensions = []; |
|
/** |
|
* @var array list of components that should be run during the application [[bootstrap()|bootstrapping process]]. |
|
* |
|
* Each component may be specified in one of the following formats: |
|
* |
|
* - an application component ID as specified via [[components]]. |
|
* - a module ID as specified via [[modules]]. |
|
* - a class name. |
|
* - a configuration array. |
|
* |
|
* 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. |
|
*/ |
|
public $bootstrap = []; |
|
/** |
|
* @var integer the current application state during a request handling life cycle. |
|
* This property is managed by the application. Do not modify this property. |
|
*/ |
|
public $state; |
|
|
|
|
|
/** |
|
* Constructor. |
|
* @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]]. |
|
* @throws InvalidConfigException if either [[id]] or [[basePath]] configuration is missing. |
|
*/ |
|
public function __construct($config = []) |
|
{ |
|
Yii::$app = $this; |
|
|
|
$this->state = self::STATE_BEGIN; |
|
|
|
$this->registerErrorHandler($config); |
|
$this->preInit($config); |
|
|
|
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. |
|
* @param array $config the application configuration |
|
* @throws InvalidConfigException if either [[id]] or [[basePath]] configuration is missing. |
|
*/ |
|
public function preInit(&$config) |
|
{ |
|
if (!isset($config['id'])) { |
|
throw new InvalidConfigException('The "id" configuration for the Application is required.'); |
|
} |
|
if (isset($config['basePath'])) { |
|
$this->setBasePath($config['basePath']); |
|
unset($config['basePath']); |
|
} else { |
|
throw new InvalidConfigException('The "basePath" configuration for the Application is required.'); |
|
} |
|
|
|
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'); |
|
} |
|
|
|
// merge core components with custom components |
|
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']; |
|
} |
|
} |
|
} |
|
|
|
/** |
|
* @inheritdoc |
|
*/ |
|
public function init() |
|
{ |
|
$this->state = self::STATE_INIT; |
|
$this->bootstrap(); |
|
} |
|
|
|
/** |
|
* 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. |
|
*/ |
|
protected function bootstrap() |
|
{ |
|
foreach ($this->extensions as $extension) { |
|
if (!empty($extension['alias'])) { |
|
foreach ($extension['alias'] as $name => $path) { |
|
Yii::setAlias($name, $path); |
|
} |
|
} |
|
if (isset($extension['bootstrap'])) { |
|
$component = Yii::createObject($extension['bootstrap']); |
|
if ($component instanceof BootstrapInterface) { |
|
Yii::trace("Bootstrap with " . get_class($component) . '::bootstrap()', __METHOD__); |
|
$component->bootstrap($this); |
|
} else { |
|
Yii::trace("Bootstrap with " . get_class($component), __METHOD__); |
|
} |
|
} |
|
} |
|
|
|
foreach ($this->bootstrap as $class) { |
|
if (is_string($class)) { |
|
if ($this->has($class)) { |
|
$component = $this->get($class); |
|
} elseif ($this->hasModule($class)) { |
|
$component = $this->getModule($class); |
|
} elseif (strpos($class, '\\') === false) { |
|
throw new InvalidConfigException("Unknown bootstrap component ID: $class"); |
|
} |
|
} |
|
if (!isset($component)) { |
|
$component = Yii::createObject($class); |
|
} |
|
|
|
if ($component instanceof BootstrapInterface) { |
|
Yii::trace("Bootstrap with " . get_class($component) . '::bootstrap()', __METHOD__); |
|
$component->bootstrap($this); |
|
} else { |
|
Yii::trace("Bootstrap with " . get_class($component), __METHOD__); |
|
} |
|
} |
|
} |
|
|
|
/** |
|
* Registers the errorHandler component as a PHP error handler. |
|
*/ |
|
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(); |
|
} |
|
} |
|
|
|
/** |
|
* 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. |
|
* @param string $path the root directory of the application. |
|
* @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() |
|
{ |
|
try { |
|
|
|
$this->state = self::STATE_BEFORE_REQUEST; |
|
$this->trigger(self::EVENT_BEFORE_REQUEST); |
|
|
|
$this->state = self::STATE_HANDLING_REQUEST; |
|
$response = $this->handleRequest($this->getRequest()); |
|
|
|
$this->state = self::STATE_AFTER_REQUEST; |
|
$this->trigger(self::EVENT_AFTER_REQUEST); |
|
|
|
$this->state = self::STATE_SENDING_RESPONSE; |
|
$response->send(); |
|
|
|
$this->state = self::STATE_END; |
|
|
|
return $response->exitStatus; |
|
|
|
} catch (ExitException $e) { |
|
|
|
$this->end($e->statusCode, isset($response) ? $response : null); |
|
return $e->statusCode; |
|
|
|
} |
|
} |
|
|
|
/** |
|
* Handles the specified request. |
|
* |
|
* This method should return an instance of [[Response]] or its child class |
|
* which represents the handling result of the request. |
|
* |
|
* @param Request $request the request to be handled |
|
* @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. |
|
* Defaults to the "runtime" subdirectory under [[basePath]]. |
|
*/ |
|
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. |
|
* Defaults to "vendor" directory under [[basePath]]. |
|
*/ |
|
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() |
|
{ |
|
return $this->get('db'); |
|
} |
|
|
|
/** |
|
* Returns the log dispatcher component. |
|
* @return \yii\log\Dispatcher the log dispatcher component |
|
*/ |
|
public function getLog() |
|
{ |
|
return $this->get('log'); |
|
} |
|
|
|
/** |
|
* Returns the error handler component. |
|
* @return \yii\web\ErrorHandler|\yii\console\ErrorHandler the error handler application component. |
|
*/ |
|
public function getErrorHandler() |
|
{ |
|
return $this->get('errorHandler'); |
|
} |
|
|
|
/** |
|
* Returns the cache component. |
|
* @return \yii\caching\Cache the cache application component. Null if the component is not enabled. |
|
*/ |
|
public function getCache() |
|
{ |
|
return $this->get('cache', false); |
|
} |
|
|
|
/** |
|
* Returns the formatter component. |
|
* @return \yii\base\Formatter the formatter application component. |
|
*/ |
|
public function getFormatter() |
|
{ |
|
return $this->get('formatter'); |
|
} |
|
|
|
/** |
|
* Returns the request component. |
|
* @return \yii\web\Request|\yii\console\Request the request component |
|
*/ |
|
public function getRequest() |
|
{ |
|
return $this->get('request'); |
|
} |
|
|
|
/** |
|
* Returns the response component. |
|
* @return \yii\web\Response|\yii\console\Response the response component |
|
*/ |
|
public function getResponse() |
|
{ |
|
return $this->get('response'); |
|
} |
|
|
|
/** |
|
* Returns the view object. |
|
* @return View|\yii\web\View the view object that is used to render various view files. |
|
*/ |
|
public function getView() |
|
{ |
|
return $this->get('view'); |
|
} |
|
|
|
/** |
|
* Returns the URL manager for this application. |
|
* @return \yii\web\UrlManager the URL manager for this application. |
|
*/ |
|
public function getUrlManager() |
|
{ |
|
return $this->get('urlManager'); |
|
} |
|
|
|
/** |
|
* Returns the internationalization (i18n) component |
|
* @return \yii\i18n\I18N the internationalization component |
|
*/ |
|
public function getI18n() |
|
{ |
|
return $this->get('i18n'); |
|
} |
|
|
|
/** |
|
* Returns the mailer component. |
|
* @return \yii\mail\MailerInterface the mailer interface |
|
*/ |
|
public function getMail() |
|
{ |
|
return $this->get('mail'); |
|
} |
|
|
|
/** |
|
* Returns the auth manager for this application. |
|
* @return \yii\rbac\ManagerInterface the auth manager for this application. |
|
* Null is returned if auth manager is not configured. |
|
*/ |
|
public function getAuthManager() |
|
{ |
|
return $this->get('authManager', false); |
|
} |
|
|
|
/** |
|
* Returns the asset manager. |
|
* @return \yii\web\AssetManager the asset manager component |
|
*/ |
|
public function getAssetManager() |
|
{ |
|
return $this->get('assetManager'); |
|
} |
|
|
|
/** |
|
* Returns the core application components. |
|
* @see set |
|
*/ |
|
public function coreComponents() |
|
{ |
|
return [ |
|
'log' => ['class' => 'yii\log\Dispatcher'], |
|
'view' => ['class' => 'yii\web\View'], |
|
'formatter' => ['class' => 'yii\base\Formatter'], |
|
'i18n' => ['class' => 'yii\i18n\I18N'], |
|
'mail' => ['class' => 'yii\swiftmailer\Mailer'], |
|
'urlManager' => ['class' => 'yii\web\UrlManager'], |
|
'assetManager' => ['class' => 'yii\web\AssetManager'], |
|
]; |
|
} |
|
|
|
/** |
|
* Terminates the application. |
|
* This method replaces the `exit()` function by ensuring the application life cycle is completed |
|
* before terminating the application. |
|
* @param integer $status the exit status (value 0 means normal exit while other values mean abnormal exit). |
|
* @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 |
|
*/ |
|
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); |
|
} |
|
} |
|
}
|
|
|