yiisoft / yii2

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

framework/db/BaseActiveRecord.php

Doc Comments +1 added lines, -1 removed lines

@@ -788,7 +788,7 @@
      * In the above step 1 and 3, events named [[EVENT_BEFORE_DELETE]] and [[EVENT_AFTER_DELETE]]
      * will be raised by the corresponding methods.
      *
-     * @return integer|false the number of rows deleted, or false if the deletion is unsuccessful for some reason.
+     * @return boolean the number of rows deleted, or false if the deletion is unsuccessful for some reason.
      * Note that it is possible the number of rows deleted is 0, even though the deletion execution is successful.
      * @throws StaleObjectException if [[optimisticLock|optimistic locking]] is enabled and the data
      * being deleted is outdated.

framework/db/Query.php

Doc Comments +1 added lines, -1 removed lines

@@ -795,7 +795,7 @@
 
     /**
      * Appends a SQL statement using UNION operator.
-     * @param string|Query $sql the SQL statement to be appended using UNION
+     * @param Query $sql the SQL statement to be appended using UNION
      * @param boolean $all TRUE if using UNION ALL and FALSE if using UNION
      * @return $this the query object itself
      */

framework/console/Controller.php

Doc Comments +4 added lines, -4 removed lines

@@ -186,7 +186,7 @@ 
      * ```
      *
      * @param string $string the string to print
-     * @return integer|boolean Number of bytes printed or false on error
+     * @return integer Number of bytes printed or false on error
      */
     public function stdout($string)
     {
@@ -211,7 +211,7 @@ 
      * ```
      *
      * @param string $string the string to print
-     * @return integer|boolean Number of bytes printed or false on error
+     * @return integer Number of bytes printed or false on error
      */
     public function stderr($string)
     {
@@ -251,7 +251,7 @@ 
      *
      * @param string $message to echo out before waiting for user input
      * @param boolean $default this value is returned if no selection is made.
-     * @return boolean whether user confirmed.
+     * @return boolean|null whether user confirmed.
      * Will return true if [[interactive]] is false.
      */
     public function confirm($message, $default = false)
@@ -287,7 +287,7 @@ 
      * until [[beforeAction()]] is being called.
      *
      * @param string $actionID the action id of the current request
-     * @return array the names of the options valid for the action
+     * @return string[] the names of the options valid for the action
      */
     public function options($actionID)
     {

framework/console/controllers/MessageController.php

Doc Comments +1 added lines, -1 removed lines

@@ -574,7 +574,7 @@
      * Finds out a line of the first non-char PHP token found
      *
      * @param array $tokens
-     * @return integer|string
+     * @return string
      * @since 2.0.1
      */
     protected function getLine($tokens)

framework/helpers/BaseConsole.php

Doc Comments +7 added lines, -7 removed lines

@@ -575,7 +575,7 @@ 
      * - windows without ansicon
      * - not tty consoles
      *
-     * @param mixed $stream
+     * @param resource $stream
      * @return boolean true if the stream supports ANSI colors, otherwise false.
      */
     public static function streamSupportsAnsiColors($stream)
@@ -600,7 +600,7 @@ 
      * @param boolean $refresh whether to force checking and not re-use cached size value.
      * This is useful to detect changing window size while the application is running but may
      * not get up to date values on every terminal.
-     * @return array|boolean An array of ($width, $height) or false when it was not able to determine size.
+     * @return string An array of ($width, $height) or false when it was not able to determine size.
      */
     public static function getScreenSize($refresh = false)
     {
@@ -691,7 +691,7 @@ 
      * Prints a string to STDOUT.
      *
      * @param string $string the string to print
-     * @return integer|boolean Number of bytes printed or false on error
+     * @return integer Number of bytes printed or false on error
      */
     public static function stdout($string)
     {
@@ -702,7 +702,7 @@ 
      * Prints a string to STDERR.
      *
      * @param string $string the string to print
-     * @return integer|boolean Number of bytes printed or false on error
+     * @return integer Number of bytes printed or false on error
      */
     public static function stderr($string)
     {
@@ -729,7 +729,7 @@ 
      * Prints text to STDOUT appended with a carriage return (PHP_EOL).
      *
      * @param string $string the text to print
-     * @return integer|boolean number of bytes printed or false on error.
+     * @return integer number of bytes printed or false on error.
      */
     public static function output($string = null)
     {
@@ -740,7 +740,7 @@ 
      * Prints text to STDERR appended with a carriage return (PHP_EOL).
      *
      * @param string $string the text to print
-     * @return integer|boolean number of bytes printed or false on error.
+     * @return integer number of bytes printed or false on error.
      */
     public static function error($string = null)
     {
@@ -806,7 +806,7 @@ 
      *
      * @param string $message to print out before waiting for user input
      * @param boolean $default this value is returned if no selection is made.
-     * @return boolean whether user confirmed
+     * @return boolean|null whether user confirmed
      */
     public static function confirm($message, $default = false)
     {

framework/behaviors/AttributeBehavior.php

Doc Comments +1 added lines, -1 removed lines

@@ -126,7 +126,7 @@
      * This method is called by [[evaluateAttributes()]]. Its return value will be assigned
      * to the attributes corresponding to the triggering event.
      * @param Event $event the event that triggers the current attribute updating.
-     * @return mixed the attribute value
+     * @return string the attribute value
      */
     protected function getValue($event)
     {

build/controllers/PhpDocController.php

Doc Comments +24 added lines, -2 removed lines

@@ -114,6 +114,9 @@ 
         return array_merge(parent::options($actionID), ['updateFiles', 'skipFrameworkRequirements']);
     }
 
+    /**
+     * @param string|null $root
+     */
     protected function findFiles($root, $needsInclude = true)
     {
         $except = [];
@@ -237,6 +240,9 @@ 
         return FileHelper::findFiles($root, $options);
     }
 
+    /**
+     * @param string $extensionPath
+     */
     private function setUpExtensionAliases($extensionPath)
     {
         foreach (scandir($extensionPath) as $extension) {
@@ -344,6 +350,9 @@ 
         }
     }
 
+    /**
+     * @param string $line
+     */
     protected function fixParamTypes($line)
     {
         return preg_replace_callback('~@(param|return) ([\w\\|]+)~i', function($matches) {
@@ -477,6 +486,10 @@ 
         // TODO
     }
 
+    /**
+     * @param null|string $className
+     * @param string $propertyDoc
+     */
     protected function updateClassPropertyDocs($file, $className, $propertyDoc)
     {
         $ref = new \ReflectionClass($className);
@@ -552,7 +565,7 @@ 
     /**
      * remove multi empty lines and trim trailing whitespace
      *
-     * @param $doc
+     * @param string $doc
      * @return string
      */
     protected function cleanDocComment($doc)
@@ -571,7 +584,7 @@ 
 
     /**
      * Replace property annotations in doc comment
-     * @param $doc
+     * @param string $doc
      * @param $properties
      * @return string
      */
@@ -739,6 +752,9 @@ 
         return [$className, $phpdoc];
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function match($pattern, $subject, $split = false)
     {
         $sets = [];
@@ -760,6 +776,9 @@ 
         return $sets;
     }
 
+    /**
+     * @param string $str
+     */
     protected function fixSentence($str)
     {
         // TODO fix word wrap
@@ -768,6 +787,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 +23 added lines, -1 removed lines

@@ -322,7 +322,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 = [])
@@ -486,6 +486,10 @@ 
 
     }
 
+    /**
+     * @param string $name
+     * @param string $path
+     */
     protected function releaseApplication($name, $path, $version)
     {
         $this->stdout("\n");
@@ -584,6 +588,9 @@ 
         Yii::setAlias('@app', $this->_oldAlias);
     }
 
+    /**
+     * @param string $name
+     */
     protected function packageApplication($name, $version, $packagePath)
     {
         FileHelper::createDirectory($packagePath);
@@ -741,6 +748,9 @@ 
     }
 
 
+    /**
+     * @param string[] $what
+     */
     protected function closeChangelogs($what, $version)
     {
         $v = str_replace('\\-', '[\\- ]', preg_quote($version, '/'));
@@ -752,6 +762,9 @@ 
         );
     }
 
+    /**
+     * @param string[] $what
+     */
     protected function openChangelogs($what, $version)
     {
         $headline = "\n$version under development\n";
@@ -768,6 +781,9 @@ 
         }
     }
 
+    /**
+     * @param string[] $what
+     */
     protected function resortChangelogs($what, $version)
     {
         foreach($this->getChangelogs($what) as $file) {
@@ -902,6 +918,9 @@ 
             $frameworkPath . '/BaseYii.php');
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function sed($pattern, $replace, $files)
     {
         foreach((array) $files as $file) {
@@ -934,6 +953,9 @@ 
     const MINOR = 'minor';
     const PATCH = 'patch';
 
+    /**
+     * @param string $type
+     */
     protected function getNextVersions(array $versions, $type)
     {
         foreach($versions as $k => $v) {