yiisoft / yii2

framework/web/UrlManager.php

Doc Comments +3 added lines, -3 removed lines

@@ -452,7 +452,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 bool|string the created URL
+     * @return string|false the created URL
      * @see createUrl()
      * @since 2.0.8
      */
@@ -473,7 +473,7 @@ 
 
     /**
      * Store rule (e.g. [[UrlRule]]) to internal cache.
-     * @param $cacheKey
+     * @param string $cacheKey
      * @param UrlRuleInterface $rule
      * @since 2.0.8
      */
@@ -490,7 +490,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|null $scheme the scheme to use for the URL (either `http`, `https` or empty string
      * for protocol-relative URL).

build/controllers/ReleaseController.php

Doc Comments +20 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`
      * @param bool $ensureGitClean
      * @throws \yii\base\Exception
      */
@@ -546,6 +546,10 @@ 
         $this->stdout("\n");
     }
 
+    /**
+     * @param string $name
+     * @param string $path
+     */
     protected function releaseApplication($name, $path, $version)
     {
         $this->stdout("\n");
@@ -648,6 +652,9 @@ 
         Yii::setAlias('@app', $this->_oldAlias);
     }
 
+    /**
+     * @param string $name
+     */
     protected function packageApplication($name, $version, $packagePath)
     {
         FileHelper::createDirectory($packagePath);
@@ -809,6 +816,9 @@ 
     }
 
 
+    /**
+     * @param string[] $what
+     */
     protected function closeChangelogs($what, $version)
     {
         $v = str_replace('\\-', '[\\- ]', preg_quote($version, '/'));
@@ -820,6 +830,9 @@ 
         );
     }
 
+    /**
+     * @param string[] $what
+     */
     protected function openChangelogs($what, $version)
     {
         $headline = "\n$version under development\n";
@@ -981,6 +994,9 @@ 
             $frameworkPath . '/BaseYii.php');
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function sed($pattern, $replace, $files)
     {
         foreach ((array) $files as $file) {
@@ -1013,6 +1029,9 @@ 
     const MINOR = 'minor';
     const PATCH = 'patch';
 
+    /**
+     * @param string $type
+     */
     protected function getNextVersions(array $versions, $type)
     {
         foreach ($versions as $k => $v) {

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/console/controllers/CacheController.php

Doc Comments +1 added lines, -1 removed lines

@@ -236,7 +236,7 @@
     /**
      * Prompts user with confirmation if caches should be cleared.
      * @param array $cachesNames
-     * @return bool
+     * @return boolean|null
      */
     private function confirmClear($cachesNames)
     {

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) {
@@ -556,7 +565,7 @@ 
     /**
      * remove multi empty lines and trim trailing whitespace.
      *
-     * @param $doc
+     * @param string $doc
      * @return string
      */
     protected function cleanDocComment($doc)
@@ -575,7 +584,7 @@ 
 
     /**
      * Replace property annotations in doc comment.
-     * @param $doc
+     * @param string $doc
      * @param $properties
      * @return string
      */
@@ -742,6 +751,9 @@ 
         return [$className, $phpdoc];
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function match($pattern, $subject, $split = false)
     {
         $sets = [];
@@ -766,6 +778,9 @@ 
         return $sets;
     }
 
+    /**
+     * @param string $str
+     */
     protected function fixSentence($str)
     {
         // TODO fix word wrap
@@ -776,6 +791,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]);

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.
@@ -307,7 +307,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/db/BaseActiveRecord.php

Doc Comments +1 added lines, -1 removed lines

@@ -100,7 +100,7 @@
 
     /**
      * @inheritdoc
-     * @return static|null ActiveRecord instance matching the condition, or `null` if nothing matches.
+     * @return BaseActiveRecord ActiveRecord instance matching the condition, or `null` if nothing matches.
      */
     public static function findOne($condition)
     {

framework/web/MultipartFormDataParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -212,7 +212,7 @@
     /**
      * Parses content part headers.
      * @param string $headerContent headers source content
-     * @return array parsed headers.
+     * @return callable parsed headers.
      */
     private function parseHeaders($headerContent)
     {