Merge pull request #96 from garak/interface

add PaginatorInterface

Author: docteurklein

src/Knp/Component/Pager/Paginator.php

@@ -15,7 +15,7 @@
  * wanted target and finally it generates pagination view
  * which is only the result of paginator
  */
-class Paginator
+class Paginator implements PaginatorInterface
 {
     /**
      * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
@@ -80,7 +80,7 @@ public function setDefaultPaginatorOptions(array $options)
      * @throws \LogicException
      * @return \Knp\Component\Pager\Pagination\PaginationInterface
      */
-    public function paginate($target, $page = 1, $limit = 10, $options = array())
+    public function paginate($target, $page = 1, $limit = 10, array $options = array())
     {
         $limit = intval(abs($limit));
         if (!$limit) {

src/Knp/Component/Pager/PaginatorInterface.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Knp\Component\Pager;
+
+/**
+ * PaginatorInterface
+ */
+interface PaginatorInterface
+{
+    /**
+     * Paginates anything (depending on event listeners)
+     * into Pagination object, which is a view targeted
+     * pagination object (might be aggregated helper object)
+     * responsible for the pagination result representation
+     *
+     * @param mixed $target - anything what needs to be paginated
+     * @param integer $page - page number, starting from 1
+     * @param integer $limit - number of items per page
+     * @param array $options - less used options:
+     *     boolean $distinct - default true for distinction of results
+     *     string $alias - pagination alias, default none
+     *     array $whitelist - sortable whitelist for target fields being paginated
+     * @throws \LogicException
+     * @return \Knp\Component\Pager\Pagination\PaginationInterface
+     */
+    function paginate($target, $page = 1, $limit = 10, array $options = array());
+}