Permalink
Cannot retrieve contributors at this time
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
124 lines (107 sloc)
2.38 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?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 $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 | |
*/ | |
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 | |
*/ | |
public function firstItem(); | |
/** | |
* Get the "index" of the last item being paginated. | |
* | |
* @return int | |
*/ | |
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 = []); | |
} |