phpdoc

extensions/authclient/clients/VKontakte.php

@@ -14,7 +14,6 @@ use yii\authclient\OAuth2;
  *
  * In order to use VKontakte OAuth you must register your application at <http://vk.com/editapp?act=create>.
  *
- *
  * Example application configuration:
  *
  * ~~~

framework/base/Application.php

@@ -12,8 +12,9 @@ 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
+ * @property \yii\web\AssetManager $assetManager The asset manager application component. This property is
+ * read-only.
+ * @property \yii\rbac\ManagerInterface $authManager The auth manager application component. 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.
@@ -21,23 +22,23 @@ use Yii;
  * @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|\yii\i18n\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 $mailer The mailer interface. 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 application component. This property is read-only.
+ * @property \yii\log\Dispatcher $log The log dispatcher application component. This property is read-only.
+ * @property \yii\mail\MailerInterface $mailer The mailer application 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"
  * subdirectory under [[basePath]].
- * @property \yii\base\Security $security The security application component.
+ * @property \yii\base\Security $security The security application component. This property is read-only.
  * @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.
+ * @property View|\yii\web\View $view The view application component that is used to render various view
+ * files. This property is read-only.
  *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @since 2.0
@@ -477,7 +478,7 @@ abstract class Application extends Module
 
     /**
      * Returns the database connection component.
-     * @return \yii\db\Connection the database connection
+     * @return \yii\db\Connection the database connection.
      */
     public function getDb()
     {
@@ -486,7 +487,7 @@ abstract class Application extends Module
 
     /**
      * Returns the log dispatcher component.
-     * @return \yii\log\Dispatcher the log dispatcher component
+     * @return \yii\log\Dispatcher the log dispatcher application component.
      */
     public function getLog()
     {
@@ -522,7 +523,7 @@ abstract class Application extends Module
 
     /**
      * Returns the request component.
-     * @return \yii\web\Request|\yii\console\Request the request component
+     * @return \yii\web\Request|\yii\console\Request the request component.
      */
     public function getRequest()
     {
@@ -531,7 +532,7 @@ abstract class Application extends Module
 
     /**
      * Returns the response component.
-     * @return \yii\web\Response|\yii\console\Response the response component
+     * @return \yii\web\Response|\yii\console\Response the response component.
      */
     public function getResponse()
     {
@@ -540,7 +541,7 @@ abstract class Application extends Module
 
     /**
      * Returns the view object.
-     * @return View|\yii\web\View the view object that is used to render various view files.
+     * @return View|\yii\web\View the view application component that is used to render various view files.
      */
     public function getView()
     {
@@ -558,7 +559,7 @@ abstract class Application extends Module
 
     /**
      * Returns the internationalization (i18n) component
-     * @return \yii\i18n\I18N the internationalization component
+     * @return \yii\i18n\I18N the internationalization application component.
      */
     public function getI18n()
     {
@@ -567,7 +568,7 @@ abstract class Application extends Module
 
     /**
      * Returns the mailer component.
-     * @return \yii\mail\MailerInterface the mailer interface
+     * @return \yii\mail\MailerInterface the mailer application component.
      */
     public function getMailer()
     {
@@ -576,7 +577,7 @@ abstract class Application extends Module
 
     /**
      * Returns the auth manager for this application.
-     * @return \yii\rbac\ManagerInterface the auth manager for this application.
+     * @return \yii\rbac\ManagerInterface the auth manager application component.
      * Null is returned if auth manager is not configured.
      */
     public function getAuthManager()
@@ -586,7 +587,7 @@ abstract class Application extends Module
 
     /**
      * Returns the asset manager.
-     * @return \yii\web\AssetManager the asset manager component
+     * @return \yii\web\AssetManager the asset manager application component.
      */
     public function getAssetManager()
     {
@@ -595,7 +596,7 @@ abstract class Application extends Module
 
     /**
      * Returns the security component.
-     * @return \yii\base\Security security component
+     * @return \yii\base\Security the security application component.
      */
     public function getSecurity()
     {
@@ -603,8 +604,8 @@ abstract class Application extends Module
     }
 
     /**
-     * Returns the core application components.
-     * @see set
+     * Returns the configuration of core application components.
+     * @see set()
      */
     public function coreComponents()
     {

framework/db/Connection.php

@@ -110,15 +110,22 @@ use yii\caching\Cache;
  * ],
  * ~~~
  *
- *
  * @property string $driverName Name of the DB driver.
  * @property boolean $isActive Whether the DB connection is established. This property is read-only.
  * @property string $lastInsertID The row ID of the last row inserted, or the last value retrieved from the
  * sequence object. This property is read-only.
+ * @property PDO $masterPdo The PDO instance for the currently active master connection. This property is
+ * read-only.
  * @property QueryBuilder $queryBuilder The query builder for the current DB connection. This property is
  * read-only.
+ * @property array $queryCacheInfo The current query cache information, or null if query cache is not enabled.
+ * This property is read-only.
  * @property Schema $schema The schema information for the database opened by this connection. This property
  * is read-only.
+ * @property Connection $slave The currently active slave connection. Null is returned if there is slave
+ * available and `$fallbackToMaster` is false. This property is read-only.
+ * @property PDO $slavePdo The PDO instance for the currently active slave connection. Null is returned if no
+ * slave connection is available and `$fallbackToMaster` is false. This property is read-only.
  * @property Transaction $transaction The currently active transaction. Null if no active transaction. This
  * property is read-only.
  *

framework/db/oci/Schema.php

@@ -15,6 +15,9 @@ use yii\db\ColumnSchema;
 /**
  * Schema is the class for retrieving metadata from an Oracle database
  *
+ * @property string $lastInsertID The row ID of the last row inserted, or the last value retrieved from the
+ * sequence object. This property is read-only.
+ *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @since 2.0
  */

framework/filters/Cors.php

@@ -54,7 +54,6 @@ use yii\web\Response;
  * }
  * ```
  *
- *
  * @author Philippe Gaultier <pgaultier@gmail.com>
  * @since 2.0
  */

framework/web/Application.php

@@ -123,7 +123,7 @@ class Application extends \yii\base\Application
 
     /**
      * Returns the session component.
-     * @return Session the session component
+     * @return Session the session component.
      */
     public function getSession()
     {
@@ -132,7 +132,7 @@ class Application extends \yii\base\Application
 
     /**
      * Returns the user component.
-     * @return User the user component
+     * @return User the user component.
      */
     public function getUser()
     {

framework/web/Request.php

@@ -75,7 +75,8 @@ use yii\helpers\StringHelper;
  * @property string $url The currently requested relative URL. Note that the URI returned is URL-encoded.
  * @property string $userAgent User agent, null if not present. This property is read-only.
  * @property string $userHost User host name, null if cannot be determined. This property is read-only.
- * @property string $userIP User IP address. This property is read-only.
+ * @property string $userIP User IP address. Null is returned if the user IP address cannot be detected. This
+ * property is read-only.
  *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @since 2.0

framework/web/UrlManager.php

@@ -31,9 +31,11 @@ use yii\caching\Cache;
  * ]
  * ~~~
  *
- * @property string $baseUrl The base URL that is used by [[createUrl()]] to prepend URLs it creates.
+ * @property string $baseUrl The base URL that is used by [[createUrl()]] to prepend to created URLs.
  * @property string $hostInfo The host info (e.g. "http://www.example.com") that is used by
- * [[createAbsoluteUrl()]] to prepend URLs it creates.
+ * [[createAbsoluteUrl()]] to prepend to created URLs.
+ * @property string $scriptUrl The entry script URL that is used by [[createUrl()]] to prepend to created
+ * URLs.
  *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @since 2.0
@@ -366,10 +368,10 @@ class UrlManager extends Component
     }
 
     /**
-     * Returns the base URL that is used by [[createUrl()]] to prepend to the URLs it creates.
+     * Returns the base URL that is used by [[createUrl()]] to prepend to created URLs.
      * It defaults to [[Request::baseUrl]].
      * This is mainly used when [[enablePrettyUrl]] is true and [[showScriptName]] is false.
-     * @return string the base URL that is used by [[createUrl()]] to prepend to the URLs it creates.
+     * @return string the base URL that is used by [[createUrl()]] to prepend to created URLs.
      * @throws InvalidConfigException if running in console application and [[baseUrl]] is not configured.
      */
     public function getBaseUrl()
@@ -387,9 +389,9 @@ class UrlManager extends Component
     }
 
     /**
-     * Sets the base URL that is used by [[createUrl()]] to prepend to the URLs it creates.
+     * Sets the base URL that is used by [[createUrl()]] to prepend to created URLs.
      * This is mainly used when [[enablePrettyUrl]] is true and [[showScriptName]] is false.
-     * @param string $value the base URL that is used by [[createUrl()]] to prepend URLs it creates.
+     * @param string $value the base URL that is used by [[createUrl()]] to prepend to created URLs.
      */
     public function setBaseUrl($value)
     {
@@ -397,10 +399,10 @@ class UrlManager extends Component
     }
 
     /**
-     * Returns the entry script URL that is used by [[createUrl()]] to prepend to the URLs it creates.
+     * Returns the entry script URL that is used by [[createUrl()]] to prepend to created URLs.
      * It defaults to [[Request::scriptUrl]].
      * This is mainly used when [[enablePrettyUrl]] is false or [[showScriptName]] is true.
-     * @return string the entry script URL that is used by [[createUrl()]] to prepend to the URLs it creates.
+     * @return string the entry script URL that is used by [[createUrl()]] to prepend to created URLs.
      * @throws InvalidConfigException if running in console application and [[scriptUrl]] is not configured.
      */
     public function getScriptUrl()
@@ -418,9 +420,9 @@ class UrlManager extends Component
     }
 
     /**
-     * Sets the entry script URL that is used by [[createUrl()]] to prepend to the URLs it creates.
+     * Sets the entry script URL that is used by [[createUrl()]] to prepend to created URLs.
      * This is mainly used when [[enablePrettyUrl]] is false or [[showScriptName]] is true.
-     * @param string $value the entry script URL that is used by [[createUrl()]] to prepend URLs it creates.
+     * @param string $value the entry script URL that is used by [[createUrl()]] to prepend to created URLs.
      */
     public function setScriptUrl($value)
     {
@@ -428,8 +430,8 @@ class UrlManager extends Component
     }
 
     /**
-     * Returns the host info that is used by [[createAbsoluteUrl()]] to prepend URLs it creates.
-     * @return string the host info (e.g. "http://www.example.com") that is used by [[createAbsoluteUrl()]] to prepend URLs it creates.
+     * Returns the host info that is used by [[createAbsoluteUrl()]] to prepend to created URLs.
+     * @return string the host info (e.g. "http://www.example.com") that is used by [[createAbsoluteUrl()]] to prepend to created URLs.
      * @throws InvalidConfigException if running in console application and [[hostInfo]] is not configured.
      */
     public function getHostInfo()
@@ -447,8 +449,8 @@ class UrlManager extends Component
     }
 
     /**
-     * Sets the host info that is used by [[createAbsoluteUrl()]] to prepend URLs it creates.
-     * @param string $value the host info (e.g. "http://www.example.com") that is used by [[createAbsoluteUrl()]] to prepend URLs it creates.
+     * Sets the host info that is used by [[createAbsoluteUrl()]] to prepend to created URLs.
+     * @param string $value the host info (e.g. "http://www.example.com") that is used by [[createAbsoluteUrl()]] to prepend to created URLs.
      */
     public function setHostInfo($value)
     {