PaginateRoute::renderHtml() - Code Metrics - Inspection of "Strict Type check bug fix 1.3" - vipertecpro/laravel-pretty-pagination - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c95648...9320fe )

by Vipul

created 2020-01-02 13:41 UTC

PaginateRoute::renderHtml() A

↳ Parent: PaginateRoute

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php

namespace Vipertecpro\PaginateRoute;

use Illuminate\Contracts\Pagination\Paginator;
use Illuminate\Contracts\Routing\UrlGenerator;
use Illuminate\Pagination\LengthAwarePaginator;
use Illuminate\Routing\RouteParameterBinder;
use Illuminate\Routing\Router;
use Illuminate\Support\Facades\Request;
use Illuminate\Translation\Translator;

class PaginateRoute
{
    /**
     * @var Translator
     */
    protected $translator;

    /**
     * @var Router
     */
    protected $router;

    /**
     * @var UrlGenerator
     */
    protected $urlGenerator;

    /**
     * @var string|array
     */
    protected $pageKeyword;

    /**
     * @param Translator $translator
     * @param Router $router
     * @param UrlGenerator $urlGenerator
     */
    public function __construct(Translator $translator, Router $router, UrlGenerator $urlGenerator)
    {
        $this->translator = $translator;
        $this->router = $router;
        $this->urlGenerator = $urlGenerator;

        // Unfortunately we can't do this in the service provider since routes are booted first
        $this->translator->addNamespace('paginateroute', __DIR__.'/../resources/lang');

        $this->pageKeyword = $this->translator->get('paginateroute::paginateroute.page');
    }

    /**
     * Return the current page.
     *
     * @return int
     */
    public function currentPage()
    {
        $currentRoute = $this->router->getCurrentRoute();

        if (! $currentRoute) {
            return 1;
        }

        $query = $currentRoute->parameter('pageQuery');

        return (int) str_replace($this->pageKeyword.'/', '', $query) ?: 1;
    }

    /**
     * Check if the given page is the current page.
     *
     * @param int $page
     *
     * @return bool
     */
    public function isCurrentPage($page): bool
    {
        return $this->currentPage() === $page;
    }

    /**
     * Get the next page number.
     *
     * @param Paginator $paginator
     *
     * @return int|void
     */
    public function nextPage(Paginator $paginator)
    {
        if (! $paginator->hasMorePages()) {
            return;
        }

        return $this->currentPage() + 1;
    }

    /**
     * Determine wether there is a next page.
     *
     * @param Paginator $paginator
     *
     * @return bool
     */
    public function hasNextPage(Paginator $paginator): bool
    {
        return $this->nextPage($paginator) !== null;
    }

    /**
     * Get the next page URL.
     *
     * @param Paginator $paginator
     *
     * @return string|void
     */
    public function nextPageUrl(Paginator $paginator)
    {
        $nextPage = $this->nextPage($paginator);

        if ($nextPage === null) {
            return;
        }

        return $this->pageUrl($nextPage);
    }

    /**
     * Get the previous page number.
     *
     * @return int|void|null
     */
    public function previousPage()
    {
        if ($this->currentPage() <= 1) {
            return;
        }

        return $this->currentPage() - 1;
    }

    /**
     * Determine wether there is a previous page.
     *
     * @return bool
     */
    public function hasPreviousPage(): bool
    {
        return $this->previousPage() !== null;
    }

    /**
     * Get the previous page URL.
     *
     * @param bool $full Return the full version of the URL in for the first page
     *                   Ex. /users/page/1 instead of /users
     *
     * @return string|void|null
     */
    public function previousPageUrl($full = false): ?string
    {
        $previousPage = $this->previousPage();

        if ($previousPage === null) {
            return;
        }

        return $this->pageUrl($previousPage, $full);
    }

    /**
     * Get all urls in an array.
     *
     * @param LengthAwarePaginator $paginator
     * @param bool                                                  $full      Return the full version of the URL in for the first page
     *                                                                         Ex. /users/page/1 instead of /users
     *
     * @return array
     */
    public function allUrls(LengthAwarePaginator $paginator, $full = false): array
    {
        if (! $paginator->hasPages()) {
            return [];
        }

        $urls = [];
        $left = $this->getLeftPoint($paginator);
        $right = $this->getRightPoint($paginator);
        for ($page = $left; $page <= $right; $page++) {
            $urls[$page] = $this->pageUrl($page, $full);
        }

        return $urls;
    }

    /**
     * Get the left most point in the pagination element.
     *
     * @param LengthAwarePaginator $paginator
     * @return int
     */
    public function getLeftPoint(LengthAwarePaginator $paginator): int
    {
        if ($paginator instanceof LengthAwarePaginator) {
            $side = $paginator->onEachSide;
        }else{
            $side = 0;
        }
        $current = $paginator->currentPage();
        $last = $paginator->lastPage();

        if (! empty($side)) {
            $x = $current + $side;
            $offset = $x >= $last ? $x - $last : 0;
            $left = $current - $side - $offset;
        }
        if(!isset($left) || $left < 1){
            return 1;
        }
        return $left;
    }

    /**
     * Get the right or last point of the pagination element.
     *
     * @param LengthAwarePaginator $paginator
     * @return int
     */
    public function getRightPoint(LengthAwarePaginator $paginator): int
    {
        $side = $paginator->onEachSide;
        $current = $paginator->currentPage();
        $last = $paginator->lastPage();

        if (! empty($side)) {
            $offset = $current <= $side ? $side - $current + 1 : 0;
            $right = $current + $side + $offset;
        }
        if(!isset($right) || $right > $last){
            return $last;
        }
        return $right;
    }

    /**
     * Render a plain html list with previous, next and all urls. The current page gets a current class on the list item.
     *
     * @param LengthAwarePaginator $paginator
     * @param bool                                                  $full              Return the full version of the URL in for the first page
     *                                                                                 Ex. /users/page/1 instead of /users
     * @param string                                                $class             Include class on pagination list
     *                                                                                 Ex. <ul class="pagination">
     * @param bool                                                  $additionalLinks   Include prev and next links on pagination list
     *
     * @return string
     */

    public function renderPageList(LengthAwarePaginator $paginator, $full = false, $class = null, $additionalLinks = false)
    {
        $urls = $this->allUrls($paginator, $full);
        if ($class !== null) {
            $class = " class=\"$class\"";
        }
        $listItems = "<ul{$class}>";
        if ($this->hasPreviousPage() && $additionalLinks) {
            $listItems .= "<li class='page-item'> <a class='page-link' href=\"{$this->previousPageUrl()}\">&laquo;</a></li>";
        }
        foreach ($urls as $i => $url) {
            $pageNum = $i;
            $css = ' class="page-item"';
            $link = "<a class='page-link' href=\"{$url}\">{$pageNum}</a>";
            if ($pageNum === $this->currentPage()) {
                $css = ' class="page-item active"';
                $link = "<span class='page-link' href=\"{$url}\">{$pageNum}</span>";
            }
            $listItems .= "<li{$css}>$link</li>";
        }
        if ($this->hasNextPage($paginator) && $additionalLinks) {
            $listItems .= "<li class='page-item'> <a class='page-link' href=\"{$this->nextPageUrl($paginator)}\">&raquo;</a></li>";
        }
        $listItems .= '</ul>';
        return $listItems;
    }
    /**
     * Render html link tags for SEO indication of previous and next page.
     *
     * @param LengthAwarePaginator $paginator
     * @param bool                                                  $full       Return the full version of the URL in for the first page
     *                                                                          Ex. /users/page/1 instead of /users
     *
     * @return string
     */
    public function renderRelLinks(LengthAwarePaginator $paginator, $full = false): string
    {
        $urls = $this->allUrls($paginator, $full);

        $linkItems = '';

        foreach ($urls as $i => $url) {
            $pageNum = $i + 1;

            switch ($pageNum - $this->currentPage()) {
                case -1:
                    $linkItems .= "<link rel=\"prev\" href=\"{$url}\" />";
                    break;
                case 1:
                    $linkItems .= "<link rel=\"next\" href=\"{$url}\" />";
                    break;
            }
        }

        return $linkItems;
    }

    /**
     * @param LengthAwarePaginator $paginator
     * @param bool $full      Return the full version of the URL in for the first page
     *                                                                         Ex. /users/page/1 instead of /users
     *
     * @return string
     *@deprecated in favor of renderPageList.
     *
     */
    public function renderHtml(LengthAwarePaginator $paginator, $full = false): string
    {
        return $this->renderPageList($paginator, $full);
    }

    /**
     * Generate a page URL, based on the request's current URL.
     *
     * @param int  $page
     * @param bool $full Return the full version of the URL in for the first page
     *                   Ex. /users/page/1 instead of /users
     *
     * @return string
     */
    public function pageUrl($page, $full = false): string
    {
        $currentPageUrl = $this->router->getCurrentRoute()->uri();

        $url = $this->addPageQuery(str_replace('{pageQuery?}', '', $currentPageUrl), $page, $full);

        foreach ((new RouteParameterBinder($this->router->getCurrentRoute()))->parameters(app('request')) as $parameterName => $parameterValue) {
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $url = str_replace(['{'.$parameterName.'}', '{'.$parameterName.'?}'], $parameterValue, $url);
        }

        $query = Request::getQueryString();

        $query = $query
            ? '?'.$query
            : '';

        return $this->urlGenerator->to($url).$query;
    }

    /**
     * Append the page query to a URL.
     *
     * @param string $url
     * @param int    $page
     * @param bool   $full Return the full version of the URL in for the first page
     *                     Ex. /users/page/1 instead of /users
     *
     * @return string
     */
    public function addPageQuery($url, $page, $full = false): string
    {
        // If the first page's URL is requested and $full is set to false, there's nothing to be added.
        if ($page === 1 && ! $full) {
            return $url;
        }

        return trim($url, '/')."/{$this->pageKeyword}/{$page}";
    }

    /**
     * Register the Route::paginate macro.
     */
    public function registerMacros(): void
    {
        $pageKeyword = $this->pageKeyword;
        $router = $this->router;

        $router->macro('paginate', function ($uri, $action) use ($pageKeyword, $router) {
            $route = null;

            $router->group(
                ['middleware' => 'Vipertecpro\PaginateRoute\SetPageMiddleware'],
                function () use ($pageKeyword, $router, $uri, $action, &$route) {
                    $route = $router->get($uri.'/{pageQuery?}', $action)->where('pageQuery', $pageKeyword.'/[0-9]+');
                });

            return $route;
        });
    }
}


1			<?php
2
3			namespace Vipertecpro\PaginateRoute;
4
5			use Illuminate\Contracts\Pagination\Paginator;
6			use Illuminate\Contracts\Routing\UrlGenerator;
7			use Illuminate\Pagination\LengthAwarePaginator;
8			use Illuminate\Routing\RouteParameterBinder;
9			use Illuminate\Routing\Router;
10			use Illuminate\Support\Facades\Request;
11			use Illuminate\Translation\Translator;
12
13			class PaginateRoute
14			{
15			/**
16			* @var Translator
17			*/
18			protected $translator;
19
20			/**
21			* @var Router
22			*/
23			protected $router;
24
25			/**
26			* @var UrlGenerator
27			*/
28			protected $urlGenerator;
29
30			/**
31			* @var string\|array
32			*/
33			protected $pageKeyword;
34
35			/**
36			* @param Translator $translator
37			* @param Router $router
38			* @param UrlGenerator $urlGenerator
39			*/
40			public function __construct(Translator $translator, Router $router, UrlGenerator $urlGenerator)
41			{
42			$this->translator = $translator;
43			$this->router = $router;
44			$this->urlGenerator = $urlGenerator;
45
46			// Unfortunately we can't do this in the service provider since routes are booted first
47			$this->translator->addNamespace('paginateroute', __DIR__.'/../resources/lang');
48
49			$this->pageKeyword = $this->translator->get('paginateroute::paginateroute.page');
50			}
51
52			/**
53			* Return the current page.
54			*
55			* @return int
56			*/
57			public function currentPage()
58			{
59			$currentRoute = $this->router->getCurrentRoute();
60
61			if (! $currentRoute) {
62			return 1;
63			}
64
65			$query = $currentRoute->parameter('pageQuery');
66
67			return (int) str_replace($this->pageKeyword.'/', '', $query) ?: 1;
68			}
69
70			/**
71			* Check if the given page is the current page.
72			*
73			* @param int $page
74			*
75			* @return bool
76			*/
77			public function isCurrentPage($page): bool
78			{
79			return $this->currentPage() === $page;
80			}
81
82			/**
83			* Get the next page number.
84			*
85			* @param Paginator $paginator
86			*
87			* @return int\|void
88			*/
89			public function nextPage(Paginator $paginator)
90			{
91			if (! $paginator->hasMorePages()) {
92			return;
93			}
94
95			return $this->currentPage() + 1;
96			}
97
98			/**
99			* Determine wether there is a next page.
100			*
101			* @param Paginator $paginator
102			*
103			* @return bool
104			*/
105			public function hasNextPage(Paginator $paginator): bool
106			{
107			return $this->nextPage($paginator) !== null;
108			}
109
110			/**
111			* Get the next page URL.
112			*
113			* @param Paginator $paginator
114			*
115			* @return string\|void
116			*/
117			public function nextPageUrl(Paginator $paginator)
118			{
119			$nextPage = $this->nextPage($paginator);
120
121			if ($nextPage === null) {
122			return;
123			}
124
125			return $this->pageUrl($nextPage);
126			}
127
128			/**
129			* Get the previous page number.
130			*
131			* @return int\|void\|null
132			*/
133			public function previousPage()
134			{
135			if ($this->currentPage() <= 1) {
136			return;
137			}
138
139			return $this->currentPage() - 1;
140			}
141
142			/**
143			* Determine wether there is a previous page.
144			*
145			* @return bool
146			*/
147			public function hasPreviousPage(): bool
148			{
149			return $this->previousPage() !== null;
150			}
151
152			/**
153			* Get the previous page URL.
154			*
155			* @param bool $full Return the full version of the URL in for the first page
156			* Ex. /users/page/1 instead of /users
157			*
158			* @return string\|void\|null
159			*/
160			public function previousPageUrl($full = false): ?string
161			{
162			$previousPage = $this->previousPage();
163
164			if ($previousPage === null) {
165			return;
166			}
167
168			return $this->pageUrl($previousPage, $full);
169			}
170
171			/**
172			* Get all urls in an array.
173			*
174			* @param LengthAwarePaginator $paginator
175			* @param bool $full Return the full version of the URL in for the first page
176			* Ex. /users/page/1 instead of /users
177			*
178			* @return array
179			*/
180			public function allUrls(LengthAwarePaginator $paginator, $full = false): array
181			{
182			if (! $paginator->hasPages()) {
183			return [];
184			}
185
186			$urls = [];
187			$left = $this->getLeftPoint($paginator);
188			$right = $this->getRightPoint($paginator);
189			for ($page = $left; $page <= $right; $page++) {
190			$urls[$page] = $this->pageUrl($page, $full);
191			}
192
193			return $urls;
194			}
195
196			/**
197			* Get the left most point in the pagination element.
198			*
199			* @param LengthAwarePaginator $paginator
200			* @return int
201			*/
202			public function getLeftPoint(LengthAwarePaginator $paginator): int
203			{
204			if ($paginator instanceof LengthAwarePaginator) {
205			$side = $paginator->onEachSide;
206			}else{
207			$side = 0;
208			}
209			$current = $paginator->currentPage();
210			$last = $paginator->lastPage();
211
212			if (! empty($side)) {
213			$x = $current + $side;
214			$offset = $x >= $last ? $x - $last : 0;
215			$left = $current - $side - $offset;
216			}
217			if(!isset($left) \|\| $left < 1){
218			return 1;
219			}
220			return $left;
221			}
222
223			/**
224			* Get the right or last point of the pagination element.
225			*
226			* @param LengthAwarePaginator $paginator
227			* @return int
228			*/
229			public function getRightPoint(LengthAwarePaginator $paginator): int
230			{
231			$side = $paginator->onEachSide;
232			$current = $paginator->currentPage();
233			$last = $paginator->lastPage();
234
235			if (! empty($side)) {
236			$offset = $current <= $side ? $side - $current + 1 : 0;
237			$right = $current + $side + $offset;
238			}
239			if(!isset($right) \|\| $right > $last){
240			return $last;
241			}
242			return $right;
243			}
244
245			/**
246			* Render a plain html list with previous, next and all urls. The current page gets a current class on the list item.
247			*
248			* @param LengthAwarePaginator $paginator
249			* @param bool $full Return the full version of the URL in for the first page
250			* Ex. /users/page/1 instead of /users
251			* @param string $class Include class on pagination list
252			* Ex. <ul class="pagination">
253			* @param bool $additionalLinks Include prev and next links on pagination list
254			*
255			* @return string
256			*/
257
258			public function renderPageList(LengthAwarePaginator $paginator, $full = false, $class = null, $additionalLinks = false)
259			{
260			$urls = $this->allUrls($paginator, $full);
261			if ($class !== null) {
262			$class = " class=\"$class\"";
263			}
264			$listItems = "<ul{$class}>";
265			if ($this->hasPreviousPage() && $additionalLinks) {
266			$listItems .= "<li class='page-item'> <a class='page-link' href=\"{$this->previousPageUrl()}\">«</a></li>";
267			}
268			foreach ($urls as $i => $url) {
269			$pageNum = $i;
270			$css = ' class="page-item"';
271			$link = "<a class='page-link' href=\"{$url}\">{$pageNum}</a>";
272			if ($pageNum === $this->currentPage()) {
273			$css = ' class="page-item active"';
274			$link = "<span class='page-link' href=\"{$url}\">{$pageNum}</span>";
275			}
276			$listItems .= "<li{$css}>$link</li>";
277			}
278			if ($this->hasNextPage($paginator) && $additionalLinks) {
279			$listItems .= "<li class='page-item'> <a class='page-link' href=\"{$this->nextPageUrl($paginator)}\">»</a></li>";
280			}
281			$listItems .= '</ul>';
282			return $listItems;
283			}
284			/**
285			* Render html link tags for SEO indication of previous and next page.
286			*
287			* @param LengthAwarePaginator $paginator
288			* @param bool $full Return the full version of the URL in for the first page
289			* Ex. /users/page/1 instead of /users
290			*
291			* @return string
292			*/
293			public function renderRelLinks(LengthAwarePaginator $paginator, $full = false): string
294			{
295			$urls = $this->allUrls($paginator, $full);
296
297			$linkItems = '';
298
299			foreach ($urls as $i => $url) {
300			$pageNum = $i + 1;
301
302			switch ($pageNum - $this->currentPage()) {
303			case -1:
304			$linkItems .= "<link rel=\"prev\" href=\"{$url}\" />";
305			break;
306			case 1:
307			$linkItems .= "<link rel=\"next\" href=\"{$url}\" />";
308			break;
309			}
310			}
311
312			return $linkItems;
313			}
314
315			/**
316			* @param LengthAwarePaginator $paginator
317			* @param bool $full Return the full version of the URL in for the first page
318			* Ex. /users/page/1 instead of /users
319			*
320			* @return string
321			*@deprecated in favor of renderPageList.
322			*
323			*/
324			public function renderHtml(LengthAwarePaginator $paginator, $full = false): string
325			{
326			return $this->renderPageList($paginator, $full);
327			}
328
329			/**
330			* Generate a page URL, based on the request's current URL.
331			*
332			* @param int $page
333			* @param bool $full Return the full version of the URL in for the first page
334			* Ex. /users/page/1 instead of /users
335			*
336			* @return string
337			*/
338			public function pageUrl($page, $full = false): string
339			{
340			$currentPageUrl = $this->router->getCurrentRoute()->uri();
341
342			$url = $this->addPageQuery(str_replace('{pageQuery?}', '', $currentPageUrl), $page, $full);
343
344			foreach ((new RouteParameterBinder($this->router->getCurrentRoute()))->parameters(app('request')) as $parameterName => $parameterValue) {
			0 ignored issues – show Bug introduced 2020-01-01 13:13 UTC by Report Bug Copy Issue Report It seems like `$this->router->getCurrentRoute()` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
345			$url = str_replace(['{'.$parameterName.'}', '{'.$parameterName.'?}'], $parameterValue, $url);
346			}
347
348			$query = Request::getQueryString();
349
350			$query = $query
351			? '?'.$query
352			: '';
353
354			return $this->urlGenerator->to($url).$query;
355			}
356
357			/**
358			* Append the page query to a URL.
359			*
360			* @param string $url
361			* @param int $page
362			* @param bool $full Return the full version of the URL in for the first page
363			* Ex. /users/page/1 instead of /users
364			*
365			* @return string
366			*/
367			public function addPageQuery($url, $page, $full = false): string
368			{
369			// If the first page's URL is requested and $full is set to false, there's nothing to be added.
370			if ($page === 1 && ! $full) {
371			return $url;
372			}
373
374			return trim($url, '/')."/{$this->pageKeyword}/{$page}";
375			}
376
377			/**
378			* Register the Route::paginate macro.
379			*/
380			public function registerMacros(): void
381			{
382			$pageKeyword = $this->pageKeyword;
383			$router = $this->router;
384
385			$router->macro('paginate', function ($uri, $action) use ($pageKeyword, $router) {
386			$route = null;
387
388			$router->group(
389			['middleware' => 'Vipertecpro\PaginateRoute\SetPageMiddleware'],
390			function () use ($pageKeyword, $router, $uri, $action, &$route) {
391			$route = $router->get($uri.'/{pageQuery?}', $action)->where('pageQuery', $pageKeyword.'/[0-9]+');
392			});
393
394			return $route;
395			});
396			}
397			}
398

vipertecpro / laravel-pretty-pagination

Push — master ( c95648...9320fe )

PaginateRoute::renderHtml() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like