Merge pull request #79 from sebj54/main

Add `$totalResults` parameter + update docs

Author: freekmurze

README.md

@@ -131,6 +131,8 @@ $model = YourModel::find(1);
 $model->relation()->jsonPaginate();
 ```
 
+### Override default behavior
+
 By default the maximum page size is set to 30. You can change this number in the `config` file or just pass the value to  `jsonPaginate`.
 
 ```php
@@ -139,6 +141,24 @@ $maxResults = 60;
 YourModel::jsonPaginate($maxResults);
 ```
 
+By default the default page size is set to 30. You can change this number in the `config` file or just pass the value to  `jsonPaginate`.
+
+```php
+$defaultSize = 15;
+
+YourModel::jsonPaginate(null, $defaultSize);
+```
+
+You can also pass the total count to the `paginate` function directly. This can be useful for performance reasons or to prevent issues with `DISTINCT` keyword ([more info](https://github.com/laravel/framework/issues?q=is%3Aissue+paginate+total)).
+
+⚠️ This is effective only with basic pagination (no effect with cursor, simple or fast pagination)
+
+```php
+$total = 42;
+
+YourModel::jsonPaginate(null, null, $total);
+```
+
 ### Cursor pagination
 
 This package also supports cursor pagination, which can be briefly defined by the Laravel Framework as follows:

src/JsonApiPaginateServiceProvider.php

@@ -30,7 +30,7 @@ public function register()
 
     protected function registerMacro()
     {
-        $macro = function (int $maxResults = null, int $defaultSize = null) {
+        $macro = function (?int $maxResults = null, ?int $defaultSize = null, ?int $totalResults = null) {
             $maxResults = $maxResults ?? config('json-api-paginate.max_results');
             $defaultSize = $defaultSize ?? config('json-api-paginate.default_size');
             $numberParameter = config('json-api-paginate.number_parameter');
@@ -45,7 +45,7 @@ protected function registerMacro()
                         : (config('json-api-paginate.use_fast_pagination') ? 'fastPaginate' : 'paginate')
                 );
 
-            if (config('json-api-paginate.use_fast_pagination') && !InstalledVersions::isInstalled('hammerstone/fast-paginate')) {
+            if (config('json-api-paginate.use_fast_pagination') && ! InstalledVersions::isInstalled('hammerstone/fast-paginate')) {
                 abort(500, 'You need to install hammerstone/fast-paginate to use fast pagination.');
             }
 
@@ -64,7 +64,7 @@ protected function registerMacro()
                 ? $this->{$paginationMethod}($size, ['*'], $paginationParameter.'['.$cursorParameter.']', $cursor)
                     ->appends(Arr::except(request()->input(), $paginationParameter.'.'.$cursorParameter))
                 : $this
-                    ->{$paginationMethod}($size, ['*'], $paginationParameter.'.'.$numberParameter)
+                    ->{$paginationMethod}($size, ['*'], $paginationParameter.'.'.$numberParameter, null, $totalResults)
                     ->setPageName($paginationParameter.'['.$numberParameter.']')
                     ->appends(Arr::except(request()->input(), $paginationParameter.'.'.$numberParameter));