Fill in class and property documentation based on Database Comments

yiisoft · Feb 2, 2017 · 5ff79ae · 5ff79ae
1 parent 397c3fd
commit 5ff79ae
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/generators/model/Generator.php b/generators/model/Generator.php
@@ -260,7 +260,11 @@ private function generateProperties($table)
             } else {
                 $type = $columnPhpType;
             }
-            $properties[$column->name] = $type;
+            $properties[$column->name] = [
+                'type' => $type,
+                'name' => $column->name,
+                'comment' => $column->comment,
+            ];
         }
 
         return $properties;

diff --git a/generators/model/default/model.php b/generators/model/default/model.php
@@ -22,10 +22,14 @@
 use Yii;
 
 /**
+<?php if (property_exists($tableSchema, 'comment') && $tableSchema->comment): ?>
+ * <?= strtr($tableSchema->comment, ["\n" => "\n * "]) . "\n" ?>
+<?php else: ?>
  * This is the model class for table "<?= $generator->generateTableName($tableName) ?>".
+<?php endif; ?>
  *
-<?php foreach ($properties as $property => $type): ?>
- * @property <?= "{$type} \${$property}\n" ?>
+<?php foreach ($properties as $property => $data): ?>
+ * @property <?= "{$data['type']} \${$property}\n"  . ($data['comment'] ? ' ' . strtr($data['comment'], ["\n" => ' ']) : '') . "\n" ?>
 <?php endforeach; ?>
 <?php if (!empty($relations)): ?>
  *