Allow associative pageName in Paginator

[FalkHe]

In Paginator, currently pageName can only be a "first-level" query parameter. Some Spechs (i.e. JSON:API) require pagination query parameters to reside under or within the page parameter. This might look like ?page[size]=5&page[number]=3 or page[cursor]=123. Currently this seems not to be possible with Laravel.

Using the string 'page[number]' as pageName results in a query string with doubled parameter page%5Bnumber%5D.

The reason for this lies in Illuminate\Pagination\AbstractPaginator::url() where $parameters is filled with:

 // i.E. the next_page URL 
[
  // from $pageName  
  'page[number]' => 4, // next
   // from query
  'page' => [
    'number' => 3, // current
  ],
],

Neither Arr::query() nor http_build_query() handle this conflicting situation properly.

A simple solution would be, to normalize / flatten the $parameters array before array_merge() in the url() method. Not sure if this would cause any other issues.

[murilolivorato]

<?php

namespace App\Pagination;

use Illuminate\Pagination\AbstractPaginator;

class CustomPaginator extends AbstractPaginator
{
    /**
     * Get the URL for a given page number.
     *
     * @param  int  $page
     * @return string
     */
    public function url($page)
    {
        $pageName = $this->pageName;

        $parameters = [$pageName => $page];

        if (count($this->query) > 0) {
            $parameters = array_merge($this->query, $parameters);
        }

        // Normalize/flatten the parameters array
        $parameters = $this->normalizeParameters($parameters);

        return $this->path
            . (Str::contains($this->path, '?') ? '&' : '?')
            . Arr::query($parameters)
            . $this->buildFragment();
    }

    /**
     * Normalize/flatten the parameters array.
     *
     * @param  array  $parameters
     * @return array
     */
    protected function normalizeParameters(array $parameters)
    {
        $normalized = [];
        foreach ($parameters as $key => $value) {
            if (is_array($value)) {
                foreach ($value as $subKey => $subValue) {
                    $normalized["{$key}[{$subKey}]"] = $subValue;
                }
            } else {
                $normalized[$key] = $value;
            }
        }
        return $normalized;
    }
}

use App\Pagination\CustomPaginator;

// Example usage
$items = YourModel::paginate(10, ['*'], 'page[number]', 1, CustomPaginator::class);

[FalkHe]

Where comes the fith parameter in paginate() from? I can't find it in the docs nor an according method signature. 🤔