PaginateRoute::allUrls() - Code Metrics - Inspection of "Improve pagination markup to honor 5.7 onEachSide(..." - spatie/laravel-paginateroute - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#57)

unknown

created 2018-10-02 07:06 UTC

PaginateRoute::allUrls() B

↳ Parent: PaginateRoute

Complexity

Conditions	7
Paths	15

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	35
rs	8.4266
c	0
b	0
f	0
cc	7
nc	15
nop	2

<?php

namespace Spatie\PaginateRoute;

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

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

    /**
     * @var \Illuminate\Routing\Router
     */
    protected $router;

    /**
     * @var \Illuminate\Contracts\Routing\UrlGenerator
     */
    protected $urlGenerator;

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

    /**
     * @param \Illuminate\Translation\Translator         $translator
     * @param \Illuminate\Routing\Router                 $router
     * @param \Illuminate\Contracts\Routing\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)
    {
        return $this->currentPage() === $page;
    }

    /**
     * Get the next page number.
     *
     * @param \Illuminate\Contracts\Pagination\Paginator $paginator
     *
     * @return string|null
     */
    public function nextPage(Paginator $paginator)
    {
        if (! $paginator->hasMorePages()) {
            return;
        }

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

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

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

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

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

    /**
     * Get the previous page number.
     *
     * @return string|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()
    {
        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|null
     */
    public function previousPageUrl($full = false)
    {
        $previousPage = $this->previousPage();

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

        return $this->pageUrl($previousPage, $full);
    }
    /**
     * Get all urls in an array.
     *
     * @param \Illuminate\Contracts\Pagination\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)
    {
        if (! $paginator->hasPages()) {
            return [];
        }

        $urls = [];
        $side = $paginator->onEachSide;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $current = $paginator->currentPage();
        $last = $paginator->lastPage();

        if (!empty($side)) {
            $total = $current + $side;
            $first = $current - $side;
            if ($first < 1) {
                $first = 1;
                $total += $side;
            }
            if ($total > $last) {
                $total = $last;
                if ($first > $side + 1) {
                    $first -= $side;
                }
            }
        }
        else {
            $first = 1;
            $total = $last;
        }
        for ($page = $first; $page <= $total; $page++) {
            $urls[$page] = $this->pageUrl($page, $full);
        }

        return $urls;
    }

    /**
     * Render a plain html list with previous, next and all urls. The current page gets a current class on the list item.
     *
     * @param \Illuminate\Contracts\Pagination\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) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $class = " class=\"$class\"";
        }

        $listItems = "<ul{$class}>";

        if ($this->hasPreviousPage() && $additionalLinks) {
            $listItems .= "<li><a href=\"{$this->previousPageUrl()}\">&laquo;</a></li>";
        }

        foreach ($urls as $i => $url) {
            $pageNum = $i;
            $css = '';

            $link = "<a href=\"{$url}\">{$pageNum}</a>";
            if ($pageNum == $this->currentPage()) {
                $css = ' class="active"';
                $link = $pageNum;
            }

            $listItems .= "<li{$css}>$link</li>";
        }

        if ($this->hasNextPage($paginator) && $additionalLinks) {
            $listItems .= "<li><a href=\"{$this->nextPageUrl($paginator)}\">&raquo;</a></li>";
        }

        $listItems .= '</ul>';

        return $listItems;
    }

    /**
     * Render html link tags for SEO indication of previous and next page.
     *
     * @param \Illuminate\Contracts\Pagination\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)
    {
        $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;
    }

    /**
     * @deprecated in favor of renderPageList.
     *
     * @param \Illuminate\Contracts\Pagination\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 renderHtml(LengthAwarePaginator $paginator, $full = false)
    {
        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)
    {
        $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) {
            $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)
    {
        // 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()
    {
        $pageKeyword = $this->pageKeyword;
        $router = $this->router;

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

            $router->group(
                ['middleware' => 'Spatie\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 Spatie\PaginateRoute;
4
5			use Illuminate\Routing\Router;
6			use Illuminate\Translation\Translator;
7			use Illuminate\Support\Facades\Request;
8			use Illuminate\Routing\RouteParameterBinder;
9			use Illuminate\Contracts\Pagination\Paginator;
10			use Illuminate\Contracts\Routing\UrlGenerator;
11			use Illuminate\Contracts\Pagination\LengthAwarePaginator;
12
13			class PaginateRoute
14			{
15			/**
16			* @var \Illuminate\Translation\Translator
17			*/
18			protected $translator;
19
20			/**
21			* @var \Illuminate\Routing\Router
22			*/
23			protected $router;
24
25			/**
26			* @var \Illuminate\Contracts\Routing\UrlGenerator
27			*/
28			protected $urlGenerator;
29
30			/**
31			* @var string
32			*/
33			protected $pageKeyword;
34
35			/**
36			* @param \Illuminate\Translation\Translator $translator
37			* @param \Illuminate\Routing\Router $router
38			* @param \Illuminate\Contracts\Routing\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)
78			{
79			return $this->currentPage() === $page;
80			}
81
82			/**
83			* Get the next page number.
84			*
85			* @param \Illuminate\Contracts\Pagination\Paginator $paginator
86			*
87			* @return string\|null
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 \Illuminate\Contracts\Pagination\Paginator $paginator
102			*
103			* @return bool
104			*/
105			public function hasNextPage(Paginator $paginator)
106			{
107			return $this->nextPage($paginator) !== null;
108			}
109
110			/**
111			* Get the next page URL.
112			*
113			* @param \Illuminate\Contracts\Pagination\Paginator $paginator
114			*
115			* @return string\|null
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 string\|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()
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\|null
159			*/
160			public function previousPageUrl($full = false)
161			{
162			$previousPage = $this->previousPage();
163
164			if ($previousPage === null) {
165			return;
166			}
167
168			return $this->pageUrl($previousPage, $full);
169			}
170			/**
171			* Get all urls in an array.
172			*
173			* @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
174			* @param bool $full Return the full version of the URL in for the first page
175			* Ex. /users/page/1 instead of /users
176			*
177			* @return array
178			*/
179			public function allUrls(LengthAwarePaginator $paginator, $full = false)
180			{
181			if (! $paginator->hasPages()) {
182			return [];
183			}
184
185			$urls = [];
186			$side = $paginator->onEachSide;
			0 ignored issues – show Bug introduced 2018-10-02 06:57 UTC by Report Bug Copy Issue Report Accessing `onEachSide` on the interface `Illuminate\Contracts\Pag...on\LengthAwarePaginator` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
187			$current = $paginator->currentPage();
188			$last = $paginator->lastPage();
189
190			if (!empty($side)) {
191			$total = $current + $side;
192			$first = $current - $side;
193			if ($first < 1) {
194			$first = 1;
195			$total += $side;
196			}
197			if ($total > $last) {
198			$total = $last;
199			if ($first > $side + 1) {
200			$first -= $side;
201			}
202			}
203			}
204			else {
205			$first = 1;
206			$total = $last;
207			}
208			for ($page = $first; $page <= $total; $page++) {
209			$urls[$page] = $this->pageUrl($page, $full);
210			}
211
212			return $urls;
213			}
214
215			/**
216			* Render a plain html list with previous, next and all urls. The current page gets a current class on the list item.
217			*
218			* @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
219			* @param bool $full Return the full version of the URL in for the first page
220			* Ex. /users/page/1 instead of /users
221			* @param string $class Include class on pagination list
222			* Ex. <ul class="pagination">
223			* @param bool $additionalLinks Include prev and next links on pagination list
224			*
225			* @return string
226			*/
227			public function renderPageList(LengthAwarePaginator $paginator, $full = false, $class = null, $additionalLinks = false)
228			{
229			$urls = $this->allUrls($paginator, $full);
230
231			if ($class) {
			0 ignored issues – show Bug Best Practice introduced 2016-02-05 13:36 UTC by Report Bug Copy Issue Report The expression `$class` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
232			$class = " class=\"$class\"";
233			}
234
235			$listItems = "<ul{$class}>";
236
237			if ($this->hasPreviousPage() && $additionalLinks) {
238			$listItems .= "<li><a href=\"{$this->previousPageUrl()}\">«</a></li>";
239			}
240
241			foreach ($urls as $i => $url) {
242			$pageNum = $i;
243			$css = '';
244
245			$link = "<a href=\"{$url}\">{$pageNum}</a>";
246			if ($pageNum == $this->currentPage()) {
247			$css = ' class="active"';
248			$link = $pageNum;
249			}
250
251			$listItems .= "<li{$css}>$link</li>";
252			}
253
254			if ($this->hasNextPage($paginator) && $additionalLinks) {
255			$listItems .= "<li><a href=\"{$this->nextPageUrl($paginator)}\">»</a></li>";
256			}
257
258			$listItems .= '</ul>';
259
260			return $listItems;
261			}
262
263			/**
264			* Render html link tags for SEO indication of previous and next page.
265			*
266			* @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
267			* @param bool $full Return the full version of the URL in for the first page
268			* Ex. /users/page/1 instead of /users
269			*
270			* @return string
271			*/
272			public function renderRelLinks(LengthAwarePaginator $paginator, $full = false)
273			{
274			$urls = $this->allUrls($paginator, $full);
275
276			$linkItems = '';
277
278			foreach ($urls as $i => $url) {
279			$pageNum = $i + 1;
280
281			switch ($pageNum - $this->currentPage()) {
282			case -1:
283			$linkItems .= "<link rel=\"prev\" href=\"{$url}\" />";
284			break;
285			case 1:
286			$linkItems .= "<link rel=\"next\" href=\"{$url}\" />";
287			break;
288			}
289			}
290
291			return $linkItems;
292			}
293
294			/**
295			* @deprecated in favor of renderPageList.
296			*
297			* @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
298			* @param bool $full Return the full version of the URL in for the first page
299			* Ex. /users/page/1 instead of /users
300			*
301			* @return string
302			*/
303			public function renderHtml(LengthAwarePaginator $paginator, $full = false)
304			{
305			return $this->renderPageList($paginator, $full);
306			}
307
308			/**
309			* Generate a page URL, based on the request's current URL.
310			*
311			* @param int $page
312			* @param bool $full Return the full version of the URL in for the first page
313			* Ex. /users/page/1 instead of /users
314			*
315			* @return string
316			*/
317			public function pageUrl($page, $full = false)
318			{
319			$currentPageUrl = $this->router->getCurrentRoute()->uri();
320
321			$url = $this->addPageQuery(str_replace('{pageQuery?}', '', $currentPageUrl), $page, $full);
322
323			foreach ((new RouteParameterBinder($this->router->getCurrentRoute()))->parameters(app('request')) as $parameterName => $parameterValue) {
324			$url = str_replace(['{'.$parameterName.'}', '{'.$parameterName.'?}'], $parameterValue, $url);
325			}
326
327			$query = Request::getQueryString();
328
329			$query = $query
330			? '?'.$query
331			: '';
332
333			return $this->urlGenerator->to($url).$query;
334			}
335
336			/**
337			* Append the page query to a URL.
338			*
339			* @param string $url
340			* @param int $page
341			* @param bool $full Return the full version of the URL in for the first page
342			* Ex. /users/page/1 instead of /users
343			*
344			* @return string
345			*/
346			public function addPageQuery($url, $page, $full = false)
347			{
348			// If the first page's URL is requested and $full is set to false, there's nothing to be added.
349			if ($page === 1 && ! $full) {
350			return $url;
351			}
352
353			return trim($url, '/')."/{$this->pageKeyword}/{$page}";
354			}
355
356			/**
357			* Register the Route::paginate macro.
358			*/
359			public function registerMacros()
360			{
361			$pageKeyword = $this->pageKeyword;
362			$router = $this->router;
363
364			$router->macro('paginate', function ($uri, $action) use ($pageKeyword, $router) {
365			$route = null;
366
367			$router->group(
368			['middleware' => 'Spatie\PaginateRoute\SetPageMiddleware'],
369			function () use ($pageKeyword, $router, $uri, $action, &$route) {
370			$route = $router->get($uri.'/{pageQuery?}', $action)->where('pageQuery', $pageKeyword.'/[0-9]+');
371			});
372
373			return $route;
374			});
375			}
376			}
377

spatie / laravel-paginateroute

Pull Request — master (#57)

PaginateRoute::allUrls() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like