feat: add cursorPaginate() support (larastan#1198)

Co-authored-by: Viktor Szépe <[email protected]>

CHANGELOG.md

@@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 * fix: updated `composer/pcre` to new PHP relevant version
 * feat: add support for the `foreignId` column in migrations
+* feat: add support for the `cursorPaginate()` paginator
 
 ## [2.1.0] - 2022-03-04
 

stubs/Contracts/Pagination.stub

@@ -15,3 +15,10 @@ interface Paginator
  */
 interface LengthAwarePaginator extends Paginator
 {}
+
+/**
+ * @mixin \Illuminate\Support\Collection
+ * @mixin \Illuminate\Pagination\CursorPaginator
+ */
+interface CursorPaginator extends Paginator
+{}

stubs/EloquentBuilder.stub

@@ -465,6 +465,17 @@ class Builder
      * @return \Illuminate\Pagination\Paginator
      */
     public function simplePaginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null);
+
+    /**
+     * Paginate the given query into a cursor paginator.
+     *
+     * @param  int|null  $perPage
+     * @param  array<array-key, mixed>  $columns
+     * @param  string  $cursorName
+     * @param  \Illuminate\Pagination\Cursor|string|null  $cursor
+     * @return \Illuminate\Pagination\CursorPaginator
+     */
+     public function cursorPaginate($perPage = null, $columns = ['*'], $cursorName = 'cursor', $cursor = null);
 }
 
 class Scope {}

stubs/Pagination.stub

@@ -23,3 +23,17 @@ class Paginator extends AbstractPaginator implements \Illuminate\Contracts\Suppo
  */
 class LengthAwarePaginator extends AbstractPaginator implements \Illuminate\Contracts\Support\Arrayable, \ArrayAccess, \Countable, \IteratorAggregate, \Illuminate\Contracts\Support\Jsonable, \JsonSerializable, \Illuminate\Contracts\Pagination\LengthAwarePaginator
 {}
+
+/**
+ * @implements \ArrayAccess<mixed, mixed>
+ * @implements \IteratorAggregate<mixed, mixed>
+ * @implements \Illuminate\Contracts\Support\Arrayable<array-key, mixed>
+ */
+class CursorPaginator extends AbstractPaginator implements \Illuminate\Contracts\Support\Arrayable, \ArrayAccess, \Countable, \IteratorAggregate, \Illuminate\Contracts\Support\Jsonable, \JsonSerializable, \Illuminate\Contracts\Pagination\CursorPaginator
+{}
+
+/**
+ * @implements \Illuminate\Contracts\Support\Arrayable<array-key, mixed>
+ */
+class Cursor implements \Illuminate\Contracts\Support\Arrayable
+{}

tests/Type/data/paginator-extension.php

@@ -9,3 +9,4 @@
 
 assertType('array', User::paginate()->all());
 assertType('array', User::simplePaginate()->all());
+assertType('array', User::cursorPaginate()->all());