Merge remote-tracking branch 'origin/feature/relationship-resolution' into 2.x

Author: likeadeckofcards

README.md

@@ -394,18 +394,27 @@ 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 the connections are set correctly, relationships from FMModel objects to sql-based Model objects should resolve correctly automatically. Relationships from regular `Model` objects to `FMModel` objects (version > 2.3.0 ) will require adding a new trait to your model class to enable the relationship to be created. For versions earlier than 2.3.0 or for more control over the relationship you can add a relationship connection manually using the examples below.
 
-Here is an example of setting a native Laravel User Model to belong to a FileMaker-based Company FMModel class.
+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.
+
+### Using trait to create a relationship (2.3.0+)
+The `HasHybridRelationships` trait allows the model to automatically resolve relationships from a `Model` to an `FMModel`. Here is an example of using the trait to create a native Laravel User `Model` in a SQL database 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()
     {
-        return new \GearboxSolutions\EloquentFileMaker\Database\Eloquent\Relations\BelongsTo(Company::query(), $this, 'company_id', 'id', '');
+        // The Company class is an FMModel and is stored in FileMaker
+        // The correct relationship will be resolved automatically thanks to the HasHybridRelationships trait
+        return $this->belongsTo(Company::class, 'company_id', 'id');
     }
 }
 ```
@@ -417,5 +426,24 @@ With this relationship created we can now get an FMModel of the Company the User
 $company = $user->company;
 ```
 
+### Manually creating a relationship
+
+Using the `HasHybridRelationships` trait is the easiest way to create relationships between native Laravel models and FMModels. However, if you are using an older version of Eloquent FileMaker or want to manually manage the relationships you can establish the relationship by using the Eloquent FileMaker version of the relationship type. Each valid relationship type will be available under the `\GearboxSolutions\EloquentFileMaker\Database\Eloquent\Relations\` namespace.
+
+Here is an example of setting a native Laravel User Model to belong to a FileMaker-based Company FMModel class.
+
+```php
+// User.php
+
+class User extends Model
+{
+    public function company()
+    {
+        // The Company class is an FMModel and is stored in FileMaker
+        return new \GearboxSolutions\EloquentFileMaker\Database\Eloquent\Relations\BelongsTo(Company::query(), $this, 'company_id', 'id', '');
+    }
+}
+```
+
 ## License
 Eloquent-FileMaker is open-sourced software licensed under the MIT license.

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;
+}

src/Database/Eloquent/FMEloquentBuilder.php

@@ -2,20 +2,16 @@
 
 namespace GearboxSolutions\EloquentFileMaker\Database\Eloquent;
 
-use GearboxSolutions\EloquentFileMaker\Database\Eloquent\Concerns\FMHasRelationships;
 use GearboxSolutions\EloquentFileMaker\Database\Query\FMBaseBuilder;
 use GearboxSolutions\EloquentFileMaker\Exceptions\FileMakerDataApiException;
 use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection;
-use Illuminate\Database\Eloquent\Scope;
 use Illuminate\Pagination\Paginator;
 use Illuminate\Support\Arr;
 
 class FMEloquentBuilder extends Builder
 {
-    use FMHasRelationships;
-
     /**
      * @return Collection
      *