Merge pull request #316 from Matth--/template-interface

garak · web-flow · commit 1e88f99aba58 · 2022-11-28T10:06:01.000+01:00
Add template docblocks for pagination
diff --git a/src/Knp/Component/Pager/Pagination/AbstractPagination.php b/src/Knp/Component/Pager/Pagination/AbstractPagination.php
@@ -4,6 +4,12 @@
 
 use Iterator;
 
+/**
+ * @template TKey
+ * @template TValue
+ *
+ * @template-implements PaginationInterface<TKey, TValue>
+ */
 abstract class AbstractPagination implements Iterator, PaginationInterface
 {
     protected ?int $currentPageNumber = null;
diff --git a/src/Knp/Component/Pager/Pagination/PaginationInterface.php b/src/Knp/Component/Pager/Pagination/PaginationInterface.php
@@ -8,6 +8,11 @@
  * Pagination interface strictly defines
  * the methods - paginator will use to populate the
  * pagination data
+ *
+ * @template TKey
+ * @template TValue
+ *
+ * @template-extends Traversable<TKey, TValue>
  */
 interface PaginationInterface extends Countable, Traversable, ArrayAccess
 {
@@ -32,10 +37,15 @@ public function setTotalItemCount(int $numTotal): void;
      */
     public function getTotalItemCount(): int;
 
+    /**
+     * @param iterable<TKey, TValue> $items
+     */
     public function setItems(iterable $items): void;
 
     /**
      * Get current items
+     *
+     * @return iterable<TKey, TValue>
      */
     public function getItems(): iterable;
 
diff --git a/src/Knp/Component/Pager/Pagination/SlidingPagination.php b/src/Knp/Component/Pager/Pagination/SlidingPagination.php
@@ -8,6 +8,11 @@
  * @todo: find a way to avoid exposing private member setters
  *
  * Sliding pagination
+ *
+ * @template TKey
+ * @template TValue
+ *
+ * @template-extends AbstractPagination<TKey, TValue>
  */
 final class SlidingPagination extends AbstractPagination
 {

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,11 @@`
`8`	`8`	`* @todo: find a way to avoid exposing private member setters`
`9`	`9`	`*`
`10`	`10`	`* Sliding pagination`
	`11`	`+ *`
	`12`	`+ * @template TKey`
	`13`	`+ * @template TValue`
	`14`	`+ *`
	`15`	`+ * @template-extends AbstractPagination<TKey, TValue>`
`11`	`16`	`*/`
`12`	`17`	`final class SlidingPagination extends AbstractPagination`
`13`	`18`	`{`