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) {
@@ -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)
     {

framework/validators/Validator.php

Doc Comments +1 added lines, -1 removed lines

@@ -288,7 +288,7 @@
     /**
      * Validates a given value.
      * You may use this method to validate a value out of the context of a data model.
-     * @param mixed $value the data value to be validated.
+     * @param string|null $value the data value to be validated.
      * @param string $error the error message to be returned, if the validation fails.
      * @return bool whether the data is valid.
      */