yiisoft / yii2

framework/helpers/BaseArrayHelper.php

Doc Comments +3 added lines, -3 removed lines

@@ -459,8 +459,8 @@ 
      * ```
      *
      * @param array $array
-     * @param string|\Closure $from
-     * @param string|\Closure $to
+     * @param string $from
+     * @param string $to
      * @param string|\Closure $group
      * @return array
      */
@@ -515,7 +515,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/helpers/BaseConsole.php

Doc Comments +3 added lines, -3 removed lines

@@ -576,7 +576,7 @@ 
      * - windows without ansicon
      * - not tty consoles
      *
-     * @param mixed $stream
+     * @param resource $stream
      * @return bool true if the stream supports ANSI colors, otherwise false.
      */
     public static function streamSupportsAnsiColors($stream)
@@ -601,7 +601,7 @@ 
      * @param bool $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|bool 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)
     {
@@ -807,7 +807,7 @@ 
      *
      * @param string $message to print out before waiting for user input
      * @param bool $default this value is returned if no selection is made.
-     * @return bool whether user confirmed
+     * @return boolean|null whether user confirmed
      */
     public static function confirm($message, $default = false)
     {

framework/helpers/BaseFileHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -634,7 +634,7 @@
      * @param string $pattern
      * @param bool $caseSensitive
      * @throws \yii\base\InvalidParamException
-     * @return array with keys: (string) pattern, (int) flags, (int|bool) firstWildcard
+     * @return string with keys: (string) pattern, (int) flags, (int|bool) firstWildcard
      */
     private static function parseExcludePattern($pattern, $caseSensitive)
     {

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 int|false a UNIX timestamp or `false` on failure.
+     * @return integer a UNIX timestamp or `false` on failure.
      */
     protected function parseDateValue($value)
     {

framework/base/ErrorHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -194,7 +194,7 @@
      * @param string $message the error message.
      * @param string $file the filename that the error was raised in.
      * @param int $line the line number the error was raised at.
-     * @return bool whether the normal error handler continues.
+     * @return null|false whether the normal error handler continues.
      *
      * @throws ErrorException
      */

framework/console/Controller.php

Doc Comments +1 added lines, -1 removed lines

@@ -284,7 +284,7 @@
      *
      * @param string $message to echo out before waiting for user input
      * @param bool $default this value is returned if no selection is made.
-     * @return bool whether user confirmed.
+     * @return boolean|null whether user confirmed.
      * Will return true if [[interactive]] is false.
      */
     public function confirm($message, $default = false)

framework/i18n/MessageFormatter.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
     /**
      * Get the error code from the last operation
      * @link http://php.net/manual/en/messageformatter.geterrorcode.php
-     * @return string Code of the last error.
+     * @return integer Code of the last error.
      */
     public function getErrorCode()
     {

framework/db/Migration.php

Doc Comments +8 added lines, -8 removed lines

@@ -86,7 +86,7 @@ 
     /**
      * This method contains the logic to be executed when applying this migration.
      * Child classes may override this method to provide actual migration logic.
-     * @return bool return a false value to indicate the migration fails
+     * @return false|null return a false value to indicate the migration fails
      * and should not proceed further. All other return values mean the migration succeeds.
      */
     public function up()
@@ -115,7 +115,7 @@ 
      * This method contains the logic to be executed when removing this migration.
      * The default implementation throws an exception indicating the migration cannot be removed.
      * Child classes may override this method if the corresponding migrations can be removed.
-     * @return bool return a false value to indicate the migration fails
+     * @return false|null return a false value to indicate the migration fails
      * and should not proceed further. All other return values mean the migration succeeds.
      */
     public function down()
@@ -155,7 +155,7 @@ 
      * be enclosed within a DB transaction.
      * Child classes may implement this method instead of [[up()]] if the DB logic
      * needs to be within a transaction.
-     * @return bool return a false value to indicate the migration fails
+     * @return boolean|null return a false value to indicate the migration fails
      * and should not proceed further. All other return values mean the migration succeeds.
      */
     public function safeUp()
@@ -168,7 +168,7 @@ 
      * be enclosed within a DB transaction.
      * Child classes may implement this method instead of [[down()]] if the DB logic
      * needs to be within a transaction.
-     * @return bool return a false value to indicate the migration fails
+     * @return boolean|null return a false value to indicate the migration fails
      * and should not proceed further. All other return values mean the migration succeeds.
      */
     public function safeDown()
@@ -387,7 +387,7 @@ 
      * The method will properly quote the table and column names.
      * @param string $name the name of the primary key constraint.
      * @param string $table the table that the primary key constraint will be added to.
-     * @param string|array $columns comma separated string or array of columns that the primary key will consist of.
+     * @param string[] $columns comma separated string or array of columns that the primary key will consist of.
      */
     public function addPrimaryKey($name, $table, $columns)
     {
@@ -415,9 +415,9 @@ 
      * The method will properly quote the table and column names.
      * @param string $name the name of the foreign key constraint.
      * @param string $table the table that the foreign key constraint will be added to.
-     * @param string|array $columns the name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas or use an array.
+     * @param string $columns the name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas or use an array.
      * @param string $refTable the table that the foreign key references to.
-     * @param string|array $refColumns the name of the column that the foreign key references to. If there are multiple columns, separate them with commas or use an array.
+     * @param string $refColumns the name of the column that the foreign key references to. If there are multiple columns, separate them with commas or use an array.
      * @param string $delete the ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
      * @param string $update the ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
      */
@@ -446,7 +446,7 @@ 
      * Builds and executes a SQL statement for creating a new index.
      * @param string $name the name of the index. The name will be properly quoted by the method.
      * @param string $table the table that the new index will be created for. The table name will be properly quoted by the method.
-     * @param string|array $columns the column(s) that should be included in the index. If there are multiple columns, please separate them
+     * @param string $columns the column(s) that should be included in the index. If there are multiple columns, please separate them
      * by commas or use an array. Each column name will be properly quoted by the method. Quoting will be skipped for column names that
      * include a left parenthesis "(".
      * @param bool $unique whether to add UNIQUE constraint on the created index.

framework/log/Logger.php

Doc Comments +2 added lines, -2 removed lines

@@ -196,7 +196,7 @@ 
      * `$categories` and `$excludeCategories` as parameters to retrieve the
      * results that you are interested in.
      *
-     * @param array $categories list of categories that you are interested in.
+     * @param string[] $categories list of categories that you are interested in.
      * You can use an asterisk at the end of a category to do a prefix match.
      * For example, 'yii\db\*' will match categories starting with 'yii\db\',
      * such as 'yii\db\Connection'.
@@ -246,7 +246,7 @@ 
      * Returns the statistical results of DB queries.
      * The results returned include the number of SQL statements executed and
      * the total time spent.
-     * @return array the first element indicates the number of SQL statements executed,
+     * @return integer[] the first element indicates the number of SQL statements executed,
      * and the second element the total time spent in SQL execution.
      */
     public function getDbProfiling()