[Changed] Make model methods protected on resource query class

The model and modelOrFail methods were never meant to be used
publicly on the resource query class - and were not documented as
a result. To prevent them being used on this class (as it is
confusing as to which model is returned), these methods are now
public on the resource request, and protected on the query request.

See #110

Author: lindyhopchris

CHANGELOG.md

@@ -23,6 +23,10 @@ All notable changes to this project will be documented in this file. This projec
     - The type-hint of the first constructor argument has changed to `LaravelJsonApi\Core\Support\AppResolver`.
     - The deprecated `$container` property has been removed, and the `$app` property is now private. To access the
       current application instance in your server class, use `$this->app()` instead.
+- **BREAKING** [#110](https://github.com/laravel-json-api/laravel/issues/110) The `model()` and `modelOrFail()` methods
+  on the `ResourceQuery` request class have been changed from `public` to `protected`. These were not documented for use
+  on this query class, and were only intended to be used publicly on the `ResourceRequest` class. Although technically
+  breaking, this change is unlikely to affect the vast majority of applications which should not be using the method.
 
 ## [1.1.0] - 2022-01-03
 

src/Http/Requests/FormRequest.php

@@ -231,36 +231,6 @@ public function schema(): Schema
         return $this->jsonApi()->route()->schema();
     }
 
-    /**
-     * Get the model that the request relates to, if the URL has a resource id.
-     *
-     * @return Model|object|null
-     */
-    public function model(): ?object
-    {
-        $route = $this->jsonApi()->route();
-
-        if ($route->hasResourceId()) {
-            return $route->model();
-        }
-
-        return null;
-    }
-
-    /**
-     * Get the model that the request relates to, or fail if there is none.
-     *
-     * @return Model|object
-     */
-    public function modelOrFail(): object
-    {
-        if ($model = $this->model()) {
-            return $model;
-        }
-
-        throw new LogicException('No model exists for this route.');
-    }
-
     /**
      * @return bool
      */

src/Http/Requests/ResourceQuery.php

@@ -20,6 +20,7 @@
 namespace LaravelJsonApi\Laravel\Http\Requests;
 
 use Illuminate\Contracts\Validation\Validator;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Response;
 use LaravelJsonApi\Contracts\Auth\Authorizer;
 use LaravelJsonApi\Contracts\Query\QueryParameters;
@@ -28,6 +29,7 @@
 use LaravelJsonApi\Core\Query\FilterParameters;
 use LaravelJsonApi\Core\Query\IncludePaths;
 use LaravelJsonApi\Core\Query\SortFields;
+use LogicException;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 use function array_key_exists;
@@ -237,6 +239,36 @@ public function unrecognisedParameters(): array
         ])->all();
     }
 
+    /**
+     * Get the model that the request relates to, if the URL has a resource id.
+     *
+     * @return Model|object|null
+     */
+    protected function model(): ?object
+    {
+        $route = $this->jsonApi()->route();
+
+        if ($route->hasResourceId()) {
+            return $route->model();
+        }
+
+        return null;
+    }
+
+    /**
+     * Get the model that the request relates to, or fail if there is none.
+     *
+     * @return Model|object
+     */
+    protected function modelOrFail(): object
+    {
+        if ($model = $this->model()) {
+            return $model;
+        }
+
+        throw new LogicException('No model exists for this route.');
+    }
+
     /**
      * Get the default include paths to use if the client has provided none.
      *

src/Http/Requests/ResourceRequest.php

@@ -86,6 +86,36 @@ public static function forResourceIfExists(string $resourceType): ?ResourceReque
         return $resolver($resourceType, true);
     }
 
+    /**
+     * Get the model that the request relates to, if the URL has a resource id.
+     *
+     * @return Model|object|null
+     */
+    public function model(): ?object
+    {
+        $route = $this->jsonApi()->route();
+
+        if ($route->hasResourceId()) {
+            return $route->model();
+        }
+
+        return null;
+    }
+
+    /**
+     * Get the model that the request relates to, or fail if there is none.
+     *
+     * @return Model|object
+     */
+    public function modelOrFail(): object
+    {
+        if ($model = $this->model()) {
+            return $model;
+        }
+
+        throw new LogicException('No model exists for this route.');
+    }
+
     /**
      * Perform resource authorization.
      *