rob006 / yii2-dev

framework/console/Controller.php

Doc Comments +1 added lines, -1 removed lines

@@ -284,7 +284,7 @@
      *
      * @param string $message to echo out before waiting for user input
      * @param bool $default this value is returned if no selection is made.
-     * @return bool whether user confirmed.
+     * @return boolean|null whether user confirmed.
      * Will return true if [[interactive]] is false.
      */
     public function confirm($message, $default = false)

framework/log/Logger.php

Doc Comments +2 added lines, -2 removed lines

@@ -196,7 +196,7 @@ 
      * `$categories` and `$excludeCategories` as parameters to retrieve the
      * results that you are interested in.
      *
-     * @param array $categories list of categories that you are interested in.
+     * @param string[] $categories list of categories that you are interested in.
      * You can use an asterisk at the end of a category to do a prefix match.
      * For example, 'yii\db\*' will match categories starting with 'yii\db\',
      * such as 'yii\db\Connection'.
@@ -246,7 +246,7 @@ 
      * Returns the statistical results of DB queries.
      * The results returned include the number of SQL statements executed and
      * the total time spent.
-     * @return array the first element indicates the number of SQL statements executed,
+     * @return integer[] the first element indicates the number of SQL statements executed,
      * and the second element the total time spent in SQL execution.
      */
     public function getDbProfiling()

framework/captcha/CaptchaAction.php

Doc Comments +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
     /**
      * Generates a hash code that can be used for client-side validation.
      * @param string $code the CAPTCHA code
-     * @return string a hash code generated from the CAPTCHA code
+     * @return integer a hash code generated from the CAPTCHA code
      */
     public function generateValidationHash($code)
     {

framework/db/DataReader.php

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
     /**
      * Returns a single column from the next row of a result set.
      * @param int $columnIndex zero-based column index
-     * @return mixed the column of the current row, false if no more rows available
+     * @return string the column of the current row, false if no more rows available
      */
     public function readColumn($columnIndex)
     {

framework/web/User.php

Doc Comments +2 added lines, -2 removed lines

@@ -175,7 +175,7 @@ 
      * stored in session and reconstruct the corresponding identity object, if it has not done so before.
      * @param bool $autoRenew whether to automatically renew authentication status if it has not been done so before.
      * This is only useful when [[enableSession]] is true.
-     * @return IdentityInterface|null the identity object associated with the currently logged-in user.
+     * @return null|boolean the identity object associated with the currently logged-in user.
      * `null` is returned if the user is not logged in (not authenticated).
      * @see login()
      * @see logout()
@@ -259,7 +259,7 @@ 
      * with the provided access token. If successful, it will call [[login()]] to log in the authenticated user.
      * If authentication fails or [[login()]] is unsuccessful, it will return null.
      * @param string $token the access token
-     * @param mixed $type the type of the token. The value of this parameter depends on the implementation.
+     * @param string $type the type of the token. The value of this parameter depends on the implementation.
      * For example, [[\yii\filters\auth\HttpBearerAuth]] will set this parameter to be `yii\filters\auth\HttpBearerAuth`.
      * @return IdentityInterface|null the identity associated with the given access token. Null is returned if
      * the access token is invalid or [[login()]] is unsuccessful.

framework/helpers/BaseHtml.php

Doc Comments +1 added lines, -1 removed lines

@@ -216,7 +216,7 @@
 
     /**
      * Generates a link tag that refers to an external CSS file.
-     * @param array|string $url the URL of the external CSS file. This parameter will be processed by [[Url::to()]].
+     * @param string|boolean $url the URL of the external CSS file. This parameter will be processed by [[Url::to()]].
      * @param array $options the tag options in terms of name-value pairs. The following options are specially handled:
      *
      * - condition: specifies the conditional comments for IE, e.g., `lt IE 9`. When this is specified,

framework/web/UrlRule.php

Doc Comments +2 added lines, -2 removed lines

@@ -415,7 +415,7 @@ 
      * @param UrlManager $manager the URL manager
      * @param string $route the route. It should not have slashes at the beginning or the end.
      * @param array $params the parameters
-     * @return string|bool the created URL, or `false` if this rule cannot be used for creating this URL.
+     * @return false|string the created URL, or `false` if this rule cannot be used for creating this URL.
      */
     public function createUrl($manager, $route, $params)
     {
@@ -513,7 +513,7 @@ 
      * When found - replaces this placeholder key with a appropriate name of matching parameter.
      * Used in [[parseRequest()]], [[createUrl()]].
      *
-     * @param array $matches result of `preg_match()` call
+     * @param string[] $matches result of `preg_match()` call
      * @return array input array with replaced placeholder keys
      * @see placeholders
      * @since 2.0.7

framework/console/controllers/BaseMigrateController.php

Doc Comments +4 added lines, -4 removed lines

@@ -203,7 +203,7 @@ 
      * yii migrate/down all # revert all migrations
      * ```
      *
-     * @param int|string $limit the number of migrations to be reverted. Defaults to 1,
+     * @param integer $limit the number of migrations to be reverted. Defaults to 1,
      * meaning the last applied migration will be reverted. When value is "all", all migrations will be reverted.
      * @throws Exception if the number of the steps specified is less than 1.
      *
@@ -265,7 +265,7 @@ 
      * yii migrate/redo all # redo all migrations
      * ```
      *
-     * @param int|string $limit the number of migrations to be redone. Defaults to 1,
+     * @param integer $limit the number of migrations to be redone. Defaults to 1,
      * meaning the last applied migration will be redone. When equals "all", all migrations will be redone.
      * @throws Exception if the number of the steps specified is less than 1.
      *
@@ -462,7 +462,7 @@ 
      * yii migrate/history all # showing the whole history
      * ```
      *
-     * @param int|string $limit the maximum number of migrations to be displayed.
+     * @param integer $limit the maximum number of migrations to be displayed.
      * If it is "all", the whole migration history will be displayed.
      * @throws \yii\console\Exception if invalid limit value passed
      */
@@ -506,7 +506,7 @@ 
      * yii migrate/new all # showing all new migrations
      * ```
      *
-     * @param int|string $limit the maximum number of new migrations to be displayed.
+     * @param integer $limit the maximum number of new migrations to be displayed.
      * If it is `all`, all available new migrations will be displayed.
      * @throws \yii\console\Exception if invalid limit value passed
      */

framework/db/Command.php

Doc Comments +2 added lines, -2 removed lines

@@ -242,7 +242,7 @@ 
 
     /**
      * Binds a parameter to the SQL statement to be executed.
-     * @param string|int $name parameter identifier. For a prepared statement
+     * @param string $name parameter identifier. For a prepared statement
      * using named placeholders, this will be a parameter name of
      * the form `:name`. For a prepared statement using question mark
      * placeholders, this will be the 1-indexed position of the parameter.
@@ -379,7 +379,7 @@ 
     /**
      * Executes the SQL statement and returns the value of the first column in the first row of data.
      * This method is best used when only a single value is needed for a query.
-     * @return string|null|false the value of the first column in the first row of the query result.
+     * @return string the value of the first column in the first row of the query result.
      * False is returned if there is no value.
      * @throws Exception execution failed
      */