Fix #214: Improved interface hierarchy

CHANGELOG.md

@@ -39,6 +39,8 @@
 - Bug #195: Fix invalid count in `IterableDataReader` when limit or/and offset used (@vjik)
 - Enh #201: Disable sorting when limit is set explicitly in a paginator (@samdark)
 - Enh #202: Check that correct sort is passed to `withSort()` of keyset paginator (@samdark)
+- Enh #207: More specific Psalm type for `OffsetPaginator::withCurrentPage()` (@samdark)
+- Enh #214: Improved interface hierarchy (@samdark)
 - Enh #207: More specific Psalm type for `OffsetPaginator::withCurrentPage()` parameter (@samdark)
 - Enh #210: More specific Psalm type for `PaginatorInterface::getPageSize()` result (@vjik)
 

src/Paginator/OffsetPaginator.php

@@ -56,7 +56,7 @@ final class OffsetPaginator implements PaginatorInterface
     /**
      * Data reader being paginated.
      *
-     * @psalm-var ReadableDataInterface<TKey, TValue>&LimitableDataInterface&OffsetableDataInterface&CountableDataInterface
+     * @psalm-var ReadableDataInterface<TKey, TValue>&LimitableDataInterface<TKey, TValue>&OffsetableDataInterface<TKey, TValue>&CountableDataInterface
      */
     private ReadableDataInterface $dataReader;
 

src/Reader/DataReaderInterface.php

@@ -19,11 +19,13 @@
  * @template TKey as array-key
  * @template TValue as array|object
  *
- * @extends ReadableDataInterface<TKey, TValue>
+ * @extends LimitableDataInterface<TKey, TValue>
+ * @extends OffsetableDataInterface<TKey, TValue>
+ * @extends SortableDataInterface<TKey, TValue>
+ * @extends FilterableDataInterface<TKey, TValue>
  * @extends IteratorAggregate<TKey, TValue>
  */
 interface DataReaderInterface extends
-    ReadableDataInterface,
     LimitableDataInterface,
     OffsetableDataInterface,
     CountableDataInterface,

src/Reader/FilterableDataInterface.php

@@ -14,8 +14,13 @@
  *   {@see FilterInterface::getOperator()} is applied
  *
  * For performance reasons, prefer filtering as many items as possible in the first step.
+ *
+ * @template TKey as array-key
+ * @template TValue as array|object
+ *
+ * @extends ReadableDataInterface<TKey, TValue>
  */
-interface FilterableDataInterface
+interface FilterableDataInterface extends ReadableDataInterface
 {
     /**
      * Returns new instance with data reading criteria set.

src/Reader/LimitableDataInterface.php

@@ -8,8 +8,13 @@
 
 /**
  * Data that could be limited.
+ *
+ * @template TKey as array-key
+ * @template TValue as array|object
+ *
+ * @extends ReadableDataInterface<TKey, TValue>
  */
-interface LimitableDataInterface
+interface LimitableDataInterface extends ReadableDataInterface
 {
     /**
      * Get a new instance with the limit set.

src/Reader/OffsetableDataInterface.php

@@ -6,8 +6,13 @@
 
 /**
  * Data that could be read from Nth item by skipping items from the beginning.
+ *
+ * @template TKey as array-key
+ * @template TValue as array|object
+ *
+ * @extends ReadableDataInterface<TKey, TValue>
  */
-interface OffsetableDataInterface
+interface OffsetableDataInterface extends ReadableDataInterface
 {
     /**
      * Get a new instance with an offset set.

src/Reader/SortableDataInterface.php

@@ -7,8 +7,13 @@
 /**
  * A data set that could be sorted.
  * The sorting set may be used by a data reader that supports sorting.
+ *
+ * @template TKey as array-key
+ * @template TValue as array|object
+ *
+ * @extends ReadableDataInterface<TKey, TValue>
  */
-interface SortableDataInterface
+interface SortableDataInterface extends ReadableDataInterface
 {
     /**
      * Get a new instance with a sorting set.