[Bugfix] Allow store to be a relation method on adapters

Renames the `store` method to `getStore` so that it can be used
as a relation method name in an adapter.

Closes #185

CHANGELOG.md

@@ -5,6 +5,8 @@ All notable changes to this project will be documented in this file. This projec
 ## Unreleased
 
 ### Fixed
+- [#185](https://github.com/cloudcreativity/laravel-json-api/issues/185)
+Rename adapter `store` method to `getStore` to avoid collisions with relation methods.
 - [#187](https://github.com/cloudcreativity/laravel-json-api/issues/187)
 Ensure hydration of Eloquent morph-many relationship works.
 - [#194](https://github.com/cloudcreativity/laravel-json-api/issues/194)

docs/basics/adapters.md

@@ -396,6 +396,25 @@ class Adapter extends AbstractAdapter
 > The `morphMany` implementation currently has some limitations that we are hoping to resolve during our alpha
 and beta releases. If you have problems using it, please create an issue as this will help us out.
 
+#### Customising Relation Method Names
+
+If you want to use a method name for your relation that is different than the JSON API field name, overload
+the `methodForRelation` method on your adapter. For example, you would need to do this if the field name collides
+with a method that already exists on the abstract adapter.
+
+The method can be overloaded as follows:
+
+```php
+protected function methodForRelation($field)
+{
+  if ('myField' === $field) {
+    return 'myOtherMethodName';
+  }
+
+  return parent::methodForRelation($field);
+}
+```
+
 ## Custom Adapters
 
 Custom adapters can be used for any domain record that is not an Eloquent model. Adapters will work with this

docs/upgrade.md

@@ -36,6 +36,11 @@ public function read(StoreInterface $store, ValidatedRequest $request)
 }
 ```
 
+### Adapters
+
+The `store` method has been renamed to `getStore` to avoid collisions with JSON API relation names. This change
+will only affect applications that are overloading internal adapter methods.
+
 ### Has-Many
 
 The method signatures for the `sync` and `detach` methods in the JSON API Eloquent `HasMany` relation have been

phpunit.xml

@@ -10,7 +10,6 @@
          processIsolation="false"
          stopOnError="false"
          stopOnFailure="false"
-         syntaxCheck="true"
          verbose="true"
 >
     <testsuites>

src/Adapter/AbstractResourceAdapter.php

@@ -130,7 +130,7 @@ public function related($field)
         $relation->withFieldName($field);
 
         if ($relation instanceof StoreAwareInterface) {
-            $relation->withStore($this->store());
+            $relation->withStore($this->getStore());
         }
 
         return $relation;

src/Eloquent/AbstractAdapter.php

@@ -446,8 +446,20 @@ protected function findByIds(Builder $query, Collection $filters)
      *
      * @param Builder $query
      * @return Model
+     * @deprecated 1.0.0 use `searchOne`, renamed to avoid collisions with relation names.
      */
     protected function first(Builder $query)
+    {
+        return $this->searchOne($query);
+    }
+
+    /**
+     * Return the result for a search one query.
+     *
+     * @param Builder $query
+     * @return Model
+     */
+    protected function searchOne($query)
     {
         return $query->first();
     }
@@ -457,8 +469,20 @@ protected function first(Builder $query)
      *
      * @param Builder $query
      * @return mixed
+     * @deprecated 1.0.0 use `searchAll`, renamed to avoid collisions with relation names.
      */
     protected function all($query)
+    {
+        return $this->searchAll($query);
+    }
+
+    /**
+     * Return the result for query that is not paginated.
+     *
+     * @param Builder $query
+     * @return mixed
+     */
+    protected function searchAll($query)
     {
         return $query->get();
     }

src/Eloquent/AbstractManyRelation.php

@@ -43,7 +43,7 @@ public function query($record, EncodingParametersInterface $parameters)
         }
 
         $relation = $this->getRelation($record);
-        $adapter = $this->store()->adapterFor($relation->getModel());
+        $adapter = $this->getStore()->adapterFor($relation->getModel());
 
         if (!$adapter instanceof AbstractAdapter) {
             throw new RuntimeException('Expecting inverse adapter to be an Eloquent adapter.');

src/Eloquent/BelongsTo.php

@@ -110,7 +110,7 @@ protected function findRelated(RelationshipInterface $relationship)
     {
         $identifier = $relationship->hasIdentifier() ? $relationship->getIdentifier() : null;
 
-        return $identifier ? $this->store()->find($identifier) : null;
+        return $identifier ? $this->getStore()->find($identifier) : null;
     }
 
     /**

src/Eloquent/HasMany.php

@@ -166,7 +166,7 @@ protected function detach($relation, Collection $remove)
     protected function findRelated($record, RelationshipInterface $relationship)
     {
         $inverse = $this->getRelation($record)->getRelated();
-        $related = $this->store()->findMany($relationship->getIdentifiers());
+        $related = $this->getStore()->findMany($relationship->getIdentifiers());
 
         $related = collect($related)->filter(function ($model) use ($inverse) {
             return $model instanceof $inverse;

src/Store/StoreAwareTrait.php

@@ -45,7 +45,7 @@ public function withStore(StoreInterface $store)
     /**
      * @return StoreInterface
      */
-    protected function store()
+    protected function getStore()
     {
         if (!$this->store) {
             throw new RuntimeException('No store injected.');