Add specialised base request classes for each controller action

Author: huntie

src/Http/Controllers/JsonApiControllerActions.php

@@ -2,93 +2,98 @@
 
 namespace Huntie\JsonApi\Http\Controllers;
 
-use Illuminate\Http\Request;
+use Huntie\JsonApi\Http\Requests\ListResourceRequest;
+use Huntie\JsonApi\Http\Requests\StoreResourceRequest;
+use Huntie\JsonApi\Http\Requests\ShowResourceRequest;
+use Huntie\JsonApi\Http\Requests\UpdateResourceRequest;
+use Huntie\JsonApi\Http\Requests\DestroyResourceRequest;
+use Huntie\JsonApi\Http\Requests\ShowRelationshipRequest;
 
 /**
  * Add default resource controller methods for JsonApiController actions.
  *
- * @method indexAction(Request $request)
- * @method storeAction(Request $request)
- * @method showAction(Request $request, int $id)
- * @method updateAction(Request $request, int $id)
- * @method destroyAction(Request $request, int $id)
- * @method relationshipAction(Request $request, int $id, string $relation)
+ * @method indexAction(ListResourceRequest $request)
+ * @method storeAction(StoreResourceRequest $request)
+ * @method showAction(ShowResourceRequest $request, int $id)
+ * @method updateAction(UpdateResourceRequest $request, int $id)
+ * @method destroyAction(DestroyResourceRequest $request, int $id)
+ * @method relationshipAction(ShowRelationshipRequest $request, int $id, string $relation)
  */
 trait JsonApiControllerActions
 {
     /**
      * Return a listing of the resource.
      *
-     * @param Request $request
+     * @param ListResourceRequest $request
      *
      * @return \Huntie\JsonApi\Http\JsonApiResponse
      */
-    public function index(Request $request)
+    public function index(ListResourceRequest $request)
     {
         return $this->indexAction($request);
     }
 
     /**
      * Store a new record.
      *
-     * @param Request $request
+     * @param StoreResourceRequest $request
      *
      * @return \Huntie\JsonApi\Http\JsonApiResponse
      */
-    public function store(Request $request)
+    public function store(StoreResourceRequest $request)
     {
         return $this->storeAction($request);
     }
 
     /**
      * Return a specified record.
      *
-     * @param Request $request
-     * @param int     $id
+     * @param ShowResourceRequest $request
+     * @param int                 $id
      *
      * @return \Huntie\JsonApi\Http\JsonApiResponse
      */
-    public function show(Request $request, $id)
+    public function show(ShowResourceRequest $request, $id)
     {
         return $this->showAction($request, $id);
     }
 
     /**
      * Update a specified record.
      *
-     * @param Request $request
-     * @param int     $id
+     * @param UpdateResourceRequest $request
+     * @param int                   $id
      *
      * @return \Huntie\JsonApi\Http\JsonApiResponse
      */
-    public function update(Request $request, $id)
+    public function update(UpdateResourceRequest $request, $id)
     {
         return $this->updateAction($request, $id);
     }
 
     /**
      * Destroy a specified record.
      *
-     * @param Request $request
-     * @param int     $id
+     * @param DestroyResourceRequest $request
+     * @param int                    $id
      *
      * @return \Huntie\JsonApi\Http\JsonApiResponse
      */
-    public function destroy(Request $request, $id)
+    public function destroy(DestroyResourceRequest $request, $id)
     {
         return $this->destroyAction($request, $id);
     }
 
     /**
      * Return a specified record relationship.
      *
-     * @param Request $request
-     * @param int     $id
-     * @param string  $relation
+     * @param ShowRelationshipRequest $request
+     * @param int                     $id
+     * @param string                  $relation
      *
      * @return \Huntie\JsonApi\Http\JsonApiResponse
      */
-    public function relationship(Request $request, $id, $relation)
+    public function relationship(ShowRelationshipRequest $request, $id, $relation)
     {
         return $this->relationshipAction($request, $id, $relation);
     }

src/Http/Requests/DestroyResourceRequest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Huntie\JsonApi\Http\Requests;
+
+class DestroyResourceRequest extends JsonApiRequest
+{
+    /**
+     * Base validation rules for the individual request type.
+     *
+     * @var array
+     */
+    protected $rules = [
+        'data.type' => 'required|string',
+        'data.id' => 'required',
+    ];
+}

src/Http/Requests/ListResourceRequest.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Huntie\JsonApi\Http\Requests;
+
+class ListResourceRequest extends JsonApiRequest
+{
+}

src/Http/Requests/ShowRelationshipRequest.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Huntie\JsonApi\Http\Requests;
+
+class ShowRelationshipRequest extends JsonApiRequest
+{
+}

src/Http/Requests/ShowResourceRequest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Huntie\JsonApi\Http\Requests;
+
+class ShowResourceRequest extends JsonApiRequest
+{
+    /**
+     * Base validation rules for the individual request type.
+     *
+     * @var array
+     */
+    protected $rules = [
+        'data.type' => 'required|string',
+        'data.id' => 'required',
+    ];
+}

src/Http/Requests/StoreResourceRequest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Huntie\JsonApi\Http\Requests;
+
+class StoreResourceRequest extends JsonApiRequest
+{
+    /**
+     * Base validation rules for the individual request type.
+     *
+     * @var array
+     */
+    protected $rules = [
+        'data.type' => 'required|string',
+        'data.attributes' => 'required|array',
+
+        'data.relationships' => 'array',
+        'data.relationships.*.type' => 'required_if:data.relationships|string',
+        'data.relationships.*.id' => 'required_if:data.relationships',
+        'data.relationships.*.attributes' => 'array',
+    ];
+}

src/Http/Requests/UpdateResourceRequest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Huntie\JsonApi\Http\Requests;
+
+class UpdateResourceRequest extends JsonApiRequest
+{
+    /**
+     * Base validation rules for the individual request type.
+     *
+     * @var array
+     */
+    protected $rules = [
+        'data.type' => 'required|string',
+        'data.id' => 'required',
+        'data.attributes' => 'required|array',
+
+        'data.relationships' => 'array',
+        'data.relationships.*.type' => 'required_if:data.relationships|string',
+        'data.relationships.*.id' => 'required_if:data.relationships',
+        'data.relationships.*.attributes' => 'array',
+    ];
+}

src/Http/Requests/UpdateToManyRelationshipRequest.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Huntie\JsonApi\Http\Requests;
+
+class UpdateToManyRelationshipRequest extends JsonApiRequest
+{
+    /**
+     * Base validation rules for the individual request type.
+     *
+     * @var array
+     */
+    protected $rules = [
+        'data.*.type' => 'required',
+        'data.*.id' => 'required',
+        'data.*.attributes' => 'array',
+    ];
+}

src/Http/Requests/UpdateToOneRelationshipRequest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Huntie\JsonApi\Http\Requests;
+
+class UpdateToOneRelationshipRequest extends JsonApiRequest
+{
+    /**
+     * Base validation rules for the individual request type.
+     *
+     * @var array
+     */
+    protected $rules = [
+        'data.type' => 'required|string',
+        'data.id' => 'required',
+    ];
+}