<?php

/*
 * This file is part of the League\Fractal package.
 *
 * (c) Phil Sturgeon <me@philsturgeon.uk>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace League\Fractal\Pagination;

/**
 * A common interface for cursors to use.
 *
 * @author Isern Palaus <ipalaus@ipalaus.com>
 */
interface CursorInterface
{
    /**
     * Get the current cursor value.
     *
     * @return mixed
     */
    #[\ReturnTypeWillChange]
    public function getCurrent();

    /**
     * Get the prev cursor value.
     *
     * @return mixed
     */
    #[\ReturnTypeWillChange]
    public function getPrev();

    /**
     * Get the next cursor value.
     *
     * @return mixed
     */
    #[\ReturnTypeWillChange]
    public function getNext();

    /**
     * Returns the total items in the current cursor.
     */
    public function getCount(): ?int;
}
