Add auto relationship resolution for FMModel and native Models

Author: likeadeckofcards

README.md

@@ -394,7 +394,9 @@ It is possible to have relationships between native Laravel Model objects from y
 protected $connection = 'theConnectionName';
 ```
 
-Once they're set correctly, you can create relationships, such as a belongsTo, by manually creating a new eloquent-filemaker belongsTo object and setting the appropriate keys.
+Once they're set correctly, you can create relationships, such as a belongsTo, by manually creating a new eloquent-filemaker belongsTo object or importing a new trait and setting the appropriate keys.
+
+### Manually creating a relationship
 
 Here is an example of setting a native Laravel User Model to belong to a FileMaker-based Company FMModel class.
 
@@ -410,6 +412,26 @@ class User extends Model
 }
 ```
 
+### Using trait to create a relationship (2.3.0+)
+Here is an example of using the trait to create a native Laravel User Model to belong to a FileMaker-based Company FMModel class.
+
+```php
+// User.php
+
+use GearboxSolutions\EloquentFileMaker\Database\Eloquent\Concerns\HasHybridRelationships;
+
+class User extends Model
+{
+    use HasHybridRelationships;
+    
+    public function company()
+    {
+        // This method looks at the related model and determines the correct relationship type
+        return $this->belongsTo(Company::class, 'company_id', 'id');
+    }
+}
+```
+
 With this relationship created we can now get an FMModel of the Company the User belongs to like a normal relationship in a single database.
 
 ```php

src/Database/Eloquent/Concerns/FMHasRelationships.php

@@ -2,14 +2,25 @@
 
 namespace GearboxSolutions\EloquentFileMaker\Database\Eloquent\Concerns;
 
+use GearboxSolutions\EloquentFileMaker\Database\Eloquent\FMModel;
 use GearboxSolutions\EloquentFileMaker\Database\Eloquent\Relations\BelongsTo;
 use GearboxSolutions\EloquentFileMaker\Database\Eloquent\Relations\HasMany;
 use GearboxSolutions\EloquentFileMaker\Database\Eloquent\Relations\HasOne;
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Concerns\HasRelationships;
 use Illuminate\Database\Eloquent\Model;
 
 trait FMHasRelationships
 {
+    use HasRelationships {
+        HasRelationships::hasOne as hasOneBase;
+        HasRelationships::hasMany as hasManyBase;
+        HasRelationships::newBelongsTo as newBelongsToBase;
+        HasRelationships::newHasMany as newHasManyBase;
+        HasRelationships::morphMany as morphManyBase;
+        HasRelationships::newHasOne as newHasOneBase;
+    }
+
     /**
      * Define a one-to-one relationship.
      *
@@ -19,6 +30,10 @@ trait FMHasRelationships
      */
     public function hasOne($related, $foreignKey = null, $localKey = null)
     {
+        if (! ((new $related) instanceof FMModel)) {
+            return $this->hasOneBase($related, $foreignKey, $localKey);
+        }
+
         $instance = $this->newRelatedInstance($related);
 
         $foreignKey = $foreignKey ?: $this->getForeignKey();
@@ -38,6 +53,10 @@ public function hasOne($related, $foreignKey = null, $localKey = null)
      */
     public function hasMany($related, $foreignKey = null, $localKey = null)
     {
+        if (! ((new $related) instanceof FMModel)) {
+            return $this->hasManyBase($related, $foreignKey, $localKey);
+        }
+
         $instance = $this->newRelatedInstance($related);
 
         $foreignKey = $foreignKey ?: $this->getForeignKey();
@@ -55,10 +74,14 @@ public function hasMany($related, $foreignKey = null, $localKey = null)
      * @param  string  $foreignKey
      * @param  string  $ownerKey
      * @param  string  $relation
-     * @return BelongsTo
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     protected function newBelongsTo(Builder $query, Model $child, $foreignKey, $ownerKey, $relation)
     {
+        if (! ($query->newModelInstance() instanceof FMModel)) {
+            return $this->newBelongsToBase($query, $child, $foreignKey, $ownerKey, $relation);
+        }
+
         // custom version of this so we can return our own BelongsTo class with a custom constraint for FM
         return new BelongsTo($query, $child, $foreignKey, $ownerKey, $relation);
     }
@@ -68,10 +91,14 @@ protected function newBelongsTo(Builder $query, Model $child, $foreignKey, $owne
      *
      * @param  string  $foreignKey
      * @param  string  $localKey
-     * @return HasMany
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
      */
     protected function newHasMany(Builder $query, Model $parent, $foreignKey, $localKey)
     {
+        if (! ($query->newModelInstance() instanceof FMModel)) {
+            return $this->newHasManyBase($query, $parent, $foreignKey, $localKey);
+        }
+
         // custom version of this so we can return our own BelongsTo class with a custom constraint for FM
         return new HasMany($query, $parent, $foreignKey, $localKey);
     }
@@ -88,6 +115,10 @@ protected function newHasMany(Builder $query, Model $parent, $foreignKey, $local
      */
     public function morphMany($related, $name, $type = null, $id = null, $localKey = null)
     {
+        if (! ((new $related) instanceof FMModel)) {
+            return $this->morphManyBase($related, $name, $type, $id, $localKey);
+        }
+
         $instance = $this->newRelatedInstance($related);
 
         // Here we will gather up the morph type and ID for the relationship so that we
@@ -107,10 +138,14 @@ public function morphMany($related, $name, $type = null, $id = null, $localKey =
      *
      * @param  string  $foreignKey
      * @param  string  $localKey
-     * @return HasOne
+     * @return \Illuminate\Database\Eloquent\Relations\HasOne
      */
     protected function newHasOne(Builder $query, Model $parent, $foreignKey, $localKey)
     {
+        if (! ($query->newModelInstance() instanceof FMModel)) {
+            return $this->newHasOneBase($query, $parent, $foreignKey, $localKey);
+        }
+
         // custom version of this so we can return our own BelongsTo class with a custom constraint for FM
         return new HasOne($query, $parent, $foreignKey, $localKey);
     }

src/Database/Eloquent/Concerns/HasHybridRelationships.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace GearboxSolutions\EloquentFileMaker\Database\Eloquent\Concerns;
+
+trait HasHybridRelationships
+{
+    use FMHasRelationships;
+}