yiisoft / yii2

framework/log/Logger.php

Doc Comments +3 added lines, -3 removed lines

@@ -128,7 +128,7 @@ 
      * Logs a message with the given type and category.
      * If [[traceLevel]] is greater than 0, additional call stack information about
      * the application code will be logged as well.
-     * @param string|array $message the message to be logged. This can be a simple string or a more
+     * @param string $message the message to be logged. This can be a simple string or a more
      * complex data structure that will be handled by a [[Target|log target]].
      * @param integer $level the level of the message. This must be one of the following:
      * `Logger::LEVEL_ERROR`, `Logger::LEVEL_WARNING`, `Logger::LEVEL_INFO`, `Logger::LEVEL_TRACE`,
@@ -193,7 +193,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'.
@@ -242,7 +242,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/log/SyslogTarget.php

Doc Comments +1 added lines

@@ -54,6 +54,7 @@
 
     /**
      * @inheritdoc
+     * @return string
      */
     public function formatMessage($message)
     {

framework/requirements/YiiRequirementChecker.php

Doc Comments +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
      * Check the given requirements, collecting results into internal field.
      * This method can be invoked several times checking different requirement sets.
      * Use [[getResult()]] or [[render()]] to get the results.
-     * @param array|string $requirements requirements to be checked.
+     * @param string $requirements requirements to be checked.
      * If an array, it is treated as the set of requirements;
      * If a string, it is treated as the path of the file, which contains the requirements;
      * @return $this self instance.

framework/validators/DateValidator.php

Doc Comments +1 added lines, -1 removed lines

@@ -244,7 +244,7 @@
      * Parses date string into UNIX timestamp
      *
      * @param string $value string representing date
-     * @return integer|false a UNIX timestamp or `false` on failure.
+     * @return integer a UNIX timestamp or `false` on failure.
      */
     protected function parseDateValue($value)
     {

framework/web/AssetManager.php

Doc Comments +3 added lines, -3 removed lines

@@ -326,7 +326,7 @@ 
      * Returns the actual file path for the specified asset.
      * @param AssetBundle $bundle the asset bundle which the asset file belongs to
      * @param string $asset the asset path. This should be one of the assets listed in [[js]] or [[css]].
-     * @return string|boolean the actual file path, or false if the asset is specified as an absolute URL
+     * @return string|false the actual file path, or false if the asset is specified as an absolute URL
      */
     public function getAssetPath($bundle, $asset)
     {
@@ -462,7 +462,7 @@ 
     /**
      * Publishes a file.
      * @param string $src the asset file to be published
-     * @return array the path and the URL that the asset is published as.
+     * @return string[] the path and the URL that the asset is published as.
      * @throws InvalidParamException if the asset to be published does not exist.
      */
     protected function publishFile($src)
@@ -507,7 +507,7 @@ 
      *   it is found in the target directory. This option is used only when publishing a directory.
      *   This overrides [[forceCopy]] if set.
      *
-     * @return array the path directory and the URL that the asset is published as.
+     * @return string[] the path directory and the URL that the asset is published as.
      * @throws InvalidParamException if the asset to be published does not exist.
      */
     protected function publishDirectory($src, $options)

framework/web/Request.php

Doc Comments +1 added lines, -1 removed lines

@@ -426,7 +426,7 @@
      * If the parameter does not exist, the second parameter passed to this method will be returned.
      * @param string $name the parameter name
      * @param mixed $defaultValue the default parameter value if the parameter does not exist.
-     * @return mixed the parameter value
+     * @return string the parameter value
      * @see getBodyParams()
      * @see setBodyParams()
      */

framework/web/Response.php

Doc Comments +1 added lines, -1 removed lines

@@ -726,7 +726,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

@@ -163,7 +163,7 @@ 
      * stored in session and reconstruct the corresponding identity object, if it has not done so before.
      * @param boolean $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()
@@ -254,7 +254,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/widgets/LinkPager.php

Doc Comments +1 added lines, -1 removed lines

@@ -224,7 +224,7 @@
     }
 
     /**
-     * @return array the begin and end pages that need to be displayed.
+     * @return integer[] the begin and end pages that need to be displayed.
      */
     protected function getPageRange()
     {