yiisoft / yii2

build/controllers/PhpDocController.php

Doc Comments +20 added lines, -2 removed lines

@@ -113,6 +113,9 @@ 
         return array_merge(parent::options($actionID), ['updateFiles', 'skipFrameworkRequirements']);
     }
 
+    /**
+     * @param string|null $root
+     */
     protected function findFiles($root, $needsInclude = true)
     {
         $except = [];
@@ -233,6 +236,9 @@ 
         return FileHelper::findFiles($root, $options);
     }
 
+    /**
+     * @param string $extensionPath
+     */
     private function setUpExtensionAliases($extensionPath)
     {
         foreach (scandir($extensionPath) as $extension) {
@@ -340,6 +346,9 @@ 
         }
     }
 
+    /**
+     * @param string $line
+     */
     protected function fixParamTypes($line)
     {
         return preg_replace_callback('~@(param|return) ([\w\\|]+)~i', function ($matches) {
@@ -553,7 +562,7 @@ 
     /**
      * remove multi empty lines and trim trailing whitespace
      *
-     * @param $doc
+     * @param string $doc
      * @return string
      */
     protected function cleanDocComment($doc)
@@ -572,7 +581,7 @@ 
 
     /**
      * Replace property annotations in doc comment
-     * @param $doc
+     * @param string $doc
      * @param $properties
      * @return string
      */
@@ -739,6 +748,9 @@ 
         return [$className, $phpdoc];
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function match($pattern, $subject, $split = false)
     {
         $sets = [];
@@ -762,6 +774,9 @@ 
         return $sets;
     }
 
+    /**
+     * @param string $str
+     */
     protected function fixSentence($str)
     {
         // TODO fix word wrap
@@ -771,6 +786,9 @@ 
         return strtoupper(substr($str, 0, 1)) . substr($str, 1) . ($str[strlen($str) - 1] != '.' ? '.' : '');
     }
 
+    /**
+     * @param string $param
+     */
     protected function getPropParam($prop, $param)
     {
         return isset($prop['property']) ? $prop['property'][$param] : (isset($prop['get']) ? $prop['get'][$param] : $prop['set'][$param]);

build/controllers/ReleaseController.php

Doc Comments +21 added lines, -1 removed lines

@@ -366,7 +366,7 @@ 
 
     /**
      * @param array $what list of items
-     * @param array $limit list of things to allow, or empty to allow any, can be `app`, `framework`, `extension`
+     * @param string[] $limit list of things to allow, or empty to allow any, can be `app`, `framework`, `extension`
      * @throws \yii\base\Exception
      */
     protected function validateWhat(array $what, $limit = [], $ensureGitClean = true)
@@ -545,6 +545,10 @@ 
         $this->stdout("\n");
     }
 
+    /**
+     * @param string $name
+     * @param string $path
+     */
     protected function releaseApplication($name, $path, $version)
     {
         $this->stdout("\n");
@@ -647,6 +651,9 @@ 
         Yii::setAlias('@app', $this->_oldAlias);
     }
 
+    /**
+     * @param string $name
+     */
     protected function packageApplication($name, $version, $packagePath)
     {
         FileHelper::createDirectory($packagePath);
@@ -808,6 +815,9 @@ 
     }
 
 
+    /**
+     * @param string[] $what
+     */
     protected function closeChangelogs($what, $version)
     {
         $v = str_replace('\\-', '[\\- ]', preg_quote($version, '/'));
@@ -819,6 +829,9 @@ 
         );
     }
 
+    /**
+     * @param string[] $what
+     */
     protected function openChangelogs($what, $version)
     {
         $headline = "\n$version under development\n";
@@ -880,6 +893,7 @@ 
 
     /**
      * Ensure sorting of the changelog lines
+     * @param string[] $changelog
      */
     protected function resortChangelog($changelog)
     {
@@ -975,6 +989,9 @@ 
             $frameworkPath . '/BaseYii.php');
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function sed($pattern, $replace, $files)
     {
         foreach ((array) $files as $file) {
@@ -1007,6 +1024,9 @@ 
     const MINOR = 'minor';
     const PATCH = 'patch';
 
+    /**
+     * @param string $type
+     */
     protected function getNextVersions(array $versions, $type)
     {
         foreach ($versions as $k => $v) {

framework/helpers/BaseArrayHelper.php

Doc Comments +4 added lines, -4 removed lines

@@ -446,7 +446,7 @@ 
      * ```
      *
      * @param array $array the array that needs to be indexed or grouped
-     * @param string|\Closure|null $key the column name or anonymous function which result will be used to index the array
+     * @param null|string $key the column name or anonymous function which result will be used to index the array
      * @param string|string[]|\Closure[]|null $groups the array of keys, that will be used to group the input array
      * by one or more keys. If the $key attribute or its value for the particular element is null and $groups is not
      * defined, the array element will be discarded. Otherwise, if $groups is specified, array element will be added
@@ -566,8 +566,8 @@ 
      * ```
      *
      * @param array $array
-     * @param string|\Closure $from
-     * @param string|\Closure $to
+     * @param string $from
+     * @param string $to
      * @param string|\Closure $group
      * @return array
      */
@@ -622,7 +622,7 @@ 
      * To sort by multiple keys, provide an array of keys here.
      * @param int|array $direction the sorting direction. It can be either `SORT_ASC` or `SORT_DESC`.
      * When sorting by multiple keys with different sorting directions, use an array of sorting directions.
-     * @param int|array $sortFlag the PHP sort flag. Valid values include
+     * @param integer $sortFlag the PHP sort flag. Valid values include
      * `SORT_REGULAR`, `SORT_NUMERIC`, `SORT_STRING`, `SORT_LOCALE_STRING`, `SORT_NATURAL` and `SORT_FLAG_CASE`.
      * Please refer to [PHP manual](http://php.net/manual/en/function.sort.php)
      * for more details. When sorting by multiple keys with different sort flags, use an array of sort flags.

framework/web/CacheSession.php

Doc Comments +1 added lines, -1 removed lines

@@ -113,7 +113,7 @@
     /**
      * Generates a unique key used for storing session data in cache.
      * @param string $id session variable name
-     * @return mixed a safe cache key associated with the session variable name
+     * @return string[] a safe cache key associated with the session variable name
      */
     protected function calculateKey($id)
     {

framework/caching/Cache.php

Doc Comments +3 added lines, -3 removed lines

@@ -202,7 +202,7 @@ 
      * expiration time will be replaced with the new ones, respectively.
      *
      * @param array $items the items to be cached, as key-value pairs.
-     * @param null|int|\DateInterval $ttl the TTL value of this item. If not set, default value is used.
+     * @param integer $ttl the TTL value of this item. If not set, default value is used.
      * @param Dependency $dependency dependency of the cached items. If the dependency changes,
      * the corresponding values in the cache will be invalidated when it is fetched via [[get()]].
      * This parameter is ignored if [[serializer]] is false.
@@ -245,7 +245,7 @@ 
      * If the cache already contains such a key, the existing value and expiration time will be preserved.
      *
      * @param array $values the items to be cached, as key-value pairs.
-     * @param null|int|\DateInterval $ttl the TTL value of this item. If not set, default value is used.
+     * @param integer $ttl the TTL value of this item. If not set, default value is used.
      * @param Dependency $dependency dependency of the cached items. If the dependency changes,
      * the corresponding values in the cache will be invalidated when it is fetched via [[get()]].
      * This parameter is ignored if [[serializer]] is false.
@@ -308,7 +308,7 @@ 
 
     /**
      * Deletes a value with the specified key from cache
-     * @param mixed $key a key identifying the value to be deleted from cache. This can be a simple string or
+     * @param string $key a key identifying the value to be deleted from cache. This can be a simple string or
      * a complex data structure consisting of factors representing the key.
      * @return bool if no error happens during deletion
      */

framework/caching/TagDependency.php

Doc Comments +1 added lines, -1 removed lines

@@ -69,7 +69,7 @@
     /**
      * Invalidates all of the cached data items that are associated with any of the specified [[tags]].
      * @param \Psr\SimpleCache\CacheInterface $cache the cache component that caches the data items
-     * @param string|array $tags
+     * @param string $tags
      */
     public static function invalidate($cache, $tags)
     {

framework/http/MessageTrait.php

Doc Comments +2 added lines, -2 removed lines

@@ -218,7 +218,7 @@ 
      * This method retains the immutability of the message and returns an instance that has the
      * new and/or updated header and value.
      * @param string $name Case-insensitive header field name.
-     * @param string|string[] $value Header value(s).
+     * @param string $value Header value(s).
      * @return static
      * @throws \InvalidArgumentException for invalid header names or values.
      */
@@ -288,7 +288,7 @@ 
 
     /**
      * Specifies message body.
-     * @param StreamInterface|\Closure|array $body stream instance or its DI compatible configuration.
+     * @param StreamInterface|null $body stream instance or its DI compatible configuration.
      */
     public function setBody($body)
     {

framework/http/Uri.php

Doc Comments +2 added lines, -2 removed lines

@@ -269,7 +269,7 @@ 
 
     /**
      * Specifies query string.
-     * @param string|array|object $query the query string or array of query parameters.
+     * @param string $query the query string or array of query parameters.
      */
     public function setQuery($query)
     {
@@ -407,7 +407,7 @@ 
 
     /**
      * @param string $name URI component name.
-     * @param mixed $default default value, which should be returned in case component is not exist.
+     * @param string $default default value, which should be returned in case component is not exist.
      * @return mixed URI component value.
      */
     protected function getComponent($name, $default = null)

framework/web/Request.php

Doc Comments +2 added lines, -2 removed lines

@@ -346,7 +346,7 @@ 
 
     /**
      * Specifies the URI instance.
-     * @param UriInterface|\Closure|array $uri URI instance or its DI compatible configuration.
+     * @param UriInterface $uri URI instance or its DI compatible configuration.
      * @since 2.1.0
      */
     public function setUri($uri)
@@ -575,7 +575,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()
      */