Commit 3fdcf11f by Carsten Brandt

updated phpdoc

parent 79b4f4d6
...@@ -12,18 +12,22 @@ use Yii; ...@@ -12,18 +12,22 @@ use Yii;
/** /**
* Application is the base class for all application classes. * 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\Manager $authManager The auth manager for this application. Null is returned if auth * @property \yii\rbac\Manager $authManager The auth manager for this application. Null is returned if auth
* manager is not configured. This property is read-only. * manager is not configured. This property is read-only.
* @property string $basePath The root directory of the application. * @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. * @property \yii\caching\Cache $cache The cache application component. Null if the component is not enabled.
* This property is read-only. * This property is read-only.
* @property \yii\db\Connection $db The database connection. This property is read-only. * @property \yii\db\Connection $db The database connection. This property is read-only.
* @property ErrorHandler $errorHandler The error handler application component. 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\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\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\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\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\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" * @property string $runtimePath The directory that stores runtime files. Defaults to the "runtime"
* subdirectory under [[basePath]]. * subdirectory under [[basePath]].
* @property string $timeZone The time zone used by this application. * @property string $timeZone The time zone used by this application.
......
...@@ -12,6 +12,8 @@ use Yii; ...@@ -12,6 +12,8 @@ use Yii;
/** /**
* Controller is the base class for classes containing controller logic. * Controller is the base class for classes containing controller logic.
* *
* @property Module[] $modules All ancestor modules that this controller is located within. This property is
* read-only.
* @property string $route The route (module ID, controller ID and action ID) of the current request. This * @property string $route The route (module ID, controller ID and action ID) of the current request. This
* property is read-only. * property is read-only.
* @property string $uniqueId The controller ID that is prefixed with the module ID (if any). This property is * @property string $uniqueId The controller ID that is prefixed with the module ID (if any). This property is
......
...@@ -46,8 +46,6 @@ use yii\base\InvalidRouteException; ...@@ -46,8 +46,6 @@ use yii\base\InvalidRouteException;
* yii help * yii help
* ~~~ * ~~~
* *
* @property Response $response The response component. This property is read-only.
*
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0 * @since 2.0
*/ */
......
...@@ -23,6 +23,8 @@ use yii\base\MailEvent; ...@@ -23,6 +23,8 @@ use yii\base\MailEvent;
* *
* @property View $view View instance. Note that the type of this property differs in getter and setter. See * @property View $view View instance. Note that the type of this property differs in getter and setter. See
* [[getView()]] and [[setView()]] for details. * [[getView()]] and [[setView()]] for details.
* @property string $viewPath The directory that contains the view files for composing mail messages Defaults
* to '@app/mail'. This property is read-only.
* *
* @author Paul Klimov <klimov.paul@gmail.com> * @author Paul Klimov <klimov.paul@gmail.com>
* @since 2.0 * @since 2.0
......
...@@ -25,6 +25,7 @@ use yii\di\Instance; ...@@ -25,6 +25,7 @@ use yii\di\Instance;
* [[itemChildTable]] and [[assignmentTable]]. * [[itemChildTable]] and [[assignmentTable]].
* *
* @property Item[] $items The authorization items of the specific type. This property is read-only. * @property Item[] $items The authorization items of the specific type. This property is read-only.
* @property Rule[] $rules This property is read-only.
* *
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @author Alexander Kochetov <creocoder@gmail.com> * @author Alexander Kochetov <creocoder@gmail.com>
......
...@@ -24,6 +24,7 @@ use yii\base\InvalidParamException; ...@@ -24,6 +24,7 @@ use yii\base\InvalidParamException;
* Use [[DbManager]] for more complex authorization data. * Use [[DbManager]] for more complex authorization data.
* *
* @property Item[] $items The authorization items of the specific type. This property is read-only. * @property Item[] $items The authorization items of the specific type. This property is read-only.
* @property Rule[] $rules This property is read-only.
* *
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @author Alexander Kochetov <creocoder@gmail.com> * @author Alexander Kochetov <creocoder@gmail.com>
......
...@@ -13,10 +13,7 @@ use yii\base\InvalidRouteException; ...@@ -13,10 +13,7 @@ use yii\base\InvalidRouteException;
/** /**
* Application is the base class for all web application classes. * Application is the base class for all web application classes.
* *
* @property AssetManager $assetManager The asset manager component. This property is read-only.
* @property string $homeUrl The homepage URL. * @property string $homeUrl The homepage URL.
* @property Request $request The request component. This property is read-only.
* @property Response $response The response component. This property is read-only.
* @property Session $session The session component. This property is read-only. * @property Session $session The session component. This property is read-only.
* @property User $user The user component. This property is read-only. * @property User $user The user component. This property is read-only.
* *
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment