Paginator.php

TLDR

This file contains an interface Paginator in the Illuminate\Contracts\Pagination namespace. The interface defines methods for generating and manipulating paginated URLs, retrieving information about the current page, and rendering the paginator.

Methods

url($page)

Get the URL for a given page.

appends($key, $value = null)

Add a set of query string values to the paginator.

fragment($fragment = null)

Get / set the URL fragment to be appended to URLs.

nextPageUrl()

Get the URL for the next page, or null.

previousPageUrl()

Get the URL for the previous page, or null.

items()

Get all of the items being paginated.

firstItem()

Get the "index" of the first item being paginated.

lastItem()

Get the "index" of the last item being paginated.

perPage()

Determine how many items are being shown per page.

currentPage()

Determine the current page being paginated.

hasPages()

Determine if there are enough items to split into multiple pages.

hasMorePages()

Determine if there are more items in the data store.

path()

Get the base path for paginator generated URLs.

isEmpty()

Determine if the list of items is empty or not.

isNotEmpty()

Determine if the list of items is not empty.

render($view = null, $data = [])

Render the paginator using a given view.

END

<?php

namespace Illuminate\Contracts\Pagination;

interface Paginator
{
    /**
     * Get the URL for a given page.
     *
     * @param  int  $page
     * @return string
     */
    public function url($page);

    /**
     * Add a set of query string values to the paginator.
     *
     * @param  array|string|null  $key
     * @param  string|null  $value
     * @return $this
     */
    public function appends($key, $value = null);

    /**
     * Get / set the URL fragment to be appended to URLs.
     *
     * @param  string|null  $fragment
     * @return $this|string|null
     */
    public function fragment($fragment = null);

    /**
     * The URL for the next page, or null.
     *
     * @return string|null
     */
    public function nextPageUrl();

    /**
     * Get the URL for the previous page, or null.
     *
     * @return string|null
     */
    public function previousPageUrl();

    /**
     * Get all of the items being paginated.
     *
     * @return array
     */
    public function items();

    /**
     * Get the "index" of the first item being paginated.
     *
     * @return int|null
     */
    public function firstItem();

    /**
     * Get the "index" of the last item being paginated.
     *
     * @return int|null
     */
    public function lastItem();

    /**
     * Determine how many items are being shown per page.
     *
     * @return int
     */
    public function perPage();

    /**
     * Determine the current page being paginated.
     *
     * @return int
     */
    public function currentPage();

    /**
     * Determine if there are enough items to split into multiple pages.
     *
     * @return bool
     */
    public function hasPages();

    /**
     * Determine if there are more items in the data store.
     *
     * @return bool
     */
    public function hasMorePages();

    /**
     * Get the base path for paginator generated URLs.
     *
     * @return string|null
     */
    public function path();

    /**
     * Determine if the list of items is empty or not.
     *
     * @return bool
     */
    public function isEmpty();

    /**
     * Determine if the list of items is not empty.
     *
     * @return bool
     */
    public function isNotEmpty();

    /**
     * Render the paginator using a given view.
     *
     * @param  string|null  $view
     * @param  array  $data
     * @return string
     */
    public function render($view = null, $data = []);
}