yiisoft / yii2

framework/db/Command.php

Doc Comments +2 added lines, -2 removed lines

@@ -242,7 +242,7 @@ 
 
     /**
      * Binds a parameter to the SQL statement to be executed.
-     * @param string|int $name parameter identifier. For a prepared statement
+     * @param string $name parameter identifier. For a prepared statement
      * using named placeholders, this will be a parameter name of
      * the form `:name`. For a prepared statement using question mark
      * placeholders, this will be the 1-indexed position of the parameter.
@@ -379,7 +379,7 @@ 
     /**
      * Executes the SQL statement and returns the value of the first column in the first row of data.
      * This method is best used when only a single value is needed for a query.
-     * @return string|null|false the value of the first column in the first row of the query result.
+     * @return string the value of the first column in the first row of the query result.
      * False is returned if there is no value.
      * @throws Exception execution failed
      */

framework/console/controllers/MessageController.php

Doc Comments +1 added lines, -1 removed lines

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

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/validators/DateValidator.php

Doc Comments +1 added lines, -1 removed lines

@@ -321,7 +321,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/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/db/ActiveQuery.php

Doc Comments +1 added lines, -1 removed lines

@@ -397,7 +397,7 @@
      * not mean, that the relations are populated from the query result. An
      * extra query will still be performed to bring in the related data.
      * Defaults to `true`.
-     * @param string|array $joinType the join type of the relations specified in `$with`.
+     * @param string $joinType the join type of the relations specified in `$with`.
      * When this is a string, it applies to all relations specified in `$with`. Use an array
      * in the format of `relationName => joinType` to specify different join types for different relations.
      * @return $this the query object itself

framework/db/Query.php

Doc Comments +2 added lines, -2 removed lines

@@ -866,7 +866,7 @@ 
 
     /**
      * Sets the GROUP BY part of the query.
-     * @param string|array|ExpressionInterface $columns the columns to be grouped by.
+     * @param string $columns the columns to be grouped by.
      * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
      * The method will automatically quote the column names unless a column contains some parenthesis
      * (which means the column contains a DB expression).
@@ -1069,7 +1069,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 bool $all TRUE if using UNION ALL and FALSE if using UNION
      * @return $this the query object itself
      */

framework/db/Migration.php

Doc Comments +8 added lines, -8 removed lines

@@ -105,7 +105,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()
@@ -134,7 +134,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()
@@ -178,7 +178,7 @@ 
      * Note: Not all DBMS support transactions. And some DB queries cannot be put into a transaction. For some examples,
      * please refer to [implicit commit](http://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html).
      *
-     * @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()
@@ -195,7 +195,7 @@ 
      * Note: Not all DBMS support transactions. And some DB queries cannot be put into a transaction. For some examples,
      * please refer to [implicit commit](http://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html).
      *
-     * @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()
@@ -406,7 +406,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)
     {
@@ -432,9 +432,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
      */
@@ -461,7 +461,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.