feat: add relations return type

refs: #204

Author: Ni Nelli

src/Generators/ModelGenerator.php

@@ -87,6 +87,8 @@ public function prepareRelatedModels(): void
                     'entity' => $this->model,
                 ]);
 
+                $this->insertImport($content, 'Illuminate\Database\Eloquent\Relations\\' . Str::ucfirst($types[$type]));
+
                 $fixedContent = preg_replace('/\}$/', "\n    {$newRelation}\n}", $content);
 
                 $this->saveClass('models', $relation, $fixedContent);
@@ -169,11 +171,13 @@ protected function getImportedRelations(): array
     {
         $result = [];
 
-        foreach ($this->relations as $relations) {
+        foreach ($this->relations as $relationName => $relations) {
             foreach ($relations as $relation) {
                 if ($this->shouldImportRelation($relation)) {
                     $result[] = $this->generateClassNamespace($relation);
                 }
+
+                $result[] = 'Illuminate\Database\Eloquent\Relations\\' . Str::ucfirst($relationName);
             }
         }
 

stubs/relation.blade.php

@@ -1,4 +1,4 @@
-    public function {{ $name }}()
+    public function {{ $name }}(): {{ Str::ucfirst($type) }}
     {
         return $this->{{ $type }}({{ $entity }}::class);
     }

tests/fixtures/ModelGeneratorTest/comment_relation_model.php

@@ -2,6 +2,7 @@
 
 namespace RonasIT\Support\Tests\Support\Models;
 
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Model;
 use RonasIT\Support\Traits\ModelTrait;
 
@@ -23,7 +24,7 @@ public function some_relation()
     {
     }
 
-    public function post()
+    public function post(): BelongsTo
     {
         return $this->belongsTo(Post::class);
     }

tests/fixtures/ModelGeneratorTest/new_model.php

@@ -4,6 +4,8 @@
 
 use Illuminate\Database\Eloquent\Model;
 use RonasIT\Support\Traits\ModelTrait;
+use Illuminate\Database\Eloquent\Relations\HasOne;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use Carbon\Carbon;
 
 /**
@@ -53,12 +55,12 @@ class Post extends Model
         'meta' => 'array',
     ];
 
-    public function comment()
+    public function comment(): HasOne
     {
         return $this->hasOne(Comment::class);
     }
 
-    public function users()
+    public function users(): HasMany
     {
         return $this->hasMany(User::class);
     }

tests/fixtures/ModelGeneratorTest/new_model_with_many_relations.php

@@ -5,6 +5,8 @@
 use Illuminate\Database\Eloquent\Model;
 use RonasIT\Support\Traits\ModelTrait;
 use App\Models\User;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 
 //TODO: add @property annotation for each model's field
 /**
@@ -18,12 +20,12 @@ class Post extends Model
 
     protected $hidden = ['pivot'];
 
-    public function users()
+    public function users(): HasMany
     {
         return $this->hasMany(User::class);
     }
 
-    public function users()
+    public function users(): BelongsToMany
     {
         return $this->belongsToMany(User::class);
     }

tests/fixtures/ModelGeneratorTest/new_model_with_subfolers_relations.php

@@ -5,6 +5,7 @@
 use Illuminate\Database\Eloquent\Model;
 use RonasIT\Support\Traits\ModelTrait;
 use App\Models\Forum\Author;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 
 /**
  * @property string $title
@@ -19,7 +20,7 @@ class Post extends Model
 
     protected $hidden = ['pivot'];
 
-    public function authors()
+    public function authors(): HasMany
     {
         return $this->hasMany(Author::class);
     }

tests/fixtures/ModelGeneratorTest/new_subfolders_model.php

@@ -5,7 +5,9 @@
 use Illuminate\Database\Eloquent\Model;
 use RonasIT\Support\Traits\ModelTrait;
 use App\Models\Comment;
+use Illuminate\Database\Eloquent\Relations\HasOne;
 use App\Models\User;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use Carbon\Carbon;
 
 /**
@@ -55,12 +57,12 @@ class Post extends Model
         'meta' => 'array',
     ];
 
-    public function comment()
+    public function comment(): HasOne
     {
         return $this->hasOne(Comment::class);
     }
 
-    public function users()
+    public function users(): HasMany
     {
         return $this->hasMany(User::class);
     }