yiisoft / yii2

framework/web/UrlRule.php

Doc Comments +2 added lines, -2 removed lines

@@ -334,7 +334,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)
     {
@@ -425,7 +425,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/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/Response.php

Doc Comments +1 added lines, -1 removed lines

@@ -789,7 +789,7 @@
      * });
      * ```
      *
-     * @param string|array $url the URL to be redirected to. This can be in one of the following formats:
+     * @param string $url the URL to be redirected to. This can be in one of the following formats:
      *
      * - a string representing a URL (e.g. "http://example.com")
      * - a string representing a URL alias (e.g. "@example.com")

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/widgets/FragmentCache.php

Doc Comments +1 added lines, -1 removed lines

@@ -132,7 +132,7 @@
 
     /**
      * Returns the cached content if available.
-     * @return string|false the cached content. False is returned if valid content is not found in the cache.
+     * @return string|boolean the cached content. False is returned if valid content is not found in the cache.
      */
     public function getCachedContent()
     {

framework/base/Security.php

Doc Comments +3 added lines, -3 removed lines

@@ -136,7 +136,7 @@ 
      * Verifies and decrypts data encrypted with [[encryptByPassword()]].
      * @param string $data the encrypted data to decrypt
      * @param string $password the password to use for decryption
-     * @return bool|string the decrypted data or false on authentication failure
+     * @return false|string the decrypted data or false on authentication failure
      * @see encryptByPassword()
      */
     public function decryptByPassword($data, $password)
@@ -149,7 +149,7 @@ 
      * @param string $data the encrypted data to decrypt
      * @param string $inputKey the input to use for encryption and authentication
      * @param string $info optional context and application specific information, see [[hkdf()]]
-     * @return bool|string the decrypted data or false on authentication failure
+     * @return false|string the decrypted data or false on authentication failure
      * @see encryptByKey()
      */
     public function decryptByKey($data, $inputKey, $info = null)
@@ -216,7 +216,7 @@ 
      * @param string $secret the decryption password or key
      * @param string|null $info context/application specific information, @see encrypt()
      *
-     * @return bool|string the decrypted data or false on authentication failure
+     * @return false|string the decrypted data or false on authentication failure
      * @throws InvalidConfigException on OpenSSL not loaded
      * @throws Exception on OpenSSL error
      * @see encrypt()

framework/db/Command.php

Doc Comments +1 added lines, -1 removed lines

@@ -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
      */

framework/console/controllers/BaseMigrateController.php

Doc Comments +4 added lines, -4 removed lines

@@ -204,7 +204,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.
      *
@@ -266,7 +266,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.
      *
@@ -463,7 +463,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
      */
@@ -507,7 +507,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
      */