Add option to generate return type declarations for relation methods

Author: finiteinfinity

config/models.php

@@ -421,6 +421,18 @@
         |
         */
         'fillable_in_base_files' => false,
+
+        /*
+        |--------------------------------------------------------------------------
+        | Generate return types for relation methods.
+        |--------------------------------------------------------------------------
+        | When enable_return_types is set to true, return type declarations are added
+        | to all generated relation methods for your models.
+        |
+        | NOTE: This requires PHP 7.0 or later.
+        |
+        */
+        'enable_return_types' => false,
     ],
 
     /*

src/Coders/Model/Factory.php

@@ -7,12 +7,12 @@
 
 namespace Reliese\Coders\Model;
 
+use Illuminate\Database\DatabaseManager;
+use Illuminate\Filesystem\Filesystem;
 use Illuminate\Support\Str;
 use Reliese\Meta\Blueprint;
-use Reliese\Support\Classify;
 use Reliese\Meta\SchemaManager;
-use Illuminate\Filesystem\Filesystem;
-use Illuminate\Database\DatabaseManager;
+use Reliese\Support\Classify;
 
 class Factory
 {
@@ -480,7 +480,14 @@ protected function body(Model $model)
         }
 
         foreach ($model->getRelations() as $constraint) {
-            $body .= $this->class->method($constraint->name(), $constraint->body(), ['before' => "\n"]);
+            $body .= $this->class->method(
+                $constraint->name(),
+                $constraint->body(),
+                [
+                    'before' => "\n",
+                    'returnType' => $model->definesReturnTypes() ? $constraint->returnType() : null,
+                ]
+            );
         }
 
         // Make sure there not undesired line breaks

src/Coders/Model/Model.php

@@ -162,6 +162,11 @@ class Model
      */
     protected $relationNameStrategy = '';
 
+    /**
+     * @var bool
+     */
+    protected $definesReturnTypes = false;
+
     /**
      * ModelClass constructor.
      *
@@ -210,6 +215,8 @@ protected function configure()
         // Relation name settings
         $this->withRelationNameStrategy($this->config('relation_name_strategy', $this->getDefaultRelationNameStrategy()));
 
+        $this->definesReturnTypes = $this->config('enable_return_types', false);
+
         return $this;
     }
 
@@ -1249,4 +1256,12 @@ public function fillableInBaseFiles(): bool
     {
         return $this->config('fillable_in_base_files', false);
     }
+
+    /**
+     * @return bool
+     */
+    public function definesReturnTypes()
+    {
+        return $this->definesReturnTypes;
+    }
 }

src/Coders/Model/Relation.php

@@ -23,4 +23,9 @@ public function name();
      * @return string
      */
     public function body();
+
+    /**
+     * @return string
+     */
+    public function returnType();
 }

src/Coders/Model/Relations/BelongsTo.php

@@ -127,6 +127,14 @@ public function hint()
         return $base;
     }
 
+    /**
+     * @return string
+     */
+    public function returnType()
+    {
+        return \Illuminate\Database\Eloquent\Relations\BelongsTo::class;
+    }
+
     /**
      * @return bool
      */

src/Coders/Model/Relations/BelongsToMany.php

@@ -136,6 +136,14 @@ public function body()
         return $body;
     }
 
+    /**
+     * @return string
+     */
+    public function returnType()
+    {
+        return \Illuminate\Database\Eloquent\Relations\BelongsToMany::class;
+    }
+
     /**
      * @return bool
      */

src/Coders/Model/Relations/HasMany.php

@@ -58,4 +58,12 @@ public function method()
     {
         return 'hasMany';
     }
+
+    /**
+     * @return string
+     */
+    public function returnType()
+    {
+        return \Illuminate\Database\Eloquent\Relations\HasMany::class;
+    }
 }

src/Coders/Model/Relations/HasOne.php

@@ -38,4 +38,12 @@ public function method()
     {
         return 'hasOne';
     }
+
+    /**
+     * @return string
+     */
+    public function returnType()
+    {
+        return \Illuminate\Database\Eloquent\Relations\HasOne::class;
+    }
 }

src/Coders/Model/Relations/HasOneOrManyStrategy.php

@@ -60,4 +60,14 @@ public function body()
     {
         return $this->relation->body();
     }
+
+    /**
+     * @return string
+     */
+    public function returnType()
+    {
+        return get_class($this->relation) === HasMany::class ?
+            \Illuminate\Database\Eloquent\Relations\HasMany::class :
+            \Illuminate\Database\Eloquent\Relations\HasOne::class;
+    }
 }

src/Support/Classify.php

@@ -67,8 +67,10 @@ public function field($name, $value, $options = [])
     public function method($name, $body, $options = [])
     {
         $visibility = Arr::get($options, 'visibility', 'public');
+        $returnType = Arr::get($options, 'returnType', null);
+        $formattedReturnType = $returnType ? ': '.$returnType : '';
 
-        return "\n\t$visibility function $name()\n\t{\n\t\t$body\n\t}\n";
+        return "\n\t$visibility function $name()$formattedReturnType\n\t{\n\t\t$body\n\t}\n";
     }
 
     public function mixin($class)