Upgrading pagination

Author: Nicholas Dykhuizen

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to `dykhuizen/laravel-datatables` will be documented in this file
+
+## 2.0.0 - 2020-11-22
+
+- Added `simplePaginateable($forcePagination = true)`
+- Altered `paginateable` to have `$forcePagination` as a parameter
+- Changed `simplePaginateable` and `paginateable` to take a $forcePagination parameter. If this value is false, the query will default to a `->get()` call. If true, the query will default to its respective pagination function.
+- Added `$maxPerPage` to `Paginateable` to prevent dos-like queries.

README.md

@@ -19,6 +19,7 @@ This single trait gives you access the following traits:
 * Searchable - Applies a search query for selected columns
 * Filterable - Applies a list of filters to the query based on columns selected
 * Paginateable - Either runs the `$eloquent->get()` or `$eloquent->paginate()` methods based on the request
+* SimplePaginateable - Either runs the `$eloquent->get()` or `$eloquent->simplePaginate()` methods based on the request
 * Selectable - Selects the response data to be returned
 
 
@@ -139,13 +140,13 @@ public function addressFilterable($query, $filters)
 }
 ```
 
-## Paginateable
+## Paginateable and SimplePaginateable
 The paginateable columns default to `page` and `per_page` just like Laravel's built in pagination
 <br>
 These keys can be overwritten on a per model instance by setting the `$paginateablePageKey` and `$paginateablePerPageKey` variables.
 <br>
 If these keys exist, results will be paginated in the response.
-If these keys to not exist, results will be returned via the `get()` method
+If these keys do not exist, the $forcePagination function param will be checked. If true, results will be paginated according to Laravel defaults. If false, results will be retrieved via the `get()` method.
 <br>
 <br>
 Ex:

src/Datatable.php

@@ -2,7 +2,6 @@
 
 namespace Dykhuizen\Datatable;
 
-use Gofish\Datatable\Traits\Searchable;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
@@ -17,7 +16,8 @@
  * @method static static|self|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder searchable()
  * @method static static|self|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder sortable()
  * @method static static|self|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder filterable()
- * @method static static|self|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder paginateable()
+ * @method static static|self|\Illuminate\Database\Eloquent\Collection paginateable($forcePagination = true)
+ * @method static static|self|\Illuminate\Database\Eloquent\Collection simplePaginateable($forcePagination = true)
  */
 trait Datatable {
 
@@ -26,7 +26,7 @@ trait Datatable {
     use Traits\Selectable;
     use Traits\Paginateable;
     use Traits\Filterable;
-	
+
     /**
      * Initialize the datatable trait
      *

src/DatatableServiceProvider.php

@@ -23,7 +23,6 @@ public function boot() {
         });
     }
 
-
     /**
      * Register the service provider.
      *

src/Traits/Paginateable.php

@@ -7,8 +7,10 @@
 /**
  * @method int getPerPage()
  */
-trait Paginateable
-{
+trait Paginateable {
+
+    /** @var int */
+    protected $maxPerPage = 100;
 
     /** @var string */
     protected $paginateablePageKey = 'page';
@@ -18,25 +20,35 @@ trait Paginateable
 
     /**
      * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param bool $simple
+     * @param bool $forcePagination
+     * @return \Illuminate\Database\Eloquent\Model[]|\Illuminate\Contracts\Pagination\Paginator|\Illuminate\Database\Eloquent\Builder[]|\Illuminate\Database\Eloquent\Collection
+     */
+    public function scopePaginateable(Builder $query, $forcePagination = true) {
+        if (request()->hasFilled([$this->paginateablePageKey, $this->paginateablePerPageKey])) {
+            return $query->paginate(
+                min(request()->input('per_page', $this->getPerPage()), $this->maxPerPage),
+                ['*'],
+                $this->paginateablePageKey
+            );
+        }
+
+        return $forcePagination ? $query->paginate() : $query->get();
+    }
+
+    /**
+     * @param \Illuminate\Database\Eloquent\Builder $query
+     * @param bool $forcePagination
      * @return \Illuminate\Database\Eloquent\Model[]|\Illuminate\Contracts\Pagination\Paginator|\Illuminate\Database\Eloquent\Builder[]|\Illuminate\Database\Eloquent\Collection
      */
-    public function scopePaginateable(Builder $query, $simple = false)
-    {
-        if (request()->hasFilled([$this->paginateablePageKey, $this->paginateablePerPageKey]))
-        {
-            return $simple ?
-                $query->simplePaginate(
-                    request()->input('per_page', $this->getPerPage()),
-                    ['*'],
-                    $this->paginateablePageKey
-                ) : $query->paginate(
-                    request()->input('per_page', $this->getPerPage()),
-                    ['*'],
-                    $this->paginateablePageKey
-                );
+    public function scopeSimplePaginateable(Builder $query, $forcePagination = true) {
+        if (request()->hasFilled([$this->paginateablePageKey, $this->paginateablePerPageKey])) {
+            return $query->simplePaginate(
+                min(request()->input('per_page', $this->getPerPage()), $this->maxPerPage),
+                ['*'],
+                $this->paginateablePageKey
+            );
         }
 
-        return $query->get();
+        return $forcePagination ? $query->simplePaginate() : $query->get();
     }
 }