UrlWindow.php
TLDR
The UrlWindow.php file is a class that provides a window of URLs for pagination. It takes in a paginator instance and generates a set of URLs to be shown based on the current page and the number of pages. The URL window can vary depending on the number of pages and the proximity of the current page to the beginning or end of the page range.
Methods
make
This static method creates a new URL window instance and returns the generated URL window.
get
This method returns the window of URLs to be shown. It determines the size and contents of the URL window based on the number of pages and the current page's position within the page range.
getSmallSlider
This protected method returns the slider of URLs when there are not enough pages to create a full slider. It includes the URLs for the first and last pages and sets the slider as null.
getUrlSlider
This protected method creates a URL slider based on the current page's position within the page range. It generates a URL window that provides a sliding paginator setup similar to Google's style.
getSliderTooCloseToBeginning
This protected method returns the slider of URLs when the current page is too close to the beginning of the page range to create a full slider. It includes the URLs for the first page, a null value for the slider, and the URLs for the last pages.
getSliderTooCloseToEnding
This protected method returns the slider of URLs when the current page is too close to the ending of the page range to create a full slider. It includes the URLs for the first pages, a null value for the slider, and the URLs for the last page.
getFullSlider
This protected method returns the slider of URLs when there is enough room on both sides of the current page to create a full slider. It includes the URLs for the first page, the URLs for the adjacent pages, and the URLs for the last page.
getAdjacentUrlRange
This method returns the page range for the current page window. It returns the URLs for the pages preceding and succeeding the current page based on the specified number of adjacent pages.
getStart
This method returns the starting URLs of a pagination slider. It includes the URLs for the first two pages.
getFinish
This method returns the ending URLs of a pagination slider. It includes the URLs for the last two pages.
hasPages
This method determines if the underlying paginator being presented has pages to show. It returns true if there are more than one page, and false otherwise.
currentPage
This protected method returns the current page from the paginator.
lastPage
This protected method returns the last page from the paginator.
<?php
namespace Illuminate\Pagination;
use Illuminate\Contracts\Pagination\LengthAwarePaginator as PaginatorContract;
class UrlWindow
{
/**
* The paginator implementation.
*
* @var \Illuminate\Contracts\Pagination\LengthAwarePaginator
*/
protected $paginator;
/**
* Create a new URL window instance.
*
* @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
* @return void
*/
public function __construct(PaginatorContract $paginator)
{
$this->paginator = $paginator;
}
/**
* Create a new URL window instance.
*
* @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
* @return array
*/
public static function make(PaginatorContract $paginator)
{
return (new static($paginator))->get();
}
/**
* Get the window of URLs to be shown.
*
* @return array
*/
public function get()
{
$onEachSide = $this->paginator->onEachSide;
if ($this->paginator->lastPage() < ($onEachSide * 2) + 8) {
return $this->getSmallSlider();
}
return $this->getUrlSlider($onEachSide);
}
/**
* Get the slider of URLs there are not enough pages to slide.
*
* @return array
*/
protected function getSmallSlider()
{
return [
'first' => $this->paginator->getUrlRange(1, $this->lastPage()),
'slider' => null,
'last' => null,
];
}
/**
* Create a URL slider links.
*
* @param int $onEachSide
* @return array
*/
protected function getUrlSlider($onEachSide)
{
$window = $onEachSide + 4;
if (! $this->hasPages()) {
return ['first' => null, 'slider' => null, 'last' => null];
}
// If the current page is very close to the beginning of the page range, we will
// just render the beginning of the page range, followed by the last 2 of the
// links in this list, since we will not have room to create a full slider.
if ($this->currentPage() <= $window) {
return $this->getSliderTooCloseToBeginning($window, $onEachSide);
}
// If the current page is close to the ending of the page range we will just get
// this first couple pages, followed by a larger window of these ending pages
// since we're too close to the end of the list to create a full on slider.
elseif ($this->currentPage() > ($this->lastPage() - $window)) {
return $this->getSliderTooCloseToEnding($window, $onEachSide);
}
// If we have enough room on both sides of the current page to build a slider we
// will surround it with both the beginning and ending caps, with this window
// of pages in the middle providing a Google style sliding paginator setup.
return $this->getFullSlider($onEachSide);
}
/**
* Get the slider of URLs when too close to the beginning of the window.
*
* @param int $window
* @param int $onEachSide
* @return array
*/
protected function getSliderTooCloseToBeginning($window, $onEachSide)
{
return [
'first' => $this->paginator->getUrlRange(1, $window + $onEachSide),
'slider' => null,
'last' => $this->getFinish(),
];
}
/**
* Get the slider of URLs when too close to the ending of the window.
*
* @param int $window
* @param int $onEachSide
* @return array
*/
protected function getSliderTooCloseToEnding($window, $onEachSide)
{
$last = $this->paginator->getUrlRange(
$this->lastPage() - ($window + ($onEachSide - 1)),
$this->lastPage()
);
return [
'first' => $this->getStart(),
'slider' => null,
'last' => $last,
];
}
/**
* Get the slider of URLs when a full slider can be made.
*
* @param int $onEachSide
* @return array
*/
protected function getFullSlider($onEachSide)
{
return [
'first' => $this->getStart(),
'slider' => $this->getAdjacentUrlRange($onEachSide),
'last' => $this->getFinish(),
];
}
/**
* Get the page range for the current page window.
*
* @param int $onEachSide
* @return array
*/
public function getAdjacentUrlRange($onEachSide)
{
return $this->paginator->getUrlRange(
$this->currentPage() - $onEachSide,
$this->currentPage() + $onEachSide
);
}
/**
* Get the starting URLs of a pagination slider.
*
* @return array
*/
public function getStart()
{
return $this->paginator->getUrlRange(1, 2);
}
/**
* Get the ending URLs of a pagination slider.
*
* @return array
*/
public function getFinish()
{
return $this->paginator->getUrlRange(
$this->lastPage() - 1,
$this->lastPage()
);
}
/**
* Determine if the underlying paginator being presented has pages to show.
*
* @return bool
*/
public function hasPages()
{
return $this->paginator->lastPage() > 1;
}
/**
* Get the current page from the paginator.
*
* @return int
*/
protected function currentPage()
{
return $this->paginator->currentPage();
}
/**
* Get the last page from the paginator.
*
* @return int
*/
protected function lastPage()
{
return $this->paginator->lastPage();
}
}