Inspection of "Pagination feature" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#154)

unknown

created 2024-09-10 14:57 UTC

Status

Indentation +324 added lines, -324 removed lines patch added patch discarded remove patch

@@ -4,329 +4,329 @@
 block discarded – undo
 
 abstract class BasePaginator implements PaginatorInterface
 {
-	/**
-	 * @var string
-	 */
-	protected const PAGINATION_CLASS = 'pagination';
-
-	/**
-	 * @var string
-	 */
-	protected const PAGINATION_CLASS_ACTIVE = 'active';
-
-	/**
-	 * @var string
-	 */
-	protected const PER_PAGE = 'per_page';
-
-	/**
-	 * @var string
-	 */
-	protected const PAGE = 'page';
-
-	/**
-	 * @var int
-	 */
-	protected const FIRST_PAGE_NUMBER = 1;
-
-	/**
-	 * @var int
-	 */
-	protected const MINIMUM_PAGE_ITEMS_COUNT = 3;
-
-	/**
-	 * @var int
-	 */
-	protected const EDGE_PADDING = 3;
-
-	/**
-	 * @var int
-	 */
-	protected $total;
-
-	/**
-	 * @var string
-	 */
-	protected $baseUrl;
-
-	/**
-	 * @var int
-	 */
-	protected $perPage;
-
-	/**
-	 * @var int
-	 */
-	protected $page;
-
-	/**
-	 * @return int
-	 */
-	public function currentPageNumber(): int
-	{
-		return $this->page;
-	}
-
-	/**
-	 * @param bool $withBaseUrl
-	 * @return string|null
-	 */
-	public function currentPageLink(bool $withBaseUrl = false): ?string
-	{
-		return $this->getPageLink($this->page, $withBaseUrl);
-	}
-
-	/**
-	 * @return int|null
-	 */
-	public function previousPageNumber(): ?int
-	{
-		$previous = null;
-		if ($this->page > 1) {
-			$previous = $this->page - 1;
-		} elseif ($this->page == 1) {
-			$previous = $this->page;
-		}
-
-		return $previous;
-	}
-
-	/**
-	 * @param bool $withBaseUrl
-	 * @return string|null
-	 */
-	public function previousPageLink(bool $withBaseUrl = false): ?string
-	{
-		return $this->getPageLink($this->previousPageNumber(), $withBaseUrl);
-	}
-
-	/**
-	 * @return int|null
-	 */
-	public function nextPageNumber(): ?int
-	{
-		$next = null;
-		if ($this->page < $this->lastPageNumber()) {
-			$next = $this->page + 1;
-		} elseif ($this->page == $this->lastPageNumber()) {
-			$next = $this->page;
-		}
-		return $next;
-	}
-
-	/**
-	 * @param bool $withBaseUrl
-	 * @return string|null
-	 */
-	public function nextPageLink(bool $withBaseUrl = false): ?string
-	{
-		return $this->getPageLink($this->nextPageNumber(), $withBaseUrl);
-	}
-
-	/**
-	 * @param bool $withBaseUrl
-	 * @return string|null
-	 */
-	public function firstPageLink(bool $withBaseUrl = false): ?string
-	{
-		return $this->getPageLink(self::FIRST_PAGE_NUMBER, $withBaseUrl);
-	}
-
-	/**
-	 * @return int
-	 */
-	public function lastPageNumber(): int
-	{
-		return (int)ceil($this->total() / $this->perPage);
-	}
-
-	/**
-	 * @param bool $withBaseUrl
-	 * @return string|null
-	 */
-	public function lastPageLink(bool $withBaseUrl = false): ?string
-	{
-		return $this->getPageLink($this->lastPageNumber(), $withBaseUrl);
-	}
-
-	/**
-	 * @return int
-	 */
-	public function perPage(): int
-	{
-		return $this->perPage;
-	}
-
-	/**
-	 * @return int
-	 */
-	public function total(): int
-	{
-		return $this->total;
-	}
-
-	/**
-	 * @param bool $withBaseUrl
-	 * @return array
-	 */
-	public function links(bool $withBaseUrl = false): array
-	{
-		$links = [];
-		for ($i = 1; $i <= $this->lastPageNumber(); $i++) {
-			$links[] = $this->getPageLink($i, $withBaseUrl);
-		}
-
-		return $links;
-	}
-
-	/**
-	 * @param bool $withBaseUrl
-	 * @return string
-	 */
-	protected function getUri(bool $withBaseUrl = false): string
-	{
-		$routeUrl = preg_replace('/([?&](page|per_page)=\d+)/', '', route_uri());
-		$routeUrl = preg_replace('/&/', '?', $routeUrl, 1);
-		$url = $routeUrl;
-
-		if ($withBaseUrl) {
-			$url = $this->baseUrl . $routeUrl;
-		}
-
-		$delimiter = strpos($url, '?') ? '&' : '?';
-		return $url . $delimiter;
-	}
-
-	protected function getPageLink($pageNumber, $withBaseUrl = false): ?string
-	{
-		if (!empty($pageNumber)){
-			return $this->getUri($withBaseUrl) . self::PER_PAGE .'=' . $this->perPage . '&'. self::PAGE .'=' . $pageNumber;
-		}
-		return null;
-	}
-
-	/**
-	 * @param bool $withBaseUrl
-	 * @param $pageItemsCount
-	 * @return string|null
-	 */
-	public function getPagination(bool $withBaseUrl = false, $pageItemsCount = null): ?string
-	{
-		$totalPages = $this->lastPageNumber();
-		if ($totalPages <= 1) {
-			return null;
-		}
-
-		if (!is_null($pageItemsCount) && $pageItemsCount < self::MINIMUM_PAGE_ITEMS_COUNT) {
-			$pageItemsCount = self::MINIMUM_PAGE_ITEMS_COUNT;
-		}
-
-		$pagination = '<ul class="'. self::PAGINATION_CLASS .'">';
-		$currentPage = $this->currentPageNumber();
+    /**
+     * @var string
+     */
+    protected const PAGINATION_CLASS = 'pagination';
+
+    /**
+     * @var string
+     */
+    protected const PAGINATION_CLASS_ACTIVE = 'active';
+
+    /**
+     * @var string
+     */
+    protected const PER_PAGE = 'per_page';
+
+    /**
+     * @var string
+     */
+    protected const PAGE = 'page';
+
+    /**
+     * @var int
+     */
+    protected const FIRST_PAGE_NUMBER = 1;
+
+    /**
+     * @var int
+     */
+    protected const MINIMUM_PAGE_ITEMS_COUNT = 3;
+
+    /**
+     * @var int
+     */
+    protected const EDGE_PADDING = 3;
+
+    /**
+     * @var int
+     */
+    protected $total;
+
+    /**
+     * @var string
+     */
+    protected $baseUrl;
+
+    /**
+     * @var int
+     */
+    protected $perPage;
+
+    /**
+     * @var int
+     */
+    protected $page;
+
+    /**
+     * @return int
+     */
+    public function currentPageNumber(): int
+    {
+        return $this->page;
+    }
+
+    /**
+     * @param bool $withBaseUrl
+     * @return string|null
+     */
+    public function currentPageLink(bool $withBaseUrl = false): ?string
+    {
+        return $this->getPageLink($this->page, $withBaseUrl);
+    }
+
+    /**
+     * @return int|null
+     */
+    public function previousPageNumber(): ?int
+    {
+        $previous = null;
+        if ($this->page > 1) {
+            $previous = $this->page - 1;
+        } elseif ($this->page == 1) {
+            $previous = $this->page;
+        }
+
+        return $previous;
+    }
+
+    /**
+     * @param bool $withBaseUrl
+     * @return string|null
+     */
+    public function previousPageLink(bool $withBaseUrl = false): ?string
+    {
+        return $this->getPageLink($this->previousPageNumber(), $withBaseUrl);
+    }
+
+    /**
+     * @return int|null
+     */
+    public function nextPageNumber(): ?int
+    {
+        $next = null;
+        if ($this->page < $this->lastPageNumber()) {
+            $next = $this->page + 1;
+        } elseif ($this->page == $this->lastPageNumber()) {
+            $next = $this->page;
+        }
+        return $next;
+    }
+
+    /**
+     * @param bool $withBaseUrl
+     * @return string|null
+     */
+    public function nextPageLink(bool $withBaseUrl = false): ?string
+    {
+        return $this->getPageLink($this->nextPageNumber(), $withBaseUrl);
+    }
+
+    /**
+     * @param bool $withBaseUrl
+     * @return string|null
+     */
+    public function firstPageLink(bool $withBaseUrl = false): ?string
+    {
+        return $this->getPageLink(self::FIRST_PAGE_NUMBER, $withBaseUrl);
+    }
+
+    /**
+     * @return int
+     */
+    public function lastPageNumber(): int
+    {
+        return (int)ceil($this->total() / $this->perPage);
+    }
+
+    /**
+     * @param bool $withBaseUrl
+     * @return string|null
+     */
+    public function lastPageLink(bool $withBaseUrl = false): ?string
+    {
+        return $this->getPageLink($this->lastPageNumber(), $withBaseUrl);
+    }
+
+    /**
+     * @return int
+     */
+    public function perPage(): int
+    {
+        return $this->perPage;
+    }
+
+    /**
+     * @return int
+     */
+    public function total(): int
+    {
+        return $this->total;
+    }
+
+    /**
+     * @param bool $withBaseUrl
+     * @return array
+     */
+    public function links(bool $withBaseUrl = false): array
+    {
+        $links = [];
+        for ($i = 1; $i <= $this->lastPageNumber(); $i++) {
+            $links[] = $this->getPageLink($i, $withBaseUrl);
+        }
+
+        return $links;
+    }
+
+    /**
+     * @param bool $withBaseUrl
+     * @return string
+     */
+    protected function getUri(bool $withBaseUrl = false): string
+    {
+        $routeUrl = preg_replace('/([?&](page|per_page)=\d+)/', '', route_uri());
+        $routeUrl = preg_replace('/&/', '?', $routeUrl, 1);
+        $url = $routeUrl;
+
+        if ($withBaseUrl) {
+            $url = $this->baseUrl . $routeUrl;
+        }
+
+        $delimiter = strpos($url, '?') ? '&' : '?';
+        return $url . $delimiter;
+    }
+
+    protected function getPageLink($pageNumber, $withBaseUrl = false): ?string
+    {
+        if (!empty($pageNumber)){
+            return $this->getUri($withBaseUrl) . self::PER_PAGE .'=' . $this->perPage . '&'. self::PAGE .'=' . $pageNumber;
+        }
+        return null;
+    }
+
+    /**
+     * @param bool $withBaseUrl
+     * @param $pageItemsCount
+     * @return string|null
+     */
+    public function getPagination(bool $withBaseUrl = false, $pageItemsCount = null): ?string
+    {
+        $totalPages = $this->lastPageNumber();
+        if ($totalPages <= 1) {
+            return null;
+        }
+
+        if (!is_null($pageItemsCount) && $pageItemsCount < self::MINIMUM_PAGE_ITEMS_COUNT) {
+            $pageItemsCount = self::MINIMUM_PAGE_ITEMS_COUNT;
+        }
+
+        $pagination = '<ul class="'. self::PAGINATION_CLASS .'">';
+        $currentPage = $this->currentPageNumber();
 		
-		if ($currentPage > 1) {
-			$pagination .= $this->getPreviousPageItem($this->previousPageLink());
-		}
-
-		if ($pageItemsCount) {
-			$pagination = $this->getPageItems($pagination, $currentPage, $totalPages, $pageItemsCount, $withBaseUrl);
-		}
-
-		if ($currentPage < $totalPages) {
-			$pagination .= $this->getNextPageItem($this->nextPageLink());
-		}
-
-		$pagination .= '</ul>';
-
-		return $pagination;
-	}
-
-	/**
-	 * @param $pagination
-	 * @param $currentPage
-	 * @param $totalPages
-	 * @param $pageItemsCount
-	 * @param bool $withBaseUrl
-	 * @return mixed|string
-	 */
-	protected function getPageItems($pagination, $currentPage, $totalPages, $pageItemsCount, bool $withBaseUrl = false)
-	{
-		$startPage = $this->calculateStartPage($currentPage, $pageItemsCount);
-		$endPage = $this->calculateEndPage($startPage, $totalPages, $pageItemsCount);
-
-		$pagination = $this->addFirstPageLink($pagination, $startPage);
-
-		$links = $this->links($withBaseUrl);
-		$pagination = $this->getItemsLinks($pagination, $startPage, $endPage, $currentPage, $links);
-
-		return $this->addLastPageLink($pagination, $endPage, $totalPages, $links);
-	}
-
-	/**
-	 * @param string|null $nextPageLink
-	 * @return string
-	 */
-	protected function getNextPageItem(?string $nextPageLink): string
-	{
-		$link = '';
-		if (!empty($nextPageLink)){
-			$link = '<li><a href="' . $nextPageLink . '">Next &raquo;</a></li>';
-		}
-		return $link;
-	}
-
-	/**
-	 * @param string|null $previousPageLink
-	 * @return string
-	 */
-	protected function getPreviousPageItem(?string $previousPageLink): string
-	{
-		$link = '';
-		if (!empty($previousPageLink)){
-			$link = '<li><a href="' . $previousPageLink . '">&laquo; Previous</a></li>';
-		}
-		return $link;
-	}
-
-	protected function getItemsLinks($pagination, $startPage, $endPage, $currentPage, array $links)
-	{
-		for ($i = $startPage; $i <= $endPage; $i++) {
-			$active = $i == $currentPage ? 'class="'. self::PAGINATION_CLASS_ACTIVE .'"' : '';
-			$pagination .= '<li ' . $active . '><a href="' . $links[$i - 1] . '">' . $i . '</a></li>';
-		}
-		return $pagination;
-	}
-
-	protected function calculateStartPage($currentPage, $pageItemsCount)
-	{
-		return max(1, $currentPage - ceil(($pageItemsCount - self::EDGE_PADDING) / 2));
-	}
-
-	protected function calculateEndPage($startPage, $totalPages, $pageItemsCount)
-	{
-		$endPage = min($totalPages, $startPage + $pageItemsCount - self::EDGE_PADDING);
-		return max(1, $endPage - $pageItemsCount + self::EDGE_PADDING);
-	}
-
-	protected function addFirstPageLink($pagination, $startPage)
-	{
-		if ($startPage > 1) {
-			$pagination .= '<li><a href="' . $this->firstPageLink() . '">'. self::FIRST_PAGE_NUMBER .'</a></li>';
-			if ($startPage > 2) {
-				$pagination .= '<li><span>...</span></li>';
-			}
-		}
-		return $pagination;
-	}
-
-	protected function addLastPageLink($pagination, $endPage, $totalPages, $links)
-	{
-		if ($endPage < $totalPages) {
-			if ($endPage < $totalPages - 1) {
-				$pagination .= '<li><span>...</span></li>';
-			}
-			$pagination .= '<li><a href="' . $links[$totalPages - 1] . '">' . $totalPages . '</a></li>';
-		}
-		return $pagination;
-	}
+        if ($currentPage > 1) {
+            $pagination .= $this->getPreviousPageItem($this->previousPageLink());
+        }
+
+        if ($pageItemsCount) {
+            $pagination = $this->getPageItems($pagination, $currentPage, $totalPages, $pageItemsCount, $withBaseUrl);
+        }
+
+        if ($currentPage < $totalPages) {
+            $pagination .= $this->getNextPageItem($this->nextPageLink());
+        }
+
+        $pagination .= '</ul>';
+
+        return $pagination;
+    }
+
+    /**
+     * @param $pagination
+     * @param $currentPage
+     * @param $totalPages
+     * @param $pageItemsCount
+     * @param bool $withBaseUrl
+     * @return mixed|string
+     */
+    protected function getPageItems($pagination, $currentPage, $totalPages, $pageItemsCount, bool $withBaseUrl = false)
+    {
+        $startPage = $this->calculateStartPage($currentPage, $pageItemsCount);
+        $endPage = $this->calculateEndPage($startPage, $totalPages, $pageItemsCount);
+
+        $pagination = $this->addFirstPageLink($pagination, $startPage);
+
+        $links = $this->links($withBaseUrl);
+        $pagination = $this->getItemsLinks($pagination, $startPage, $endPage, $currentPage, $links);
+
+        return $this->addLastPageLink($pagination, $endPage, $totalPages, $links);
+    }
+
+    /**
+     * @param string|null $nextPageLink
+     * @return string
+     */
+    protected function getNextPageItem(?string $nextPageLink): string
+    {
+        $link = '';
+        if (!empty($nextPageLink)){
+            $link = '<li><a href="' . $nextPageLink . '">Next &raquo;</a></li>';
+        }
+        return $link;
+    }
+
+    /**
+     * @param string|null $previousPageLink
+     * @return string
+     */
+    protected function getPreviousPageItem(?string $previousPageLink): string
+    {
+        $link = '';
+        if (!empty($previousPageLink)){
+            $link = '<li><a href="' . $previousPageLink . '">&laquo; Previous</a></li>';
+        }
+        return $link;
+    }
+
+    protected function getItemsLinks($pagination, $startPage, $endPage, $currentPage, array $links)
+    {
+        for ($i = $startPage; $i <= $endPage; $i++) {
+            $active = $i == $currentPage ? 'class="'. self::PAGINATION_CLASS_ACTIVE .'"' : '';
+            $pagination .= '<li ' . $active . '><a href="' . $links[$i - 1] . '">' . $i . '</a></li>';
+        }
+        return $pagination;
+    }
+
+    protected function calculateStartPage($currentPage, $pageItemsCount)
+    {
+        return max(1, $currentPage - ceil(($pageItemsCount - self::EDGE_PADDING) / 2));
+    }
+
+    protected function calculateEndPage($startPage, $totalPages, $pageItemsCount)
+    {
+        $endPage = min($totalPages, $startPage + $pageItemsCount - self::EDGE_PADDING);
+        return max(1, $endPage - $pageItemsCount + self::EDGE_PADDING);
+    }
+
+    protected function addFirstPageLink($pagination, $startPage)
+    {
+        if ($startPage > 1) {
+            $pagination .= '<li><a href="' . $this->firstPageLink() . '">'. self::FIRST_PAGE_NUMBER .'</a></li>';
+            if ($startPage > 2) {
+                $pagination .= '<li><span>...</span></li>';
+            }
+        }
+        return $pagination;
+    }
+
+    protected function addLastPageLink($pagination, $endPage, $totalPages, $links)
+    {
+        if ($endPage < $totalPages) {
+            if ($endPage < $totalPages - 1) {
+                $pagination .= '<li><span>...</span></li>';
+            }
+            $pagination .= '<li><a href="' . $links[$totalPages - 1] . '">' . $totalPages . '</a></li>';
+        }
+        return $pagination;
+    }
 }
\ No newline at end of file

Please login to merge, or discard this patch.

Spacing +8 added lines, -8 removed lines patch added patch discarded remove patch

@@ -137,7 +137,7 @@  discard block
 block discarded – undo
 	 */
 	public function lastPageNumber(): int
 	{
-		return (int)ceil($this->total() / $this->perPage);
+		return (int) ceil($this->total() / $this->perPage);
 	}
 
 	/**
@@ -199,8 +199,8 @@  discard block
 block discarded – undo
 
 	protected function getPageLink($pageNumber, $withBaseUrl = false): ?string
 	{
-		if (!empty($pageNumber)){
-			return $this->getUri($withBaseUrl) . self::PER_PAGE .'=' . $this->perPage . '&'. self::PAGE .'=' . $pageNumber;
+		if (!empty($pageNumber)) {
+			return $this->getUri($withBaseUrl) . self::PER_PAGE . '=' . $this->perPage . '&' . self::PAGE . '=' . $pageNumber;
 		}
 		return null;
 	}
@@ -221,7 +221,7 @@  discard block
 block discarded – undo
 			$pageItemsCount = self::MINIMUM_PAGE_ITEMS_COUNT;
 		}
 
-		$pagination = '<ul class="'. self::PAGINATION_CLASS .'">';
+		$pagination = '<ul class="' . self::PAGINATION_CLASS . '">';
 		$currentPage = $this->currentPageNumber();
 		
 		if ($currentPage > 1) {
@@ -269,7 +269,7 @@  discard block
 block discarded – undo
 	protected function getNextPageItem(?string $nextPageLink): string
 	{
 		$link = '';
-		if (!empty($nextPageLink)){
+		if (!empty($nextPageLink)) {
 			$link = '<li><a href="' . $nextPageLink . '">Next &raquo;</a></li>';
 		}
 		return $link;
@@ -282,7 +282,7 @@  discard block
 block discarded – undo
 	protected function getPreviousPageItem(?string $previousPageLink): string
 	{
 		$link = '';
-		if (!empty($previousPageLink)){
+		if (!empty($previousPageLink)) {
 			$link = '<li><a href="' . $previousPageLink . '">&laquo; Previous</a></li>';
 		}
 		return $link;
@@ -291,7 +291,7 @@  discard block
 block discarded – undo
 	protected function getItemsLinks($pagination, $startPage, $endPage, $currentPage, array $links)
 	{
 		for ($i = $startPage; $i <= $endPage; $i++) {
-			$active = $i == $currentPage ? 'class="'. self::PAGINATION_CLASS_ACTIVE .'"' : '';
+			$active = $i == $currentPage ? 'class="' . self::PAGINATION_CLASS_ACTIVE . '"' : '';
 			$pagination .= '<li ' . $active . '><a href="' . $links[$i - 1] . '">' . $i . '</a></li>';
 		}
 		return $pagination;
@@ -311,7 +311,7 @@  discard block
 block discarded – undo
 	protected function addFirstPageLink($pagination, $startPage)
 	{
 		if ($startPage > 1) {
-			$pagination .= '<li><a href="' . $this->firstPageLink() . '">'. self::FIRST_PAGE_NUMBER .'</a></li>';
+			$pagination .= '<li><a href="' . $this->firstPageLink() . '">' . self::FIRST_PAGE_NUMBER . '</a></li>';
 			if ($startPage > 2) {
 				$pagination .= '<li><span>...</span></li>';
 			}

Please login to merge, or discard this patch.

		@@ -137,7 +137,7 @@ discard block
		block discarded – undo
137	137	*/
138	138	public function lastPageNumber(): int
139	139	{
140		- return (int)ceil($this->total() / $this->perPage);
	140	+ return (int) ceil($this->total() / $this->perPage);
141	141	}
142	142
143	143	/**
		@@ -199,8 +199,8 @@ discard block
		block discarded – undo
199	199
200	200	protected function getPageLink($pageNumber, $withBaseUrl = false): ?string
201	201	{
202		- if (!empty($pageNumber)){
203		- return $this->getUri($withBaseUrl) . self::PER_PAGE .'=' . $this->perPage . '&'. self::PAGE .'=' . $pageNumber;
	202	+ if (!empty($pageNumber)) {
	203	+ return $this->getUri($withBaseUrl) . self::PER_PAGE . '=' . $this->perPage . '&' . self::PAGE . '=' . $pageNumber;
204	204	}
205	205	return null;
206	206	}
		@@ -221,7 +221,7 @@ discard block
		block discarded – undo
221	221	$pageItemsCount = self::MINIMUM_PAGE_ITEMS_COUNT;
222	222	}
223	223
224		- $pagination = '<ul class="'. self::PAGINATION_CLASS .'">';
	224	+ $pagination = '<ul class="' . self::PAGINATION_CLASS . '">';
225	225	$currentPage = $this->currentPageNumber();
226	226
227	227	if ($currentPage > 1) {
		@@ -269,7 +269,7 @@ discard block
		block discarded – undo
269	269	protected function getNextPageItem(?string $nextPageLink): string
270	270	{
271	271	$link = '';
272		- if (!empty($nextPageLink)){
	272	+ if (!empty($nextPageLink)) {
273	273	$link = '<li><a href="' . $nextPageLink . '">Next »</a></li>';
274	274	}
275	275	return $link;
		@@ -282,7 +282,7 @@ discard block
		block discarded – undo
282	282	protected function getPreviousPageItem(?string $previousPageLink): string
283	283	{
284	284	$link = '';
285		- if (!empty($previousPageLink)){
	285	+ if (!empty($previousPageLink)) {
286	286	$link = '<li><a href="' . $previousPageLink . '">« Previous</a></li>';
287	287	}
288	288	return $link;
		@@ -291,7 +291,7 @@ discard block
		block discarded – undo
291	291	protected function getItemsLinks($pagination, $startPage, $endPage, $currentPage, array $links)
292	292	{
293	293	for ($i = $startPage; $i <= $endPage; $i++) {
294		- $active = $i == $currentPage ? 'class="'. self::PAGINATION_CLASS_ACTIVE .'"' : '';
	294	+ $active = $i == $currentPage ? 'class="' . self::PAGINATION_CLASS_ACTIVE . '"' : '';
295	295	$pagination .= '<li ' . $active . '><a href="' . $links[$i - 1] . '">' . $i . '</a></li>';
296	296	}
297	297	return $pagination;
		@@ -311,7 +311,7 @@ discard block
		block discarded – undo
311	311	protected function addFirstPageLink($pagination, $startPage)
312	312	{
313	313	if ($startPage > 1) {
314		- $pagination .= '<li><a href="' . $this->firstPageLink() . '">'. self::FIRST_PAGE_NUMBER .'</a></li>';
	314	+ $pagination .= '<li><a href="' . $this->firstPageLink() . '">' . self::FIRST_PAGE_NUMBER . '</a></li>';
315	315	if ($startPage > 2) {
316	316	$pagination .= '<li><span>...</span></li>';
317	317	}

		@@ -4,329 +4,329 @@
		block discarded – undo
4	4
5	5	abstract class BasePaginator implements PaginatorInterface
6	6	{
7		- /**
8		- * @var string
9		- */
10		- protected const PAGINATION_CLASS = 'pagination';
11		-
12		- /**
13		- * @var string
14		- */
15		- protected const PAGINATION_CLASS_ACTIVE = 'active';
16		-
17		- /**
18		- * @var string
19		- */
20		- protected const PER_PAGE = 'per_page';
21		-
22		- /**
23		- * @var string
24		- */
25		- protected const PAGE = 'page';
26		-
27		- /**
28		- * @var int
29		- */
30		- protected const FIRST_PAGE_NUMBER = 1;
31		-
32		- /**
33		- * @var int
34		- */
35		- protected const MINIMUM_PAGE_ITEMS_COUNT = 3;
36		-
37		- /**
38		- * @var int
39		- */
40		- protected const EDGE_PADDING = 3;
41		-
42		- /**
43		- * @var int
44		- */
45		- protected $total;
46		-
47		- /**
48		- * @var string
49		- */
50		- protected $baseUrl;
51		-
52		- /**
53		- * @var int
54		- */
55		- protected $perPage;
56		-
57		- /**
58		- * @var int
59		- */
60		- protected $page;
61		-
62		- /**
63		- * @return int
64		- */
65		- public function currentPageNumber(): int
66		- {
67		- return $this->page;
68		- }
69		-
70		- /**
71		- * @param bool $withBaseUrl
72		- * @return string\|null
73		- */
74		- public function currentPageLink(bool $withBaseUrl = false): ?string
75		- {
76		- return $this->getPageLink($this->page, $withBaseUrl);
77		- }
78		-
79		- /**
80		- * @return int\|null
81		- */
82		- public function previousPageNumber(): ?int
83		- {
84		- $previous = null;
85		- if ($this->page > 1) {
86		- $previous = $this->page - 1;
87		- } elseif ($this->page == 1) {
88		- $previous = $this->page;
89		- }
90		-
91		- return $previous;
92		- }
93		-
94		- /**
95		- * @param bool $withBaseUrl
96		- * @return string\|null
97		- */
98		- public function previousPageLink(bool $withBaseUrl = false): ?string
99		- {
100		- return $this->getPageLink($this->previousPageNumber(), $withBaseUrl);
101		- }
102		-
103		- /**
104		- * @return int\|null
105		- */
106		- public function nextPageNumber(): ?int
107		- {
108		- $next = null;
109		- if ($this->page < $this->lastPageNumber()) {
110		- $next = $this->page + 1;
111		- } elseif ($this->page == $this->lastPageNumber()) {
112		- $next = $this->page;
113		- }
114		- return $next;
115		- }
116		-
117		- /**
118		- * @param bool $withBaseUrl
119		- * @return string\|null
120		- */
121		- public function nextPageLink(bool $withBaseUrl = false): ?string
122		- {
123		- return $this->getPageLink($this->nextPageNumber(), $withBaseUrl);
124		- }
125		-
126		- /**
127		- * @param bool $withBaseUrl
128		- * @return string\|null
129		- */
130		- public function firstPageLink(bool $withBaseUrl = false): ?string
131		- {
132		- return $this->getPageLink(self::FIRST_PAGE_NUMBER, $withBaseUrl);
133		- }
134		-
135		- /**
136		- * @return int
137		- */
138		- public function lastPageNumber(): int
139		- {
140		- return (int)ceil($this->total() / $this->perPage);
141		- }
142		-
143		- /**
144		- * @param bool $withBaseUrl
145		- * @return string\|null
146		- */
147		- public function lastPageLink(bool $withBaseUrl = false): ?string
148		- {
149		- return $this->getPageLink($this->lastPageNumber(), $withBaseUrl);
150		- }
151		-
152		- /**
153		- * @return int
154		- */
155		- public function perPage(): int
156		- {
157		- return $this->perPage;
158		- }
159		-
160		- /**
161		- * @return int
162		- */
163		- public function total(): int
164		- {
165		- return $this->total;
166		- }
167		-
168		- /**
169		- * @param bool $withBaseUrl
170		- * @return array
171		- */
172		- public function links(bool $withBaseUrl = false): array
173		- {
174		- $links = [];
175		- for ($i = 1; $i <= $this->lastPageNumber(); $i++) {
176		- $links[] = $this->getPageLink($i, $withBaseUrl);
177		- }
178		-
179		- return $links;
180		- }
181		-
182		- /**
183		- * @param bool $withBaseUrl
184		- * @return string
185		- */
186		- protected function getUri(bool $withBaseUrl = false): string
187		- {
188		- $routeUrl = preg_replace('/([?&](page\|per_page)=\d+)/', '', route_uri());
189		- $routeUrl = preg_replace('/&/', '?', $routeUrl, 1);
190		- $url = $routeUrl;
191		-
192		- if ($withBaseUrl) {
193		- $url = $this->baseUrl . $routeUrl;
194		- }
195		-
196		- $delimiter = strpos($url, '?') ? '&' : '?';
197		- return $url . $delimiter;
198		- }
199		-
200		- protected function getPageLink($pageNumber, $withBaseUrl = false): ?string
201		- {
202		- if (!empty($pageNumber)){
203		- return $this->getUri($withBaseUrl) . self::PER_PAGE .'=' . $this->perPage . '&'. self::PAGE .'=' . $pageNumber;
204		- }
205		- return null;
206		- }
207		-
208		- /**
209		- * @param bool $withBaseUrl
210		- * @param $pageItemsCount
211		- * @return string\|null
212		- */
213		- public function getPagination(bool $withBaseUrl = false, $pageItemsCount = null): ?string
214		- {
215		- $totalPages = $this->lastPageNumber();
216		- if ($totalPages <= 1) {
217		- return null;
218		- }
219		-
220		- if (!is_null($pageItemsCount) && $pageItemsCount < self::MINIMUM_PAGE_ITEMS_COUNT) {
221		- $pageItemsCount = self::MINIMUM_PAGE_ITEMS_COUNT;
222		- }
223		-
224		- $pagination = '<ul class="'. self::PAGINATION_CLASS .'">';
225		- $currentPage = $this->currentPageNumber();
	7	+ /**
	8	+ * @var string
	9	+ */
	10	+ protected const PAGINATION_CLASS = 'pagination';
	11	+
	12	+ /**
	13	+ * @var string
	14	+ */
	15	+ protected const PAGINATION_CLASS_ACTIVE = 'active';
	16	+
	17	+ /**
	18	+ * @var string
	19	+ */
	20	+ protected const PER_PAGE = 'per_page';
	21	+
	22	+ /**
	23	+ * @var string
	24	+ */
	25	+ protected const PAGE = 'page';
	26	+
	27	+ /**
	28	+ * @var int
	29	+ */
	30	+ protected const FIRST_PAGE_NUMBER = 1;
	31	+
	32	+ /**
	33	+ * @var int
	34	+ */
	35	+ protected const MINIMUM_PAGE_ITEMS_COUNT = 3;
	36	+
	37	+ /**
	38	+ * @var int
	39	+ */
	40	+ protected const EDGE_PADDING = 3;
	41	+
	42	+ /**
	43	+ * @var int
	44	+ */
	45	+ protected $total;
	46	+
	47	+ /**
	48	+ * @var string
	49	+ */
	50	+ protected $baseUrl;
	51	+
	52	+ /**
	53	+ * @var int
	54	+ */
	55	+ protected $perPage;
	56	+
	57	+ /**
	58	+ * @var int
	59	+ */
	60	+ protected $page;
	61	+
	62	+ /**
	63	+ * @return int
	64	+ */
	65	+ public function currentPageNumber(): int
	66	+ {
	67	+ return $this->page;
	68	+ }
	69	+
	70	+ /**
	71	+ * @param bool $withBaseUrl
	72	+ * @return string\|null
	73	+ */
	74	+ public function currentPageLink(bool $withBaseUrl = false): ?string
	75	+ {
	76	+ return $this->getPageLink($this->page, $withBaseUrl);
	77	+ }
	78	+
	79	+ /**
	80	+ * @return int\|null
	81	+ */
	82	+ public function previousPageNumber(): ?int
	83	+ {
	84	+ $previous = null;
	85	+ if ($this->page > 1) {
	86	+ $previous = $this->page - 1;
	87	+ } elseif ($this->page == 1) {
	88	+ $previous = $this->page;
	89	+ }
	90	+
	91	+ return $previous;
	92	+ }
	93	+
	94	+ /**
	95	+ * @param bool $withBaseUrl
	96	+ * @return string\|null
	97	+ */
	98	+ public function previousPageLink(bool $withBaseUrl = false): ?string
	99	+ {
	100	+ return $this->getPageLink($this->previousPageNumber(), $withBaseUrl);
	101	+ }
	102	+
	103	+ /**
	104	+ * @return int\|null
	105	+ */
	106	+ public function nextPageNumber(): ?int
	107	+ {
	108	+ $next = null;
	109	+ if ($this->page < $this->lastPageNumber()) {
	110	+ $next = $this->page + 1;
	111	+ } elseif ($this->page == $this->lastPageNumber()) {
	112	+ $next = $this->page;
	113	+ }
	114	+ return $next;
	115	+ }
	116	+
	117	+ /**
	118	+ * @param bool $withBaseUrl
	119	+ * @return string\|null
	120	+ */
	121	+ public function nextPageLink(bool $withBaseUrl = false): ?string
	122	+ {
	123	+ return $this->getPageLink($this->nextPageNumber(), $withBaseUrl);
	124	+ }
	125	+
	126	+ /**
	127	+ * @param bool $withBaseUrl
	128	+ * @return string\|null
	129	+ */
	130	+ public function firstPageLink(bool $withBaseUrl = false): ?string
	131	+ {
	132	+ return $this->getPageLink(self::FIRST_PAGE_NUMBER, $withBaseUrl);
	133	+ }
	134	+
	135	+ /**
	136	+ * @return int
	137	+ */
	138	+ public function lastPageNumber(): int
	139	+ {
	140	+ return (int)ceil($this->total() / $this->perPage);
	141	+ }
	142	+
	143	+ /**
	144	+ * @param bool $withBaseUrl
	145	+ * @return string\|null
	146	+ */
	147	+ public function lastPageLink(bool $withBaseUrl = false): ?string
	148	+ {
	149	+ return $this->getPageLink($this->lastPageNumber(), $withBaseUrl);
	150	+ }
	151	+
	152	+ /**
	153	+ * @return int
	154	+ */
	155	+ public function perPage(): int
	156	+ {
	157	+ return $this->perPage;
	158	+ }
	159	+
	160	+ /**
	161	+ * @return int
	162	+ */
	163	+ public function total(): int
	164	+ {
	165	+ return $this->total;
	166	+ }
	167	+
	168	+ /**
	169	+ * @param bool $withBaseUrl
	170	+ * @return array
	171	+ */
	172	+ public function links(bool $withBaseUrl = false): array
	173	+ {
	174	+ $links = [];
	175	+ for ($i = 1; $i <= $this->lastPageNumber(); $i++) {
	176	+ $links[] = $this->getPageLink($i, $withBaseUrl);
	177	+ }
	178	+
	179	+ return $links;
	180	+ }
	181	+
	182	+ /**
	183	+ * @param bool $withBaseUrl
	184	+ * @return string
	185	+ */
	186	+ protected function getUri(bool $withBaseUrl = false): string
	187	+ {
	188	+ $routeUrl = preg_replace('/([?&](page\|per_page)=\d+)/', '', route_uri());
	189	+ $routeUrl = preg_replace('/&/', '?', $routeUrl, 1);
	190	+ $url = $routeUrl;
	191	+
	192	+ if ($withBaseUrl) {
	193	+ $url = $this->baseUrl . $routeUrl;
	194	+ }
	195	+
	196	+ $delimiter = strpos($url, '?') ? '&' : '?';
	197	+ return $url . $delimiter;
	198	+ }
	199	+
	200	+ protected function getPageLink($pageNumber, $withBaseUrl = false): ?string
	201	+ {
	202	+ if (!empty($pageNumber)){
	203	+ return $this->getUri($withBaseUrl) . self::PER_PAGE .'=' . $this->perPage . '&'. self::PAGE .'=' . $pageNumber;
	204	+ }
	205	+ return null;
	206	+ }
	207	+
	208	+ /**
	209	+ * @param bool $withBaseUrl
	210	+ * @param $pageItemsCount
	211	+ * @return string\|null
	212	+ */
	213	+ public function getPagination(bool $withBaseUrl = false, $pageItemsCount = null): ?string
	214	+ {
	215	+ $totalPages = $this->lastPageNumber();
	216	+ if ($totalPages <= 1) {
	217	+ return null;
	218	+ }
	219	+
	220	+ if (!is_null($pageItemsCount) && $pageItemsCount < self::MINIMUM_PAGE_ITEMS_COUNT) {
	221	+ $pageItemsCount = self::MINIMUM_PAGE_ITEMS_COUNT;
	222	+ }
	223	+
	224	+ $pagination = '<ul class="'. self::PAGINATION_CLASS .'">';
	225	+ $currentPage = $this->currentPageNumber();
226	226
227		- if ($currentPage > 1) {
228		- $pagination .= $this->getPreviousPageItem($this->previousPageLink());
229		- }
230		-
231		- if ($pageItemsCount) {
232		- $pagination = $this->getPageItems($pagination, $currentPage, $totalPages, $pageItemsCount, $withBaseUrl);
233		- }
234		-
235		- if ($currentPage < $totalPages) {
236		- $pagination .= $this->getNextPageItem($this->nextPageLink());
237		- }
238		-
239		- $pagination .= '</ul>';
240		-
241		- return $pagination;
242		- }
243		-
244		- /**
245		- * @param $pagination
246		- * @param $currentPage
247		- * @param $totalPages
248		- * @param $pageItemsCount
249		- * @param bool $withBaseUrl
250		- * @return mixed\|string
251		- */
252		- protected function getPageItems($pagination, $currentPage, $totalPages, $pageItemsCount, bool $withBaseUrl = false)
253		- {
254		- $startPage = $this->calculateStartPage($currentPage, $pageItemsCount);
255		- $endPage = $this->calculateEndPage($startPage, $totalPages, $pageItemsCount);
256		-
257		- $pagination = $this->addFirstPageLink($pagination, $startPage);
258		-
259		- $links = $this->links($withBaseUrl);
260		- $pagination = $this->getItemsLinks($pagination, $startPage, $endPage, $currentPage, $links);
261		-
262		- return $this->addLastPageLink($pagination, $endPage, $totalPages, $links);
263		- }
264		-
265		- /**
266		- * @param string\|null $nextPageLink
267		- * @return string
268		- */
269		- protected function getNextPageItem(?string $nextPageLink): string
270		- {
271		- $link = '';
272		- if (!empty($nextPageLink)){
273		- $link = '<li><a href="' . $nextPageLink . '">Next »</a></li>';
274		- }
275		- return $link;
276		- }
277		-
278		- /**
279		- * @param string\|null $previousPageLink
280		- * @return string
281		- */
282		- protected function getPreviousPageItem(?string $previousPageLink): string
283		- {
284		- $link = '';
285		- if (!empty($previousPageLink)){
286		- $link = '<li><a href="' . $previousPageLink . '">« Previous</a></li>';
287		- }
288		- return $link;
289		- }
290		-
291		- protected function getItemsLinks($pagination, $startPage, $endPage, $currentPage, array $links)
292		- {
293		- for ($i = $startPage; $i <= $endPage; $i++) {
294		- $active = $i == $currentPage ? 'class="'. self::PAGINATION_CLASS_ACTIVE .'"' : '';
295		- $pagination .= '<li ' . $active . '><a href="' . $links[$i - 1] . '">' . $i . '</a></li>';
296		- }
297		- return $pagination;
298		- }
299		-
300		- protected function calculateStartPage($currentPage, $pageItemsCount)
301		- {
302		- return max(1, $currentPage - ceil(($pageItemsCount - self::EDGE_PADDING) / 2));
303		- }
304		-
305		- protected function calculateEndPage($startPage, $totalPages, $pageItemsCount)
306		- {
307		- $endPage = min($totalPages, $startPage + $pageItemsCount - self::EDGE_PADDING);
308		- return max(1, $endPage - $pageItemsCount + self::EDGE_PADDING);
309		- }
310		-
311		- protected function addFirstPageLink($pagination, $startPage)
312		- {
313		- if ($startPage > 1) {
314		- $pagination .= '<li><a href="' . $this->firstPageLink() . '">'. self::FIRST_PAGE_NUMBER .'</a></li>';
315		- if ($startPage > 2) {
316		- $pagination .= '<li><span>...</span></li>';
317		- }
318		- }
319		- return $pagination;
320		- }
321		-
322		- protected function addLastPageLink($pagination, $endPage, $totalPages, $links)
323		- {
324		- if ($endPage < $totalPages) {
325		- if ($endPage < $totalPages - 1) {
326		- $pagination .= '<li><span>...</span></li>';
327		- }
328		- $pagination .= '<li><a href="' . $links[$totalPages - 1] . '">' . $totalPages . '</a></li>';
329		- }
330		- return $pagination;
331		- }
	227	+ if ($currentPage > 1) {
	228	+ $pagination .= $this->getPreviousPageItem($this->previousPageLink());
	229	+ }
	230	+
	231	+ if ($pageItemsCount) {
	232	+ $pagination = $this->getPageItems($pagination, $currentPage, $totalPages, $pageItemsCount, $withBaseUrl);
	233	+ }
	234	+
	235	+ if ($currentPage < $totalPages) {
	236	+ $pagination .= $this->getNextPageItem($this->nextPageLink());
	237	+ }
	238	+
	239	+ $pagination .= '</ul>';
	240	+
	241	+ return $pagination;
	242	+ }
	243	+
	244	+ /**
	245	+ * @param $pagination
	246	+ * @param $currentPage
	247	+ * @param $totalPages
	248	+ * @param $pageItemsCount
	249	+ * @param bool $withBaseUrl
	250	+ * @return mixed\|string
	251	+ */
	252	+ protected function getPageItems($pagination, $currentPage, $totalPages, $pageItemsCount, bool $withBaseUrl = false)
	253	+ {
	254	+ $startPage = $this->calculateStartPage($currentPage, $pageItemsCount);
	255	+ $endPage = $this->calculateEndPage($startPage, $totalPages, $pageItemsCount);
	256	+
	257	+ $pagination = $this->addFirstPageLink($pagination, $startPage);
	258	+
	259	+ $links = $this->links($withBaseUrl);
	260	+ $pagination = $this->getItemsLinks($pagination, $startPage, $endPage, $currentPage, $links);
	261	+
	262	+ return $this->addLastPageLink($pagination, $endPage, $totalPages, $links);
	263	+ }
	264	+
	265	+ /**
	266	+ * @param string\|null $nextPageLink
	267	+ * @return string
	268	+ */
	269	+ protected function getNextPageItem(?string $nextPageLink): string
	270	+ {
	271	+ $link = '';
	272	+ if (!empty($nextPageLink)){
	273	+ $link = '<li><a href="' . $nextPageLink . '">Next »</a></li>';
	274	+ }
	275	+ return $link;
	276	+ }
	277	+
	278	+ /**
	279	+ * @param string\|null $previousPageLink
	280	+ * @return string
	281	+ */
	282	+ protected function getPreviousPageItem(?string $previousPageLink): string
	283	+ {
	284	+ $link = '';
	285	+ if (!empty($previousPageLink)){
	286	+ $link = '<li><a href="' . $previousPageLink . '">« Previous</a></li>';
	287	+ }
	288	+ return $link;
	289	+ }
	290	+
	291	+ protected function getItemsLinks($pagination, $startPage, $endPage, $currentPage, array $links)
	292	+ {
	293	+ for ($i = $startPage; $i <= $endPage; $i++) {
	294	+ $active = $i == $currentPage ? 'class="'. self::PAGINATION_CLASS_ACTIVE .'"' : '';
	295	+ $pagination .= '<li ' . $active . '><a href="' . $links[$i - 1] . '">' . $i . '</a></li>';
	296	+ }
	297	+ return $pagination;
	298	+ }
	299	+
	300	+ protected function calculateStartPage($currentPage, $pageItemsCount)
	301	+ {
	302	+ return max(1, $currentPage - ceil(($pageItemsCount - self::EDGE_PADDING) / 2));
	303	+ }
	304	+
	305	+ protected function calculateEndPage($startPage, $totalPages, $pageItemsCount)
	306	+ {
	307	+ $endPage = min($totalPages, $startPage + $pageItemsCount - self::EDGE_PADDING);
	308	+ return max(1, $endPage - $pageItemsCount + self::EDGE_PADDING);
	309	+ }
	310	+
	311	+ protected function addFirstPageLink($pagination, $startPage)
	312	+ {
	313	+ if ($startPage > 1) {
	314	+ $pagination .= '<li><a href="' . $this->firstPageLink() . '">'. self::FIRST_PAGE_NUMBER .'</a></li>';
	315	+ if ($startPage > 2) {
	316	+ $pagination .= '<li><span>...</span></li>';
	317	+ }
	318	+ }
	319	+ return $pagination;
	320	+ }
	321	+
	322	+ protected function addLastPageLink($pagination, $endPage, $totalPages, $links)
	323	+ {
	324	+ if ($endPage < $totalPages) {
	325	+ if ($endPage < $totalPages - 1) {
	326	+ $pagination .= '<li><span>...</span></li>';
	327	+ }
	328	+ $pagination .= '<li><a href="' . $links[$totalPages - 1] . '">' . $totalPages . '</a></li>';
	329	+ }
	330	+ return $pagination;
	331	+ }
332	332	}
333	333	\ No newline at end of file

softberg / quantum-php-core

Pull Request — master (#154)

Status

Category

Indentation +324 added lines, -324 removed lines patch added patch discarded remove patch

Spacing +8 added lines, -8 removed lines patch added patch discarded remove patch