Merge pull request #6 from Lomkit/feature/exposed-limits

♻️ renamed "exposedPaginations" to "exposedLimits"'

Author: GautierDele

README.md

@@ -83,5 +83,5 @@ TODO
 - Custom directives (Filters / sorting)
 - Actions / Metrics
 - Automatic Gates
-- Aggregating (V2)
+- Aggregating
 - Automatic documentation with extension possible

src/Concerns/PerformsModelOperations.php

@@ -10,7 +10,7 @@ trait PerformsModelOperations
 {
 
     /**
-     * Build a query for the given resource.
+     * Build a "delete" query for the given resource.
      *
      * @param  \Lomkit\Rest\Http\Requests\RestRequest  $request
      * @param  \Illuminate\Database\Eloquent\Model  $query
@@ -20,10 +20,24 @@ public function performDelete(RestRequest $request, Model $model) {
         $model->delete();
     }
 
+    /**
+     * Build a "restore" query for the given resource.
+     *
+     * @param  \Lomkit\Rest\Http\Requests\RestRequest  $request
+     * @param  \Illuminate\Database\Eloquent\Model  $query
+     * @return void
+     */
     public function performRestore(RestRequest $request, Model $model) {
         $model->restore();
     }
 
+    /**
+     * Build a "forceDelete" query for the given resource.
+     *
+     * @param  \Lomkit\Rest\Http\Requests\RestRequest  $request
+     * @param  \Illuminate\Database\Eloquent\Model  $query
+     * @return void
+     */
     public function performForceDelete(RestRequest $request, Model $model) {
         $model->forceDelete();
     }

src/Concerns/Resource/ConfiguresRestParameters.php

@@ -51,7 +51,7 @@ public function exposedScopes(RestRequest $request) {
         return [];
     }
 
-    public function exposedPaginations(RestRequest $request) {
+    public function exposedLimits(RestRequest $request) {
         return [
             10,
             25,

src/Http/Requests/SearchRequest.php

@@ -32,7 +32,7 @@ public function searchRules(Resource $resource, $prefix = '')
             [$prefix.'selects' => ['sometimes', 'array']],
             $this->selectsRules($resource, $prefix.'selects'),
             [
-                'limit' => ['sometimes', 'integer', Rule::in($resource->exposedPaginations($this))],
+                'limit' => ['sometimes', 'integer', Rule::in($resource->exposedLimits($this))],
                 'page' => ['sometimes', 'integer']
             ],
             $prefix === '' ? ['includes' => ['sometimes', 'array']] : [],

tests/Support/Rest/Resources/ModelResource.php

@@ -41,7 +41,7 @@ public function exposedScopes(RestRequest $request)
         ];
     }
 
-    public function exposedPaginations(RestRequest $request) {
+    public function exposedLimits(RestRequest $request) {
         return [
             1,
             10,