getPropertyAnnotation with FormattedDescription

Author: siggi-k

src/generator/default/dbmodel.php

@@ -22,7 +22,7 @@
 
  *
 <?php foreach ($model->dbAttributes() as $attribute): ?>
- * @property <?= $attribute->getFormattedDescription() ?>
+ * @property <?= $attribute->getPropertyAnnotation() ?>
 
 <?php endforeach; ?>
  *

src/lib/helpers/FormatHelper.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace cebe\yii2openapi\lib\helpers;
+
+class FormatHelper
+{
+    /**
+     * @param $description
+     * @return string
+     */
+    public static function getFormattedDescription($description): string
+    {
+        $descriptionArr = explode("\n", trim($description));
+        $descriptionArr = array_map(function($item) {
+            return $item !== '' ? ' ' . $item : $item;
+        }, $descriptionArr);
+        return implode("\n *", $descriptionArr);
+    }
+}

src/lib/items/Attribute.php

@@ -7,6 +7,7 @@
 
 namespace cebe\yii2openapi\lib\items;
 
+use cebe\yii2openapi\lib\helpers\FormatHelper;
 use yii\helpers\VarDumper;
 use \Yii;
 use cebe\yii2openapi\lib\openapi\PropertySchema;
@@ -295,11 +296,16 @@ public function getMinLength():?int
         return $this->limits['minLength'];
     }
 
-    public function getFormattedDescription():string
+    /**
+     * @return string
+     */
+    public function getPropertyAnnotation(): string
     {
-        $comment = $this->columnName.' '.$this->description;
-        $type = $this->phpType;
-        return $type.' $'.str_replace("\n", "\n * ", rtrim($comment));
+        $annotation = $this->phpType . ' $' . $this->columnName;
+        if (!empty($this->description)) {
+            $annotation .= FormatHelper::getFormattedDescription($this->description);
+        }
+        return $annotation;
     }
 
     public function toColumnSchema():ColumnSchema

src/lib/items/DbModel.php

@@ -7,6 +7,7 @@
 
 namespace cebe\yii2openapi\lib\items;
 
+use cebe\yii2openapi\lib\helpers\FormatHelper;
 use cebe\yii2openapi\lib\ValidationRulesBuilder;
 use Yii;
 use yii\base\BaseObject;
@@ -234,25 +235,14 @@ 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()
+    /**
+     * @return string
+     */
+    public function getModelClassDescription(): string
     {
         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);
+        return FormatHelper::getFormattedDescription($this->description);
     }
 }