support of query parameter name changes, closes KnpLabs#87

Author: l3pp4rd

DependencyInjection/Configuration.php

@@ -14,6 +14,15 @@ public function getConfigTreeBuilder()
         $builder->root('knp_paginator')
             ->addDefaultsIfNotSet()
             ->children()
+                ->arrayNode('default_options')
+                    ->addDefaultsIfNotSet()
+                    ->children()
+                        ->scalarNode('sort_field_name')->defaultValue('sort')->end()
+                        ->scalarNode('sort_direction_name')->defaultValue('direction')->end()
+                        ->scalarNode('page_name')->defaultValue('page')->end()
+                        ->booleanNode('distinct')->defaultTrue()->end()
+                    ->end()
+                ->end()
                 ->arrayNode('template')
                     ->addDefaultsIfNotSet()
                     ->children()

DependencyInjection/KnpPaginatorExtension.php

@@ -29,5 +29,13 @@ public function load(array $configs, ContainerBuilder $container)
         $container->setParameter('knp_paginator.template.pagination', $config['template']['pagination']);
         $container->setParameter('knp_paginator.template.sortable', $config['template']['sortable']);
         $container->setParameter('knp_paginator.page_range', $config['page_range']);
+
+        $paginatorDef = $container->getDefinition('knp_paginator');
+        $paginatorDef->addMethodCall('setDefaultPaginatorOptions', array(array(
+            'pageParameterName' => $config['default_options']['page_name'],
+            'sortFieldParameterName' => $config['default_options']['sort_field_name'],
+            'sortDirectionParameterName' => $config['default_options']['sort_direction_name'],
+            'distinct' => $config['default_options']['distinct']
+        )));
     }
 }

Pagination/SlidingPagination.php

@@ -47,16 +47,6 @@ public function setTemplate($template)
         $this->template = $template;
     }
 
-    public function setExtraViewParams(array $params)
-    {
-        $this->extraViewParams = $params;
-    }
-
-    public function setExtraViewParam($name, $param)
-    {
-        $this->extraViewParams[$name] = $param;
-    }
-
     public function setPageRange($range)
     {
         $this->pageRange = abs(intval($range));
@@ -77,9 +67,13 @@ public function render($template = null, array $queryParams = array(), array $vi
         }
         $data = $this->getPaginationData();
         $data['route'] = $this->route;
-        $data['alias'] = $this->alias;
         $data['query'] = array_merge($this->params, $queryParams);
-        $data = array_merge($this->extraViewParams, $viewParams, $data/* cannot be broken*/);
+        $data = array_merge(
+            $this->paginatorOptions, // options given to paginator when paginated
+            $this->customParameters, // all custom parameters for view
+            $viewParams, // additional custom parameters for view
+            $data // merging base route parameters last, to avoid broke of integrity
+        );
         return $this->engine->render($this->template, $data);
     }
 
@@ -105,11 +99,15 @@ public function sortable($title, $key, $options = array(), $params = array(), $t
         ), $options);
 
         $params = array_merge($this->params, $params);
-        $direction = isset($options[$this->alias.'direction']) ? $options[$this->alias.'direction'] : 'asc';
+        $direction = isset($options[$this->getPaginatorOption('sortDirectionParameterName')]) ?
+            $options[$this->getPaginatorOption('sortDirectionParameterName')] : 'asc'
+        ;
 
-        $sorted = isset($params[$this->alias.'sort']) && $params[$this->alias.'sort'] == $key;
+        $sorted = isset($params[$this->getPaginatorOption('sortFieldParameterName')])
+            && $params[$this->getPaginatorOption('sortFieldParameterName')] == $key
+        ;
         if ($sorted) {
-            $direction = $params[$this->alias.'direction'];
+            $direction = $params[$this->getPaginatorOption('sortDirectionParameterName')];
             $direction = (strtolower($direction) == 'asc') ? 'desc' : 'asc';
             $class = $direction == 'asc' ? 'desc' : 'asc';
             if (isset($options['class'])) {
@@ -125,7 +123,11 @@ public function sortable($title, $key, $options = array(), $params = array(), $t
         }
         $params = array_merge(
             $params,
-            array($this->alias.'sort' => $key, $this->alias.'direction' => $direction, $this->alias.'page' => 1)
+            array(
+                $this->getPaginatorOption('sortFieldParameterName') => $key,
+                $this->getPaginatorOption('sortDirectionParameterName') => $direction,
+                $this->getPaginatorOption('pageParameterName') => 1 // reset to 1 on sort
+            )
         );
 
         $options['href'] = $this->routerHelper->generate($this->route, $params, $options['absolute']);
@@ -140,9 +142,11 @@ public function sortable($title, $key, $options = array(), $params = array(), $t
             $this->sortableTemplate = $template;
         }
 
-        $alias = $this->alias;
-
-        return $this->engine->render($this->sortableTemplate, compact('options', 'title', 'direction', 'sorted', 'key', 'alias'));
+        return $this->engine->render($this->sortableTemplate, array_merge(
+            $this->paginatorOptions,
+            $this->customParameters,
+            compact('options', 'title', 'direction', 'sorted', 'key')
+        ));
     }
 
     public function getPaginationData()

Resources/views/Pagination/sliding.html.twig

@@ -2,22 +2,22 @@
 
 {% if pageCount > 1 %}
 <div class="pagination">
-	{% if first is defined and current != first %}
+    {% if first is defined and current != first %}
         <span class="first">
-        	<a href="{{ path(route, query|merge({'page': first})) }}">&lt;&lt;</a>
+            <a href="{{ path(route, query|merge({(pageParameterName): first})) }}">&lt;&lt;</a>
         </span>
     {% endif %}
 
     {% if previous is defined %}
         <span class="previous">
-        	<a href="{{ path(route, query|merge({'page': previous})) }}">&lt;</a>
+            <a href="{{ path(route, query|merge({(pageParameterName): previous})) }}">&lt;</a>
         </span>
     {% endif %}
 
     {% for page in pagesInRange %}
         {% if page != current %}
             <span class="page">
-            	<a href="{{ path(route, query|merge({'page': page})) }}">{{ page }}</a>
+                <a href="{{ path(route, query|merge({(pageParameterName): page})) }}">{{ page }}</a>
             </span>
         {% else %}
             <span class="current">{{ page }}</span>
@@ -27,13 +27,13 @@
 
     {% if next is defined %}
         <span class="next">
-        	<a href="{{ path(route, query|merge({'page': next})) }}">&gt;</a>
+            <a href="{{ path(route, query|merge({(pageParameterName): next})) }}">&gt;</a>
         </span>
     {% endif %}
 
     {% if last is defined and current != last %}
         <span class="last">
-        	<a href="{{ path(route, query|merge({'page': last})) }}">&gt;&gt;</a>
+            <a href="{{ path(route, query|merge({(pageParameterName): last})) }}">&gt;&gt;</a>
         </span>
     {% endif %}
 </div>

Subscriber/SlidingPaginationSubscriber.php

@@ -52,7 +52,6 @@ public function pagination(PaginationEvent $event)
             $this->params
         );
         $pagination->setUsedRoute($this->route);
-        $pagination->setAlias($event->options['alias']);
         $pagination->setTemplate($this->options['defaultPaginationTemplate']);
         $pagination->setSortableTemplate($this->options['defaultSortableTemplate']);
         $pagination->setPageRange($this->options['defaultPageRange']);