ModelClassDescription

Author: siggi-k

src/generator/default/dbmodel.php

@@ -11,10 +11,14 @@
 <?= '<?php' ?>
 
 
+/**
+ * This file is generated by Gii, do not change manually!
+ */
+
 namespace <?= $namespace ?>;
 
 /**
- *<?= empty($model->description) ? '' : str_replace("\n", "\n * ", ' ' . trim($model->description)) ?>
+ *<?= $model->getModelClassDescription() ?>
 
  *
 <?php foreach ($model->dbAttributes() as $attribute): ?>
@@ -48,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/items/DbModel.php

@@ -234,4 +234,25 @@ private function getScenariosByOpenapiSchema(): array
         return $scenarios;
     }
 
+    public function getModelClassDescription_()
+    {
+        return !empty($this->description) ?
+            str_replace("\n", "\n *", ' ' . trim($this->description))
+            : ' This is the model class for table "'.$this->tableName.'".';
+    }
+
+    /** @noinspection PhpParamsInspection */
+    public function getModelClassDescription()
+    {
+        if (empty($this->description)) {
+            return ' This is the model class for table "'.$this->tableName.'".';
+        }
+
+        $descriptionArr = explode("\n", $this->description);
+        $descriptionArr = array_map('trim', $descriptionArr);
+        $descriptionArr = array_map(function($item) {
+            return $item !== '' ? ' ' . $item : $item;
+        }, $descriptionArr);
+        return implode("\n *", $descriptionArr);
+    }
 }