yiisoft / yii2

framework/db/Migration.php

Doc Comments +8 added lines, -8 removed lines

@@ -90,7 +90,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()
@@ -119,7 +119,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()
@@ -164,7 +164,7 @@ 
      * please refer to [implicit commit](http://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html). If this is the case,
      * you should still implement `up()` and `down()`, instead.
      *
-     * @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()
@@ -182,7 +182,7 @@ 
      * please refer to [implicit commit](http://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html). If this is the case,
      * you should still implement `up()` and `down()`, instead.
      *
-     * @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()
@@ -401,7 +401,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)
     {
@@ -429,9 +429,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
      */
@@ -460,7 +460,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/db/Command.php

Doc Comments +1 added lines, -1 removed lines

@@ -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/BaseMigrateController.php

Doc Comments +4 added lines, -4 removed lines

@@ -204,7 +204,7 @@ 
      * yii migrate/down all # revert all migrations
      * ```
      *
-     * @param int|string $limit the number of migrations to be reverted. Defaults to 1,
+     * @param integer $limit the number of migrations to be reverted. Defaults to 1,
      * meaning the last applied migration will be reverted. When value is "all", all migrations will be reverted.
      * @throws Exception if the number of the steps specified is less than 1.
      *
@@ -266,7 +266,7 @@ 
      * yii migrate/redo all # redo all migrations
      * ```
      *
-     * @param int|string $limit the number of migrations to be redone. Defaults to 1,
+     * @param integer $limit the number of migrations to be redone. Defaults to 1,
      * meaning the last applied migration will be redone. When equals "all", all migrations will be redone.
      * @throws Exception if the number of the steps specified is less than 1.
      *
@@ -463,7 +463,7 @@ 
      * yii migrate/history all # showing the whole history
      * ```
      *
-     * @param int|string $limit the maximum number of migrations to be displayed.
+     * @param integer $limit the maximum number of migrations to be displayed.
      * If it is "all", the whole migration history will be displayed.
      * @throws \yii\console\Exception if invalid limit value passed
      */
@@ -507,7 +507,7 @@ 
      * yii migrate/new all # showing all new migrations
      * ```
      *
-     * @param int|string $limit the maximum number of new migrations to be displayed.
+     * @param integer $limit the maximum number of new migrations to be displayed.
      * If it is `all`, all available new migrations will be displayed.
      * @throws \yii\console\Exception if invalid limit value passed
      */

framework/db/cubrid/Schema.php

Doc Comments +1 added lines, -1 removed lines

@@ -266,7 +266,7 @@
     /**
      * Loads the column information into a [[ColumnSchema]] object.
      * @param array $info column information
-     * @return ColumnSchema the column schema object
+     * @return \yii\db\ColumnSchema the column schema object
      */
     protected function loadColumnSchema($info)
     {

framework/db/Schema.php

Doc Comments +2 added lines, -2 removed lines

@@ -393,7 +393,7 @@ 
      * Executes the INSERT command, returning primary key values.
      * @param string $table the table that new rows will be inserted into.
      * @param array $columns the column data (name => value) to be inserted into the table.
-     * @return array|false primary key values or false if the command fails
+     * @return string primary key values or false if the command fails
      * @since 2.0.4
      */
     public function insert($table, $columns)
@@ -597,7 +597,7 @@ 
     /**
      * Returns the cache key for the specified table name.
      * @param string $name the table name
-     * @return mixed the cache key
+     * @return string[] the cache key
      */
     protected function getCacheKey($name)
     {

framework/db/pgsql/Schema.php

Doc Comments +1 added lines, -1 removed lines

@@ -266,7 +266,7 @@
     /**
      * Loads the column information into a [[ColumnSchema]] object.
      * @param array $info column information
-     * @return ColumnSchema the column schema object
+     * @return \yii\db\ColumnSchema the column schema object
      */
     protected function loadColumnSchema($info)
     {

framework/db/sqlite/Schema.php

Doc Comments +1 added lines, -1 removed lines

@@ -266,7 +266,7 @@
     /**
      * Loads the column information into a [[ColumnSchema]] object.
      * @param array $info column information
-     * @return ColumnSchema the column schema object
+     * @return \yii\db\ColumnSchema the column schema object
      */
     protected function loadColumnSchema($info)
     {