Added `yii\console\Controller::EXIT_CODE_NORMAL` and…

framework/CHANGELOG.md

@@ -45,6 +45,8 @@ Yii Framework 2 Change Log
 - Enh: Supported adding a new response formatter without the need to reconfigure existing formatters (qiangxue)
 - Enh: Added `yii\web\UrlManager::addRules()` to simplify adding new URL rules (qiangxue)
 - Enh: Added support to insert an event handler at the beginning of class-level event handler queue (qiangxue)
+- Enh: Added `yii\console\Controller::EXIT_CODE_NORMAL` and `yii\console\Controller::EXIT_CODE_ERROR` constants (samdark)
+- Enh: `yii\console\MigrateController` now returns `yii\console\Controller::EXIT_CODE_ERROR` in case of failed migration (samdark)
 - Chg #2913: RBAC `DbManager` is now initialized via migration (samdark)
 - Chg #3036: Upgraded Twitter Bootstrap to 3.1.x (qiangxue)
 - Chg #3175: InvalidCallException, InvalidParamException, UnknownMethodException are now extended from SPL BadMethodCallException (samdark)

framework/console/Controller.php

@@ -29,6 +29,9 @@ use yii\helpers\Console;
  */
 class Controller extends \yii\base\Controller
 {
+    const EXIT_CODE_NORMAL = 0;
+    const EXIT_CODE_ERROR = 1;
+
     /**
      * @var boolean whether to run the command interactively.
      */

framework/console/controllers/AssetController.php

@@ -611,7 +611,7 @@ return [
 EOD;
         if (file_exists($configFile)) {
             if (!$this->confirm("File '{$configFile}' already exists. Do you wish to overwrite it?")) {
-                return;
+                return self::EXIT_CODE_NORMAL;
             }
         }
         if (!file_put_contents($configFile, $template)) {

framework/console/controllers/FixtureController.php

@@ -96,7 +96,7 @@ class FixtureController extends Controller
         }
 
         if (!$this->confirmLoad($foundFixtures, $except)) {
-            return;
+            return self::EXIT_CODE_NORMAL;
         }
 
         $filtered = array_diff($foundFixtures, $except);
@@ -140,7 +140,7 @@ class FixtureController extends Controller
         }
 
         if (!$this->confirmUnload($foundFixtures, $except)) {
-            return;
+            return self::EXIT_CODE_NORMAL;
         }
 
         $filtered = array_diff($foundFixtures, $except);

framework/console/controllers/MessageController.php

@@ -54,7 +54,7 @@ class MessageController extends Controller
         $filePath = Yii::getAlias($filePath);
         if (file_exists($filePath)) {
             if (!$this->confirm("File '{$filePath}' already exists. Do you wish to overwrite it?")) {
-                return;
+                return self::EXIT_CODE_NORMAL;
             }
         }
         copy(Yii::getAlias('@yii/views/messageConfig.php'), $filePath);
@@ -298,7 +298,7 @@ class MessageController extends Controller
             if (array_keys($translated) == $messages) {
                 echo "nothing new...skipped.\n";
 
-                return;
+                return self::EXIT_CODE_NORMAL;
             }
             $merged = [];
             $untranslated = [];

framework/console/controllers/MigrateController.php

@@ -144,6 +144,8 @@ class MigrateController extends Controller
      *
      * @param integer $limit the number of new migrations to be applied. If 0, it means
      * applying all available new migrations.
+     *
+     * @return integer the status of the action execution. 0 means normal, other values mean abnormal.
      */
     public function actionUp($limit = 0)
     {
@@ -151,7 +153,7 @@ class MigrateController extends Controller
         if (empty($migrations)) {
             echo "No new migration found. Your system is up-to-date.\n";
 
-            return;
+            return self::EXIT_CODE_NORMAL;
         }
 
         $total = count($migrations);
@@ -177,7 +179,7 @@ class MigrateController extends Controller
                 if (!$this->migrateUp($migration)) {
                     echo "\nMigration failed. The rest of the migrations are canceled.\n";
 
-                    return;
+                    return self::EXIT_CODE_ERROR;
                 }
             }
             echo "\nMigrated up successfully.\n";
@@ -196,6 +198,8 @@ class MigrateController extends Controller
      * @param integer $limit the number of migrations to be reverted. Defaults to 1,
      * meaning the last applied migration will be reverted.
      * @throws Exception if the number of the steps specified is less than 1.
+     *
+     * @return integer the status of the action execution. 0 means normal, other values mean abnormal.
      */
     public function actionDown($limit = 1)
     {
@@ -208,7 +212,7 @@ class MigrateController extends Controller
         if (empty($migrations)) {
             echo "No migration has been done before.\n";
 
-            return;
+            return self::EXIT_CODE_NORMAL;
         }
         $migrations = array_keys($migrations);
 
@@ -224,7 +228,7 @@ class MigrateController extends Controller
                 if (!$this->migrateDown($migration)) {
                     echo "\nMigration failed. The rest of the migrations are canceled.\n";
 
-                    return;
+                    return self::EXIT_CODE_ERROR;
                 }
             }
             echo "\nMigrated down successfully.\n";
@@ -245,6 +249,8 @@ class MigrateController extends Controller
      * @param integer $limit the number of migrations to be redone. Defaults to 1,
      * meaning the last applied migration will be redone.
      * @throws Exception if the number of the steps specified is less than 1.
+     *
+     * @return integer the status of the action execution. 0 means normal, other values mean abnormal.
      */
     public function actionRedo($limit = 1)
     {
@@ -257,7 +263,7 @@ class MigrateController extends Controller
         if (empty($migrations)) {
             echo "No migration has been done before.\n";
 
-            return;
+            return self::EXIT_CODE_NORMAL;
         }
         $migrations = array_keys($migrations);
 
@@ -273,14 +279,14 @@ class MigrateController extends Controller
                 if (!$this->migrateDown($migration)) {
                     echo "\nMigration failed. The rest of the migrations are canceled.\n";
 
-                    return;
+                    return self::EXIT_CODE_ERROR;
                 }
             }
             foreach (array_reverse($migrations) as $migration) {
                 if (!$this->migrateUp($migration)) {
                     echo "\nMigration failed. The rest of the migrations migrations are canceled.\n";
 
-                    return;
+                    return self::EXIT_CODE_ERROR;
                 }
             }
             echo "\nMigration redone successfully.\n";
@@ -361,7 +367,7 @@ class MigrateController extends Controller
                     echo "The migration history is set at $originalVersion.\nNo actual migration was performed.\n";
                 }
 
-                return;
+                return self::EXIT_CODE_NORMAL;
             }
         }
 
@@ -383,7 +389,7 @@ class MigrateController extends Controller
                     }
                 }
 
-                return;
+                return self::EXIT_CODE_NORMAL;
             }
         }
 
@@ -598,7 +604,7 @@ class MigrateController extends Controller
             if (strpos($migration, $version . '_') === 0) {
                 $this->actionUp($i + 1);
 
-                return;
+                return self::EXIT_CODE_NORMAL;
             }
         }
 
@@ -612,7 +618,7 @@ class MigrateController extends Controller
                     $this->actionDown($i);
                 }
 
-                return;
+                return self::EXIT_CODE_NORMAL;
             }
         }