Page parameter name (#820)

steveWinter · web-flow · commit b7308c1087fe · 2025-02-28T09:16:45.000+01:00
diff --git a/src/Helper/Processor.php b/src/Helper/Processor.php
@@ -36,6 +36,7 @@ public function render(SlidingPaginationInterface $pagination, array $queryParam
 
         $data['route'] = $pagination->getRoute();
         $data['query'] = \array_merge($pagination->getParams(), $queryParams);
+        $data['options'] = $pagination->getPaginatorOptions();
 
         return \array_merge(
             $pagination->getPaginatorOptions() ?? [], // options given to paginator when paginated
diff --git a/src/Twig/Extension/PaginationRuntime.php b/src/Twig/Extension/PaginationRuntime.php
@@ -109,20 +109,26 @@ public function filter(
     }
 
     /**
-     * @param array<string, mixed> $query
-     * @param int $page
+     * @param array<string, mixed>      $query
+     * @param int                       $page
+     * @param array<string, mixed>      $options
      * @return array<string, mixed>
      */
-    public function getQueryParams(array $query, int $page): array
+    public function getQueryParams(array $query, int $page, array $options): array
     {
+        $pageName = $this->pageName;
+        if (isset($options['pageParameterName']) && is_string($options['pageParameterName'])) {
+            $pageName = $options['pageParameterName'];
+        }
+
         if ($page === 1 && $this->skipFirstPageLink) {
-            if (isset($query[$this->pageName])) {
-                unset($query[$this->pageName]);
+            if (isset($query[$pageName])) {
+                unset($query[$pageName]);
             }
 
             return $query;
         }
 
-        return array_merge($query, [$this->pageName => $page]);
+        return array_merge($query, [$pageName => $page]);
     }
 }
diff --git a/templates/Pagination/bulma_pagination.html.twig b/templates/Pagination/bulma_pagination.html.twig
@@ -13,23 +13,23 @@
 {% if pageCount > 1 %}
     <nav class="{{ classes|join(' ') }}" role="navigation" aria-label="pagination">
         {% if previous is defined %}
-            <a rel="prev" class="pagination-previous" href="{{ path(route, knp_pagination_query(query, previous)) }}">{{ 'label_previous'|trans({}, 'KnpPaginatorBundle') }}</a>
+            <a rel="prev" class="pagination-previous" href="{{ path(route, knp_pagination_query(query, previous, options)) }}">{{ 'label_previous'|trans({}, 'KnpPaginatorBundle') }}</a>
         {% else %}
             <a class="pagination-previous" disabled>{{ 'label_previous'|trans({}, 'KnpPaginatorBundle') }}</a>
         {% endif %}
 
         {% if next is defined %}
-            <a rel="next" class="pagination-next" href="{{ path(route, knp_pagination_query(query, next)) }}">{{ 'label_next'|trans({}, 'KnpPaginatorBundle') }}</a>
+            <a rel="next" class="pagination-next" href="{{ path(route, knp_pagination_query(query, next, options)) }}">{{ 'label_next'|trans({}, 'KnpPaginatorBundle') }}</a>
         {% else %}
             <a class="pagination-next" disabled>{{ 'label_next'|trans({}, 'KnpPaginatorBundle') }}</a>
         {% endif %}
 
         <ul class="pagination-list">
             <li>
                 {% if current == first %}
-                    <a class="pagination-link is-current" aria-label="Page {{ current }}" aria-current="page" href="{{ path(route, knp_pagination_query(query, first)) }}">1</a>
+                    <a class="pagination-link is-current" aria-label="Page {{ current }}" aria-current="page" href="{{ path(route, knp_pagination_query(query, first, options)) }}">1</a>
                 {% else %}
-                    <a class="pagination-link" href="{{ path(route, knp_pagination_query(query, first)) }}">1</a>
+                    <a class="pagination-link" href="{{ path(route, knp_pagination_query(query, first, options)) }}">1</a>
                 {% endif %}
             </li>
 
@@ -43,9 +43,9 @@
                 {% if first != page and page != last %}
                     <li>
                         {% if page == current %}
-                            <a class="pagination-link is-current" aria-label="Page {{ current }}" aria-current="page" href="{{ path(route, knp_pagination_query(query, page)) }}">{{ page }}</a>
+                            <a class="pagination-link is-current" aria-label="Page {{ current }}" aria-current="page" href="{{ path(route, knp_pagination_query(query, page, options)) }}">{{ page }}</a>
                         {% else %}
-                            <a class="pagination-link" aria-label="Goto page {{ page }}" href="{{ path(route, knp_pagination_query(query, page)) }}">{{ page }}</a>
+                            <a class="pagination-link" aria-label="Goto page {{ page }}" href="{{ path(route, knp_pagination_query(query, page, options)) }}">{{ page }}</a>
                         {% endif %}
                     </li>
                 {% endif %}
@@ -59,9 +59,9 @@
 
             <li>
                 {% if current == last %}
-                    <a class="pagination-link is-current" aria-label="Page {{ current }}" aria-current="page" href="{{ path(route, knp_pagination_query(query, last)) }}">{{ last }}</a>
+                    <a class="pagination-link is-current" aria-label="Page {{ current }}" aria-current="page" href="{{ path(route, knp_pagination_query(query, last, options)) }}">{{ last }}</a>
                 {% else %}
-                    <a class="pagination-link" href="{{ path(route, knp_pagination_query(query, last)) }}">{{ last }}</a>
+                    <a class="pagination-link" href="{{ path(route, knp_pagination_query(query, last, options)) }}">{{ last }}</a>
                 {% endif %}
             </li>
         </ul>
diff --git a/templates/Pagination/foundation_v5_pagination.html.twig b/templates/Pagination/foundation_v5_pagination.html.twig
@@ -21,7 +21,7 @@
     <ul class="pagination">
         {% if previous is defined %}
                  <li class="arrow">
-                     <a rel="prev" href="{{ path(route, knp_pagination_query(query, previous)) }}">&laquo; {{ 'label_previous'|trans({}, 'KnpPaginatorBundle') }}</a>
+                     <a rel="prev" href="{{ path(route, knp_pagination_query(query, previous, options)) }}">&laquo; {{ 'label_previous'|trans({}, 'KnpPaginatorBundle') }}</a>
                  </li>
         {% else %}
             <li class="arrow unavailable">
@@ -33,11 +33,11 @@
 
         {% if startPage > 1 %}
             <li>
-                <a href="{{ path(route, knp_pagination_query(query, 1)) }}">1</a>
+                <a href="{{ path(route, knp_pagination_query(query, 1, options)) }}">1</a>
             </li>
             {% if startPage == 3 %}
                 <li>
-                    <a href="{{ path(route, knp_pagination_query(query, 2)) }}">2</a>
+                    <a href="{{ path(route, knp_pagination_query(query, 2, options)) }}">2</a>
                 </li>
             {% elseif startPage != 2 %}
                 <li class="unavailable">
@@ -49,7 +49,7 @@
         {% for page in pagesInRange %}
             {% if page != current %}
                 <li>
-                    <a href="{{ path(route, knp_pagination_query(query, page)) }}">
+                    <a href="{{ path(route, knp_pagination_query(query, page, options)) }}">
                         {{ page }}
                     </a>
                 </li>
@@ -69,20 +69,20 @@
                     </li>
                 {% else %}
                     <li>
-                        <a href="{{ path(route, knp_pagination_query(query, (pageCount - 1))) }}">
+                        <a href="{{ path(route, knp_pagination_query(query, (pageCount - 1), options)) }}">
                             {{ pageCount - 1 }}
                         </a>
                     </li>
                 {% endif %}
             {% endif %}
             <li>
-                <a href="{{ path(route, knp_pagination_query(query, pageCount)) }}">{{ pageCount }}</a>
+                <a href="{{ path(route, knp_pagination_query(query, pageCount, options)) }}">{{ pageCount }}</a>
             </li>
         {% endif %}
 
         {% if next is defined %}
             <li class="arrow">
-                <a rel="next" href="{{ path(route, knp_pagination_query(query, next)) }}">
+                <a rel="next" href="{{ path(route, knp_pagination_query(query, next, options)) }}">
                     {{ 'label_next'|trans({}, 'KnpPaginatorBundle') }} &nbsp;&raquo;
                 </a>
             </li>
diff --git a/templates/Pagination/foundation_v6_pagination.html.twig b/templates/Pagination/foundation_v6_pagination.html.twig
@@ -5,7 +5,7 @@
 
             {% if previous is defined %}
                 <li class="pagination-previous">
-                    <a rel="prev" href="{{ path(route, knp_pagination_query(query, previous)) }}">
+                    <a rel="prev" href="{{ path(route, knp_pagination_query(query, previous, options)) }}">
                         {{ 'label_previous'|trans({}, 'KnpPaginatorBundle') }}
                     </a>
                 </li>
@@ -17,11 +17,11 @@
 
             {% if startPage > 1 %}
                 <li>
-                    <a href="{{ path(route, knp_pagination_query(query, 1)) }}">1</a>
+                    <a href="{{ path(route, knp_pagination_query(query, 1, options)) }}">1</a>
                 </li>
                 {% if startPage == 3 %}
                     <li>
-                        <a href="{{ path(route, knp_pagination_query(query, 2)) }}">2</a>
+                        <a href="{{ path(route, knp_pagination_query(query, 2, options)) }}">2</a>
                     </li>
                 {% elseif startPage != 2 %}
                     <li class="ellipsis"></li>
@@ -31,7 +31,7 @@
             {% for page in pagesInRange %}
                 {% if page != current %}
                     <li>
-                        <a href="{{ path(route, knp_pagination_query(query, page)) }}">
+                        <a href="{{ path(route, knp_pagination_query(query, page, options)) }}">
                             {{ page }}
                         </a>
                     </li>
@@ -46,20 +46,20 @@
                         <li class="ellipsis"></li>
                     {% else %}
                         <li>
-                            <a href="{{ path(route, knp_pagination_query(query, (pageCount - 1))) }}">
+                            <a href="{{ path(route, knp_pagination_query(query, (pageCount - 1), options)) }}">
                                 {{ pageCount - 1 }}
                             </a>
                         </li>
                     {% endif %}
                 {% endif %}
                 <li>
-                    <a href="{{ path(route, knp_pagination_query(query, pageCount)) }}">{{ pageCount }}</a>
+                    <a href="{{ path(route, knp_pagination_query(query, pageCount, options)) }}">{{ pageCount }}</a>
                 </li>
             {% endif %}
 
             {% if next is defined %}
                 <li class="pagination-next">
-                    <a rel="next" href="{{ path(route, knp_pagination_query(query, next)) }}">
+                    <a rel="next" href="{{ path(route, knp_pagination_query(query, next, options)) }}">
                         {{ 'label_next'|trans({}, 'KnpPaginatorBundle') }}
                     </a>
                 </li>
diff --git a/templates/Pagination/materialize_pagination.html.twig b/templates/Pagination/materialize_pagination.html.twig
@@ -14,7 +14,7 @@
     <ul class="pagination">
         {% if first is defined and current != first %}
             <li class="waves-effect">
-                <a href="{{ path(route, knp_pagination_query(query, first)) }}">
+                <a href="{{ path(route, knp_pagination_query(query, first, options)) }}">
                     <i class="material-icons">first_page</i>
                 </a>
             </li>
@@ -28,7 +28,7 @@
 
         {% if previous is defined %}
             <li class="waves-effect">
-                <a rel="prev" href="{{ path(route, knp_pagination_query(query, previous)) }}">
+                <a rel="prev" href="{{ path(route, knp_pagination_query(query, previous, options)) }}">
                     <i class="material-icons">chevron_left</i>
                 </a>
             </li>
@@ -43,7 +43,7 @@
         {% for page in pagesInRange %}
             {% if page != current %}
                 <li class="waves-effect">
-                    <a href="{{ path(route, knp_pagination_query(query, page)) }}">{{ page }}</a>
+                    <a href="{{ path(route, knp_pagination_query(query, page, options)) }}">{{ page }}</a>
                 </li>
             {% else %}
                 <li class="active">
@@ -54,7 +54,7 @@
 
         {% if next is defined %}
             <li class="waves-effect">
-                <a rel="next" href="{{ path(route, knp_pagination_query(query, next)) }}">
+                <a rel="next" href="{{ path(route, knp_pagination_query(query, next, options)) }}">
                     <i class="material-icons">chevron_right</i>
                 </a>
             </li>
@@ -68,7 +68,7 @@
 
         {% if last is defined and current != last %}
             <li class="waves-effect">
-                <a href="{{ path(route, knp_pagination_query(query, last)) }}">
+                <a href="{{ path(route, knp_pagination_query(query, last, options)) }}">
                     <i class="material-icons">last_page</i>
                 </a>
             </li>
diff --git a/templates/Pagination/rel_links.html.twig b/templates/Pagination/rel_links.html.twig
@@ -1,9 +1,9 @@
 {% if pageCount > 1 %}
     {% if previous is defined %}
-        <link rel="prev" href="{{ path(route, knp_pagination_query(query, previous)) }}" />
+        <link rel="prev" href="{{ path(route, knp_pagination_query(query, previous, options)) }}" />
     {% endif %}
 
     {% if next is defined %}
-        <link rel="next" href="{{ path(route, knp_pagination_query(query, next)) }}" />
+        <link rel="next" href="{{ path(route, knp_pagination_query(query, next, options)) }}" />
     {% endif %}
 {% endif %}
diff --git a/templates/Pagination/semantic_ui_pagination.html.twig b/templates/Pagination/semantic_ui_pagination.html.twig
@@ -12,34 +12,34 @@
 #}
 <div class="ui pagination menu">
     {% if first is defined and current != first %}
-        <a class="icon item" href="{{ path(route, knp_pagination_query(query, first)) }}">
+        <a class="icon item" href="{{ path(route, knp_pagination_query(query, first, options)) }}">
             <i class="angle double left icon"></i>
         </a>
     {% endif %}
 
     {% if previous is defined %}
-        <a rel="prev" class="item icon" href="{{ path(route, knp_pagination_query(query, previous)) }}">
+        <a rel="prev" class="item icon" href="{{ path(route, knp_pagination_query(query, previous, options)) }}">
             <i class="angle left icon"></i>
         </a>
     {% endif %}
 
     {% for page in pagesInRange %}
         {% if page != current %}
-            <a class="item" href="{{ path(route, knp_pagination_query(query, page)) }}">{{ page }}</a>
+            <a class="item" href="{{ path(route, knp_pagination_query(query, page, options)) }}">{{ page }}</a>
         {% else %}
             <span class="active item">{{ page }}</span>
         {% endif %}
 
     {% endfor %}
 
     {% if next is defined %}
-        <a rel="next" class="icon item" href="{{ path(route, knp_pagination_query(query, next)) }}">
+        <a rel="next" class="icon item" href="{{ path(route, knp_pagination_query(query, next, options)) }}">
             <i class="angle right icon"></i>
         </a>
     {% endif %}
 
     {% if last is defined and current != last %}
-        <a class="icon item" href="{{ path(route, knp_pagination_query(query, last)) }}">
+        <a class="icon item" href="{{ path(route, knp_pagination_query(query, last, options)) }}">
             <i class="angle right double icon"></i>
         </a>
     {% endif %}
diff --git a/templates/Pagination/sliding.html.twig b/templates/Pagination/sliding.html.twig
@@ -3,20 +3,20 @@
     <div class="pagination">
         {% if first is defined and current != first %}
             <span class="first">
-                <a href="{{ path(route, knp_pagination_query(query, first)) }}">&lt;&lt;</a>
+                <a href="{{ path(route, knp_pagination_query(query, first, options)) }}">&lt;&lt;</a>
             </span>
         {% endif %}
 
         {% if previous is defined %}
             <span class="previous">
-                <a rel="prev" href="{{ path(route, knp_pagination_query(query, previous)) }}">&lt;</a>
+                <a rel="prev" href="{{ path(route, knp_pagination_query(query, previous, options)) }}">&lt;</a>
             </span>
         {% endif %}
 
         {% for page in pagesInRange %}
             {% if page != current %}
                 <span class="page">
-                    <a href="{{ path(route, knp_pagination_query(query, page)) }}">{{ page }}</a>
+                    <a href="{{ path(route, knp_pagination_query(query, page, options)) }}">{{ page }}</a>
                 </span>
             {% else %}
                 <span class="current">{{ page }}</span>
@@ -25,13 +25,13 @@
 
         {% if next is defined %}
             <span class="next">
-                <a rel="next" href="{{ path(route, knp_pagination_query(query, next)) }}">&gt;</a>
+                <a rel="next" href="{{ path(route, knp_pagination_query(query, next, options)) }}">&gt;</a>
             </span>
         {% endif %}
 
         {% if last is defined and current != last %}
             <span class="last">
-                <a href="{{ path(route, knp_pagination_query(query, last)) }}">&gt;&gt;</a>
+                <a href="{{ path(route, knp_pagination_query(query, last, options)) }}">&gt;&gt;</a>
             </span>
         {% endif %}
     </div>
diff --git a/templates/Pagination/tailwindcss_pagination.html.twig b/templates/Pagination/tailwindcss_pagination.html.twig
@@ -4,20 +4,20 @@
         <div class="flex items-baseline flex-row border border-gray-400 rounded-sm w-auto">
         {% if first is defined and current != first %}
             <span class="bg-white text-blue-600 px-3 py-2 text-lg border-r border-gray-400 font-bold">
-                <a href="{{ path(route, knp_pagination_query(query, first)) }}">&lt;&lt;</a>
+                <a href="{{ path(route, knp_pagination_query(query, first, options)) }}">&lt;&lt;</a>
             </span>
         {% endif %}
 
         {% if previous is defined %}
             <span class="bg-white text-blue-600 px-3 text-lg py-2 border-r border-gray-400">
-                <a rel="prev" href="{{ path(route, knp_pagination_query(query, previous)) }}">&lt;</a>
+                <a rel="prev" href="{{ path(route, knp_pagination_query(query, previous, options)) }}">&lt;</a>
             </span>
         {% endif %}
 
         {% for page in pagesInRange %}
             {% if page != current %}
                 <span class="bg-white text-blue-600 px-3 py-2 text-lg border-r  border-gray-400">
-                    <a href="{{ path(route, knp_pagination_query(query, page)) }}">{{ page }}</a>
+                    <a href="{{ path(route, knp_pagination_query(query, page, options)) }}">{{ page }}</a>
                 </span>
             {% else %}
                 <span class="bg-blue-600 text-white px-3 py-2 text-lg font-bold">{{ page }}</span>
@@ -26,13 +26,13 @@
 
         {% if next is defined %}
             <span class="bg-white text-blue-600 px-3 py-2 text-lg border-r border-gray-400">
-                <a rel="next" href="{{ path(route, knp_pagination_query(query, next)) }}">&gt;</a>
+                <a rel="next" href="{{ path(route, knp_pagination_query(query, next, options)) }}">&gt;</a>
             </span>
         {% endif %}
 
         {% if last is defined and current != last %}
             <span class="bg-white text-blue-600 px-3 py-2 text-lg border-gray-400 font-bold">
-                <a href="{{ path(route, knp_pagination_query(query, last)) }}">&gt;&gt;</a>
+                <a href="{{ path(route, knp_pagination_query(query, last, options)) }}">&gt;&gt;</a>
             </span>
         {% endif %}
         </div>
diff --git a/templates/Pagination/twitter_bootstrap_v4_pagination.html.twig b/templates/Pagination/twitter_bootstrap_v4_pagination.html.twig
diff --git a/templates/Pagination/uikit_v3_pagination.html.twig b/templates/Pagination/uikit_v3_pagination.html.twig

Original file line number	Diff line number	Diff line change
`@@ -109,20 +109,26 @@ public function filter(`
`109`	`109`	`}`
`110`	`110`
`111`	`111`	`/**`
`112`		`- * @param array<string, mixed> $query`
`113`		`- * @param int $page`
	`112`	`+ * @param array<string, mixed> $query`
	`113`	`+ * @param int $page`
	`114`	`+ * @param array<string, mixed> $options`
`114`	`115`	`* @return array<string, mixed>`
`115`	`116`	`*/`
`116`		`- public function getQueryParams(array $query, int $page): array`
	`117`	`+ public function getQueryParams(array $query, int $page, array $options): array`
`117`	`118`	`{`
	`119`	`+ $pageName = $this->pageName;`
	`120`	`+ if (isset($options['pageParameterName']) && is_string($options['pageParameterName'])) {`
	`121`	`+ $pageName = $options['pageParameterName'];`
	`122`	`+ }`
	`123`	`+`
`118`	`124`	`if ($page === 1 && $this->skipFirstPageLink) {`
`119`		`- if (isset($query[$this->pageName])) {`
`120`		`- unset($query[$this->pageName]);`
	`125`	`+ if (isset($query[$pageName])) {`
	`126`	`+ unset($query[$pageName]);`
`121`	`127`	`}`
`122`	`128`
`123`	`129`	`return $query;`
`124`	`130`	`}`
`125`	`131`
`126`		`- return array_merge($query, [$this->pageName => $page]);`
	`132`	`+ return array_merge($query, [$pageName => $page]);`
`127`	`133`	`}`
`128`	`134`	`}`