rob006 / yii2-dev

framework/log/SyslogTarget.php

Doc Comments +1 added lines

@@ -55,6 +55,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

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

@@ -431,7 +431,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/UrlManager.php

Doc Comments +3 added lines, -3 removed lines

@@ -399,7 +399,7 @@ 
      * @param string $cacheKey generated cache key to store data.
      * @param string $route the route (e.g. `site/index`).
      * @param array $params rule params.
-     * @return boolean|string the created URL
+     * @return string|false the created URL
      * @see createUrl()
      * @since 2.0.8
      */
@@ -420,7 +420,7 @@ 
 
     /**
      * Store rule (e.g. [[UrlRule]]) to internal cache
-     * @param $cacheKey
+     * @param string $cacheKey
      * @param UrlRuleInterface $rule
      * @since 2.0.8
      */
@@ -437,7 +437,7 @@ 
      * Note that unlike [[\yii\helpers\Url::toRoute()]], this method always treats the given route
      * as an absolute route.
      *
-     * @param string|array $params use a string to represent a route (e.g. `site/index`),
+     * @param string[] $params use a string to represent a route (e.g. `site/index`),
      * or an array to represent a route with query parameters (e.g. `['site/index', 'param1' => 'value1']`).
      * @param string $scheme the scheme to use for the url (either `http` or `https`). If not specified
      * the scheme of the current request will be used.

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|boolean 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/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 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()
@@ -266,7 +266,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

@@ -225,7 +225,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()
     {