Add Class PHPDoc for help IDE

Author: Alex Stoica

src/Generators/ModelGenerator.php

@@ -42,6 +42,7 @@ protected function populateStub(string $stub, Model $model)
     {
         $stub = str_replace('DummyNamespace', $model->fullyQualifiedNamespace(), $stub);
         $stub = str_replace('DummyClass', $model->name(), $stub);
+        $stub = str_replace('/** DummyPHPDocClass **/', $this->buildClassPhpDoc($model), $stub);
 
         $body = $this->buildProperties($model);
         $body .= PHP_EOL . PHP_EOL;
@@ -53,6 +54,19 @@ protected function populateStub(string $stub, Model $model)
         return $stub;
     }
 
+    private function buildClassPhpDoc(Model $model)
+    {
+        $phpDoc = '/**' . PHP_EOL;
+        /** @var Column $column */
+        foreach ($model->columns() as $column) {
+            $phpDoc .= sprintf(' * @property %s $%s', $this->phpDataType($column->dataType()), $column->name());
+            $phpDoc .= PHP_EOL;
+        }
+        $phpDoc .= ' */';
+
+        return $phpDoc;
+    }
+
     private function buildProperties(Model $model)
     {
         $properties = '';
@@ -188,4 +202,46 @@ private function addTraits(Model $model, $stub)
 
         return $stub;
     }
+
+    private function phpDataType(string $dataType)
+    {
+        static $php_data_types = [
+            'id' => 'int',
+            'bigincrements' => 'int',
+            'biginteger' => 'int',
+            'boolean' => 'bool',
+            'date' => '\Carbon\Carbon',
+            'datetime' => '\Carbon\Carbon',
+            'datetimetz' => '\Carbon\Carbon',
+            'decimal' => 'float',
+            'double' => 'double',
+            'float' => 'float',
+            'increments' => 'int',
+            'integer' => 'int',
+            'mediumincrements' => 'int',
+            'mediuminteger' => 'int',
+            'nullabletimestamps' => '\Carbon\Carbon',
+            'smallincrements' => 'int',
+            'smallinteger' => 'int',
+            'softdeletes' => '\Carbon\Carbon',
+            'softdeletestz' => '\Carbon\Carbon',
+            'time' => '\Carbon\Carbon',
+            'timetz' => '\Carbon\Carbon',
+            'timestamp' => '\Carbon\Carbon',
+            'timestamptz' => '\Carbon\Carbon',
+            'timestamps' => '\Carbon\Carbon',
+            'timestampstz' => '\Carbon\Carbon',
+            'tinyincrements' => 'integer',
+            'tinyinteger' => 'int',
+            'unsignedbiginteger' => 'int',
+            'unsigneddecimal' => 'float',
+            'unsignedinteger' => 'int',
+            'unsignedmediuminteger' => 'int',
+            'unsignedsmallinteger' => 'int',
+            'unsignedtinyinteger' => 'int',
+            'year' => 'int',
+        ];
+
+        return $php_data_types[strtolower($dataType)] ?? 'string';
+    }
 }

stubs/model/class.stub

@@ -4,6 +4,7 @@ namespace DummyNamespace;
 
 use Illuminate\Database\Eloquent\Model;
 
+/** DummyPHPDocClass **/
 class DummyClass extends Model
 {
     // ...

tests/fixtures/models/comment.php

@@ -5,6 +5,9 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
+/**
+ * @property integer $id
+ */
 class Comment extends Model
 {
     use SoftDeletes;

tests/fixtures/models/model-configured.php

@@ -4,6 +4,11 @@
 
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * @property integer $id
+ * @property integer $post_id
+ * @property integer $author_id
+ */
 class Comment extends Model
 {
     /**

tests/fixtures/models/nested-components.php

@@ -4,6 +4,10 @@
 
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * @property integer $id
+ * @property string $name
+ */
 class User extends Model
 {
     /**

tests/fixtures/models/readme-example.php

@@ -4,6 +4,12 @@
 
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * @property integer $id
+ * @property string $title
+ * @property string $content
+ * @property Carbon $published_at
+ */
 class Post extends Model
 {
     /**

tests/fixtures/models/relationships.php

@@ -4,6 +4,11 @@
 
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * @property integer $id
+ * @property integer $post_id
+ * @property integer $author_id
+ */
 class Comment extends Model
 {
     /**

tests/fixtures/models/soft-deletes.php

@@ -5,6 +5,10 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
+/**
+ * @property integer $id
+ * @property integer $post_id
+ */
 class Comment extends Model
 {
     use SoftDeletes;

tests/fixtures/models/unconventional.php

@@ -4,6 +4,12 @@
 
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * @property integer $id
+ * @property string $name
+ * @property integer $owner
+ * @property integer $manager
+ */
 class Team extends Model
 {
     /**