Phalcon Paginator

/**
 * Configuration of paginator
 *
 * @var array
 */
protected $config;

/**
 * Number of rows to show in the paginator. By default is null
 *
 * @var int|null
 */
protected $limitRows;

/**
 * Current page in paginate
 *
 * @var int|null
 */
protected $page;

/**
 * Repository for pagination
 *
 * @var RepositoryInterface
 */
protected $repository;

public function __construct( array $config );

public function getLimit(): int;

public function setCurrentPage( int $page ): AdapterInterface;

public function setLimit( int $limit ): AdapterInterface;

public function setRepository( RepositoryInterface $repository ): AdapterInterface;

protected function getRepository( array $properties = null ): RepositoryInterface;

use Phalcon\Paginator\Adapter\Model;

$paginator = new Model(
    [
        "model" => Robots::class,
        "limit" => 25,
        "page"  => $currentPage,
    ]
);


$paginator = new Model(
    [
        "model" => Robots::class,
        "parameters" => [
             "columns" => "id, name"
        ],
        "limit" => 12,
        "page"  => $currentPage,
    ]
);


$paginator = new Model(
    [
        "model" => Robots::class,
        "parameters" => [
             "type = :type:",
             "bind" => [
                 "type" => "mechanical"
             ],
             "order" => "name"
        ],
        "limit" => 16,
        "page"  => $currentPage,
    ]
);

$paginator = new Model(
    [
        "model" => Robots::class,
        "parameters" => "(id % 2) = 0",
        "limit" => 8,
        "page"  => $currentPage,
    ]
);


$paginator = new Model(
    [
        "model" => Robots::class,
        "parameters" => [ "(id % 2) = 0" ],
        "limit" => 8,
        "page"  => $currentPage,
    ]
);

$paginate = $paginator->paginate();

public function paginate(): RepositoryInterface;

use Phalcon\Paginator\Adapter\NativeArray;

$paginator = new NativeArray(
    [
        "data"  => [
            ["id" => 1, "name" => "Artichoke"],
            ["id" => 2, "name" => "Carrots"],
            ["id" => 3, "name" => "Beet"],
            ["id" => 4, "name" => "Lettuce"],
            ["id" => 5, "name" => ""],
        ],
        "limit" => 2,
        "page"  => $currentPage,
    ]
);

public function paginate(): RepositoryInterface;

use Phalcon\Paginator\Adapter\QueryBuilder;

$builder = $this->modelsManager->createBuilder()
                ->columns("id, name")
                ->from(Robots::class)
                ->orderBy("name");

$paginator = new QueryBuilder(
    [
        "builder" => $builder,
        "limit"   => 20,
        "page"    => 1,
    ]
);

/**
 * Paginator's data
 *
 * @var Builder
 */
protected $builder;

/**
 * Columns for count query if builder has having or group by
 *
 * @var array|string
 */
protected $columns;

public function __construct( array $config );

public function getCurrentPage(): int;

public function getQueryBuilder(): Builder;

public function paginate(): RepositoryInterface;

public function setQueryBuilder( Builder $builder ): QueryBuilder;

use Phalcon\Paginator\Adapter\QueryBuilderCursor;

$builder = $this->modelsManager->createBuilder()
                ->columns("inv_id, inv_title")
                ->from(Invoices::class)
                ->orderBy("inv_id");

$paginator = new QueryBuilderCursor(
    [
        "builder"      => $builder,
        "limit"        => 20,
        "cursorColumn" => "inv_id",
        "cursor"       => null,  // first page; pass $page->getNext() for subsequent pages
    ]
);

$page = $paginator->paginate();
// $page->getItems()   - array of rows for this page
// $page->getNext()    - cursor value to pass for the next page (0 means no more pages)
// $page->getCurrent() - cursor value used for this page (0 on first page)

/**
 * Paginator's data
 *
 * @var Builder
 */
protected $builder;

/**
 * The cursor value for the current page (null = first page)
 *
 * @var mixed
 */
protected $cursor;

/**
 * The column used as the cursor (must be unique and indexed)
 *
 * @var string
 */
protected $cursorColumn;

public function __construct( array $config );

public function getCurrentPage(): int;

public function getCursor(): mixed;

public function getCursorColumn(): string;

public function getQueryBuilder(): Builder;

public function paginate(): RepositoryInterface;

public function setCursor( mixed $cursor ): QueryBuilderCursor;

public function setQueryBuilder( Builder $builder ): QueryBuilderCursor;

public function __construct( array $services = [] );

public function load( mixed $config ): AdapterInterface;

use Phalcon\Paginator\PaginatorFactory;

$builder = $this
     ->modelsManager
     ->createBuilder()
     ->columns("id, name")
     ->from(Robots::class)
     ->orderBy("name");

$options = [
    "builder" => $builder,
    "limit"   => 20,
    "page"    => 1,
    "adapter" => "queryBuilder",
];

$paginator = (new PaginatorFactory())->load($options);

public function newInstance( string $name, array $options = [] ): AdapterInterface;

protected function getExceptionClass(): string;

protected function getServices(): array;

/**
 * @var array
 */
protected $aliases;

/**
 * @var array
 */
protected $properties;

public function __get( string $property ): mixed | null;

public function getAliases(): array;

public function getCurrent(): int;

public function getFirst(): int;

public function getItems(): mixed;

public function getLast(): int;

public function getLimit(): int;

public function getNext(): int;

public function getPrevious(): int;

public function getTotalItems(): int;

public function jsonSerialize(): array;

public function setAliases( array $aliases ): RepositoryInterface;

public function setProperties( array $properties ): RepositoryInterface;

protected function getProperty( string $property, mixed $defaultValue = null ): mixed;

protected function getRealNameProperty( string $property ): string;