Paginator::_getStartPage() - Code Metrics - Inspection of "Return types and param types set.." - hamburgscleanest/data-tables - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a35e5d...c48d7b )

by Timo

created 2017-04-11 23:42 UTC

Paginator::_getStartPage() A

↳ Parent: Paginator

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	3
cts	3
cp	1
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	3
nc	2
nop	0
crap	2

<?php

namespace hamburgscleanest\DataTables\Models\DataComponents;

use hamburgscleanest\DataTables\Facades\UrlHelper;
use hamburgscleanest\DataTables\Models\DataComponent;
use Illuminate\Database\Eloquent\Builder;

/**
 * Class Paginator
 * @package hamburgscleanest\DataTables\Models\DataComponents
 */
class Paginator extends DataComponent {

    /** @var int */
    private $_perPage;

    /** @var int */
    private $_currentPage;

    /** @var string */
    private $_firstPageSymbol = 'first';

    /** @var string */
    private $_previousPageSymbol = '←';

    /** @var string */
    private $_nextPageSymbol = '→';

    /** @var string */
    private $_lastPageSymbol = 'last';

    /** @var int */
    private $_surroundingPages = 2;


    /**
     * Paginator constructor.
     * @param int $perPage
     */
    public function __construct(int $perPage = 15)
    {
        $this->_perPage = $perPage;
    }

    /**
     * How many entries per page?
     *
     * @param int $perPage
     * @return Paginator
     */
    public function entriesPerPage($perPage = 15): Paginator
    {
        $this->_perPage = $perPage;

        return $this;
    }

    /**
     * How many surrounding pages should be shown?
     *
     * @param int $count
     * @return Paginator
     */
    public function surroundingPages($count = 2): Paginator
    {
        $this->_surroundingPages = $count;

        return $this;
    }

    /**
     * @return Builder
     */
    public function _shapeData(): Builder
    {
        if ($this->_perPage === 0)
        {
            return $this->_queryBuilder;
        }

        return $this->_queryBuilder->limit($this->_perPage)->offset(($this->_currentPage - 1) * $this->_perPage);
    }

    /**
     * Render the page links.
     *
     * @return string
     * @throws \RuntimeException
     */
    public function render(): string
    {
        if ($this->_perPage === 0)
        {
            return '<ul class="pagination"><li class="active">1</li></ul>';
        }

        return '<ul class="pagination">' .
               $this->_renderListItem($this->_currentPage - 1, $this->_getFirstPageUrl(), $this->_firstPageSymbol) .
               $this->_renderListItem($this->_currentPage - 1, $this->_getPreviousPageUrl(), $this->_previousPageSymbol) .
               $this->_renderPageList() .
               $this->_renderListItem($this->_currentPage + 1, $this->_getNextPageUrl(), $this->_nextPageSymbol) .
               $this->_renderListItem($this->_currentPage + 1, $this->_getLastPageUrl(), $this->_lastPageSymbol) .
               '</ul>';
    }

    /**
     * Renders a list item with a page link.
     *
     * @param int $pagenumber
     * @param string $url
     * @param string|null $symbol
     *
     * @return string
     */
    private function _renderListItem(int $pagenumber, ? string $url, ? string $symbol = null): string
    {
        if ($url === null)
        {
            return '';
        }

        return '<li' . ($pagenumber === $this->_currentPage ? ' class="active"' : '') . '><a href="' . $url . '">' . ($symbol ?? $pagenumber) . '</a></li>';
    }

    /**
     * @return null|string
     * @throws \RuntimeException
     */
    private function _getFirstPageUrl()
    {
        if ($this->_currentPage <= $this->_surroundingPages + 1)
        {
            return null;
        }

        return $this->_buildPageUrl(1);
    }

    /**
     * Generate URL to jump to {$pageNumber}.
     *
     * @param int $pageNumber
     * @return string
     *
     * @throws \RuntimeException
     */
    private function _buildPageUrl(int $pageNumber): string
    {
        $parameters = UrlHelper::parameterizeQuery($this->_request->getQueryString());
        $parameters['page'] = $pageNumber;

        return $this->_request->url() . '?' . \http_build_query($parameters);
    }

    /**
     * @return null|string
     * @throws \RuntimeException
     */
    private function _getPreviousPageUrl()
    {
        $previousPage = $this->_currentPage - 1;
        if ($previousPage < 1)
        {
            return null;
        }

        return $this->_buildPageUrl($previousPage);
    }

    /**
     * Renders a list of pages.
     *
     * @return string
     * @throws \RuntimeException
     */
    private function _renderPageList(): string
    {
        $end = $this->_getEndPage();

        $pageList = '';
        for ($i = $this->_getStartPage(); $i <= $end; $i ++)
        {
            $pageList .= $this->_renderListItem($i, $this->_buildPageUrl($i));
        }

        return $pageList;
    }

    /**
     * @return int
     */
    private function _getEndPage(): int
    {
        $end = $this->_currentPage + $this->_surroundingPages;
        $pageCount = $this->pageCount();

        return $end > $pageCount ? $pageCount : $end;
    }

    /**
     * @return int
     */
    public function pageCount(): int
    {
        if ($this->_perPage === 0)
        {
            return 1;
        }

        $queryCount = $this->getQueryCount();
        if ($queryCount < $this->_perPage)
        {
            return 1;
        }

        return (int) \floor($queryCount / $this->_perPage);
    }

    /**
     * @return int
     */
    private function _getStartPage(): int
    {
        $start = $this->_currentPage - $this->_surroundingPages;

        return $start < 1 ? 1 : $start;
    }

    /**
     * @return null|string
     * @throws \RuntimeException
     */
    private function _getNextPageUrl()
    {
        if ($this->_currentPage >= $this->pageCount())
        {
            return null;
        }

        return $this->_buildPageUrl($this->_currentPage + 1);
    }

    /**
     * @return null|string
     * @throws \RuntimeException
     */
    private function _getLastPageUrl()
    {
        $lastPage = $this->pageCount();
        if ($this->_currentPage + $this->_surroundingPages >= $lastPage)
        {
            return null;
        }

        return $this->_buildPageUrl($lastPage);
    }

    protected function _afterInit()
    {
        $this->_currentPage = + $this->_request->get('page', 1);
    }
}

1		<?php
2
3		namespace hamburgscleanest\DataTables\Models\DataComponents;
4
5		use hamburgscleanest\DataTables\Facades\UrlHelper;
6		use hamburgscleanest\DataTables\Models\DataComponent;
7		use Illuminate\Database\Eloquent\Builder;
8
9		/**
10		* Class Paginator
11		* @package hamburgscleanest\DataTables\Models\DataComponents
12		*/
13		class Paginator extends DataComponent {
14
15		/** @var int */
16		private $_perPage;
17
18		/** @var int */
19		private $_currentPage;
20
21		/** @var string */
22		private $_firstPageSymbol = 'first';
23
24		/** @var string */
25		private $_previousPageSymbol = '←';
26
27		/** @var string */
28		private $_nextPageSymbol = '→';
29
30		/** @var string */
31		private $_lastPageSymbol = 'last';
32
33		/** @var int */
34		private $_surroundingPages = 2;
35
36
37		/**
38		* Paginator constructor.
39		* @param int $perPage
40		*/
41	3	public function __construct(int $perPage = 15)
42		{
43	3	$this->_perPage = $perPage;
44	3	}
45
46		/**
47		* How many entries per page?
48		*
49		* @param int $perPage
50		* @return Paginator
51		*/
52		public function entriesPerPage($perPage = 15): Paginator
53		{
54		$this->_perPage = $perPage;
55
56		return $this;
57		}
58
59		/**
60		* How many surrounding pages should be shown?
61		*
62		* @param int $count
63		* @return Paginator
64		*/
65		public function surroundingPages($count = 2): Paginator
66		{
67		$this->_surroundingPages = $count;
68
69		return $this;
70		}
71
72		/**
73		* @return Builder
74		*/
75		public function _shapeData(): Builder
76		{
77		if ($this->_perPage === 0)
78		{
79		return $this->_queryBuilder;
80		}
81
82		return $this->_queryBuilder->limit($this->_perPage)->offset(($this->_currentPage - 1) * $this->_perPage);
83		}
84
85		/**
86		* Render the page links.
87		*
88		* @return string
89		* @throws \RuntimeException
90		*/
91	2	public function render(): string
92		{
93	2	if ($this->_perPage === 0)
94		{
95	1	return '<ul class="pagination"><li class="active">1</li></ul>';
96		}
97
98		return '<ul class="pagination">' .
99	1	$this->_renderListItem($this->_currentPage - 1, $this->_getFirstPageUrl(), $this->_firstPageSymbol) .
100	1	$this->_renderListItem($this->_currentPage - 1, $this->_getPreviousPageUrl(), $this->_previousPageSymbol) .
101	1	$this->_renderPageList() .
102	1	$this->_renderListItem($this->_currentPage + 1, $this->_getNextPageUrl(), $this->_nextPageSymbol) .
103	1	$this->_renderListItem($this->_currentPage + 1, $this->_getLastPageUrl(), $this->_lastPageSymbol) .
104	1	'</ul>';
105		}
106
107		/**
108		* Renders a list item with a page link.
109		*
110		* @param int $pagenumber
111		* @param string $url
112		* @param string\|null $symbol
113		*
114		* @return string
115		*/
116	1	private function _renderListItem(int $pagenumber, ? string $url, ? string $symbol = null): string
117		{
118	1	if ($url === null)
119		{
120	1	return '';
121		}
122
123	1	return '<li' . ($pagenumber === $this->_currentPage ? ' class="active"' : '') . '><a href="' . $url . '">' . ($symbol ?? $pagenumber) . '</a></li>';
124		}
125
126		/**
127		* @return null\|string
128		* @throws \RuntimeException
129		*/
130	1	private function _getFirstPageUrl()
131		{
132	1	if ($this->_currentPage <= $this->_surroundingPages + 1)
133		{
134	1	return null;
135		}
136
137		return $this->_buildPageUrl(1);
138		}
139
140		/**
141		* Generate URL to jump to {$pageNumber}.
142		*
143		* @param int $pageNumber
144		* @return string
145		*
146		* @throws \RuntimeException
147		*/
148	1	private function _buildPageUrl(int $pageNumber): string
149		{
150	1	$parameters = UrlHelper::parameterizeQuery($this->_request->getQueryString());
151	1	$parameters['page'] = $pageNumber;
152
153	1	return $this->_request->url() . '?' . \http_build_query($parameters);
154		}
155
156		/**
157		* @return null\|string
158		* @throws \RuntimeException
159		*/
160	1	private function _getPreviousPageUrl()
161		{
162	1	$previousPage = $this->_currentPage - 1;
163	1	if ($previousPage < 1)
164		{
165	1	return null;
166		}
167
168		return $this->_buildPageUrl($previousPage);
169		}
170
171		/**
172		* Renders a list of pages.
173		*
174		* @return string
175		* @throws \RuntimeException
176		*/
177	1	private function _renderPageList(): string
178		{
179	1	$end = $this->_getEndPage();
180
181	1	$pageList = '';
182	1	for ($i = $this->_getStartPage(); $i <= $end; $i ++)
183		{
184	1	$pageList .= $this->_renderListItem($i, $this->_buildPageUrl($i));
185		}
186
187	1	return $pageList;
188		}
189
190		/**
191		* @return int
192		*/
193	1	private function _getEndPage(): int
194		{
195	1	$end = $this->_currentPage + $this->_surroundingPages;
196	1	$pageCount = $this->pageCount();
197
198	1	return $end > $pageCount ? $pageCount : $end;
199		}
200
201		/**
202		* @return int
203		*/
204	2	public function pageCount(): int
205		{
206	2	if ($this->_perPage === 0)
207		{
208	1	return 1;
209		}
210
211	1	$queryCount = $this->getQueryCount();
212	1	if ($queryCount < $this->_perPage)
213		{
214		return 1;
215		}
216
217	1	return (int) \floor($queryCount / $this->_perPage);
218		}
219
220		/**
221		* @return int
222		*/
223	1	private function _getStartPage(): int
224		{
225	1	$start = $this->_currentPage - $this->_surroundingPages;
226
227	1	return $start < 1 ? 1 : $start;
228		}
229
230		/**
231		* @return null\|string
232		* @throws \RuntimeException
233		*/
234	1	private function _getNextPageUrl()
235		{
236	1	if ($this->_currentPage >= $this->pageCount())
237		{
238		return null;
239		}
240
241	1	return $this->_buildPageUrl($this->_currentPage + 1);
242		}
243
244		/**
245		* @return null\|string
246		* @throws \RuntimeException
247		*/
248	1	private function _getLastPageUrl()
249		{
250	1	$lastPage = $this->pageCount();
251	1	if ($this->_currentPage + $this->_surroundingPages >= $lastPage)
252		{
253		return null;
254		}
255
256	1	return $this->_buildPageUrl($lastPage);
257		}
258
259	3	protected function _afterInit()
260		{
261	3	$this->_currentPage = + $this->_request->get('page', 1);
262		}
263		}

hamburgscleanest / data-tables

Push — master ( a35e5d...c48d7b )

Paginator::_getStartPage() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like