add FormattedDescription to x-scenarios

Author: siggi-k

src/generator/default/dbmodel.php

@@ -52,7 +52,7 @@ abstract class <?= $model->getClassName() ?> extends \yii\db\ActiveRecord
 <?php if($scenarios = $model->getScenarios()):
 foreach($scenarios as $scenario): ?>
     /**
-     * <?= $scenario['description'] ?>
+     *<?= $scenario['description'] ?>
 
      */
     public const <?= $scenario['const'] ?> = '<?= $scenario['name'] ?>';

src/lib/helpers/FormatHelper.php

@@ -5,15 +5,16 @@
 class FormatHelper
 {
     /**
-     * @param $description
+     * @param string $description
+     * @param int $spacing
      * @return string
      */
-    public static function getFormattedDescription($description): string
+    public static function getFormattedDescription(string $description, int $spacing = 1): string
     {
         $descriptionArr = explode("\n", trim($description));
-        $descriptionArr = array_map(function($item) {
-            return $item !== '' ? ' ' . $item : $item;
+        $descriptionArr = array_map(function ($item) {
+            return $item === '' ? '' : ' ' . $item;
         }, $descriptionArr);
-        return implode("\n *", $descriptionArr);
+        return implode("\n".str_repeat(" ", $spacing)."*", $descriptionArr);
     }
 }

src/lib/items/DbModel.php

@@ -227,9 +227,9 @@ private function getScenariosByOpenapiSchema(): array
 
         foreach ($scenarios as $key => $scenario) {
             $scenarios[$key]['const'] = 'SCENARIO_' . strtoupper($scenario['name']);
-            if (empty($scenario['description'])) {
-                $scenarios[$key]['description'] = 'Scenario ' . $scenario['name'];
-            }
+            $scenarios[$key]['description'] = !empty($scenario['description']) ?
+                FormatHelper::getFormattedDescription($scenario['description'], 5)
+                : ' Scenario ' . $scenario['name'];
         }
 
         return $scenarios;