Implement new config to specify return type of custom relations (#1300)

* Implement new config to specify return type of custom relations

* Apply suggestions from code review

Co-authored-by: Markus Podar <[email protected]>

* add test for morphed

* fix test output

* add info about how to add custom relationships

* fix wording

Co-authored-by: Markus Podar <[email protected]>

CHANGELOG.md

@@ -30,6 +30,7 @@ All notable changes to this project will be documented in this file.
 ### Added
 - Add support for custom casts that using `Castable` [#1287 / binotaliu](https://github.com/barryvdh/laravel-ide-helper/pull/1287)
 - Added Laravel 9 support [#1297 / rcerljenko](https://github.com/barryvdh/laravel-ide-helper/pull/1297)
+- Added option `additional_relation_return_types` for custom relations that don't fit the typical naming scheme
 
 2022-01-03, 2.11.0
 ------------------

README.md

@@ -281,6 +281,26 @@ For those special cases, you can map them via the config `custom_db_types`. Exam
 ],
 ```
 
+#### Custom Relationship Types
+
+If you are using relationships not built into Laravel you will need to specify the name and returning class in the config to get proper generation.
+
+```php
+'additional_relation_types' => [
+    'externalHasMany' => \My\Package\externalHasMany::class
+],
+```
+
+Found relationships will typically generate a return value based on the name of the relationship.
+
+If your custom relationships don't follow this traditional naming scheme you can define its return type manually. The available options are `many` and `morphTo`.
+
+```php
+'additional_relation_return_types' => [
+    'externalHasMultiple' => 'many'
+],
+```
+
 #### Model Hooks
 
 If you need additional information on your model from sources that are not handled by default, you can hook in to the

config/ide-helper.php

@@ -304,6 +304,19 @@ return [
     */
     'additional_relation_types' => [],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Additional relation return types
+    |--------------------------------------------------------------------------
+    |
+    | When using custom relation types its possible for the class name to not contain
+    | the proper return type of the relation. The key of the array is the relationship
+    | method name. The value of the array is the return type of the relation.
+    | e.g. `'relationName' => 'many'`.
+    |
+    */
+    'additional_relation_return_types' => [],
+
     /*
     |--------------------------------------------------------------------------
     | Run artisan commands after migrations to generate model helpers

src/Console/ModelsCommand.php

@@ -702,7 +702,10 @@ class ModelsCommand extends Command
                                     get_class($relationObj->getRelated())
                                 );
 
-                                if (strpos(get_class($relationObj), 'Many') !== false) {
+                                if (
+                                    strpos(get_class($relationObj), 'Many') !== false ||
+                                    ($this->getRelationReturnTypes()[$relation] ?? '') === 'many'
+                                ) {
                                     //Collection or array of models (because Collection is Arrayable)
                                     $relatedClass = '\\' . get_class($relationObj->getRelated());
                                     $collectionClass = $this->getCollectionClass($relatedClass);
@@ -726,7 +729,10 @@ class ModelsCommand extends Command
                                         // What kind of comments should be added to the relation count here?
                                         );
                                     }
-                                } elseif ($relation === 'morphTo') {
+                                } elseif (
+                                    $relation === 'morphTo' ||
+                                    ($this->getRelationReturnTypes()[$relation] ?? '') === 'morphTo'
+                                ) {
                                     // Model isn't specified because relation is polymorphic
                                     $this->setProperty(
                                         $method,
@@ -1074,6 +1080,14 @@ class ModelsCommand extends Command
         return array_merge(self::RELATION_TYPES, $configuredRelations);
     }
 
+    /**
+     * Returns the return types of relations
+     */
+    protected function getRelationReturnTypes(): array
+    {
+        return $this->laravel['config']->get('ide-helper.additional_relation_return_types', []);
+    }
+
     /**
      * @return bool
      */

tests/Console/ModelsCommand/Relations/Models/Simple.php

@@ -97,4 +97,14 @@ class Simple extends Model
     {
         return $this->testToManyRelation(Simple::class);
     }
+
+    public function relationSampleToAnyRelationType()
+    {
+        return $this->testToAnyRelation(Simple::class);
+    }
+
+    public function relationSampleToAnyMorphedRelationType()
+    {
+        return $this->testToAnyMorphedRelation(Simple::class);
+    }
 }

tests/Console/ModelsCommand/Relations/Test.php

@@ -6,6 +6,7 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations;
 
 use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
 use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToAnyRelationType;
 use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToManyRelationType;
 use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToOneRelationType;
 use Illuminate\Support\Facades\Config;
@@ -19,6 +20,13 @@ class Test extends AbstractModelsCommand
         Config::set('ide-helper.additional_relation_types', [
             'testToOneRelation' => SampleToOneRelationType::class,
             'testToManyRelation' => SampleToManyRelationType::class,
+            'testToAnyRelation' => SampleToAnyRelationType::class,
+            'testToAnyMorphedRelation' => SampleToAnyMorphedRelationType::class,
+        ]);
+
+        Config::set('ide-helper.additional_relation_return_types', [
+            'testToAnyRelation' => 'many',
+            'testToAnyMorphedRelation' => 'morphTo',
         ]);
     }
 

tests/Console/ModelsCommand/Relations/Traits/HasTestRelations.php

@@ -4,6 +4,8 @@ declare(strict_types=1);
 
 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Traits;
 
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToAnyRelationType;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToAnyMorphedRelationType;
 use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToManyRelationType;
 use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToOneRelationType;
 
@@ -20,4 +22,16 @@ trait HasTestRelations
         $instance = $this->newRelatedInstance($related);
         return new SampleToManyRelationType($instance->newQuery(), $this);
     }
+
+    public function testToAnyRelation($related)
+    {
+        $instance = $this->newRelatedInstance($related);
+        return new SampleToAnyRelationType($instance->newQuery(), $this);
+    }
+
+    public function testToAnyMorphedRelation($related)
+    {
+        $instance = $this->newRelatedInstance($related);
+        return new SampleToAnyMorphedRelationType($instance->newQuery(), $this);
+    }
 }

tests/Console/ModelsCommand/Relations/Types/SampleToAnyMorphedRelationType.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types;
+
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Relations\Relation;
+
+class SampleToAnyMorphedRelationType extends Relation
+{
+    public function addConstraints()
+    {
+        // Fake
+    }
+
+    public function addEagerConstraints(array $models)
+    {
+        // Fake
+    }
+
+    public function initRelation(array $models, $relation)
+    {
+        // Fake
+    }
+
+    public function match(array $models, Collection $results, $relation)
+    {
+        // Fake
+    }
+
+    public function getResults()
+    {
+        // Fake
+    }
+}

tests/Console/ModelsCommand/Relations/Types/SampleToAnyRelationType.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types;
+
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Relations\Relation;
+
+class SampleToAnyRelationType extends Relation
+{
+    public function addConstraints()
+    {
+        // Fake
+    }
+
+    public function addEagerConstraints(array $models)
+    {
+        // Fake
+    }
+
+    public function initRelation(array $models, $relation)
+    {
+        // Fake
+    }
+
+    public function match(array $models, Collection $results, $relation)
+    {
+        // Fake
+    }
+
+    public function getResults()
+    {
+        // Fake
+    }
+}

tests/Console/ModelsCommand/Relations/__snapshots__/Test__test__1.php

@@ -94,6 +94,9 @@ use Illuminate\Database\Eloquent\Relations\MorphToMany;
  * @property-read int|null $relation_morphed_by_many_count
  * @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $relationSampleRelationType
  * @property-read int|null $relation_sample_relation_type_count
+ * @property-read Model|\Eloquent $relationSampleToAnyMorphedRelationType
+ * @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $relationSampleToAnyRelationType
+ * @property-read int|null $relation_sample_to_any_relation_type_count
  * @property-read Simple $relationSampleToManyRelationType
  * @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
  * @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
@@ -182,4 +185,14 @@ class Simple extends Model
     {
         return $this->testToManyRelation(Simple::class);
     }
+
+    public function relationSampleToAnyRelationType()
+    {
+        return $this->testToAnyRelation(Simple::class);
+    }
+
+    public function relationSampleToAnyMorphedRelationType()
+    {
+        return $this->testToAnyMorphedRelation(Simple::class);
+    }
 }