Paginator::shapeData() - Code Metrics - Inspection of "DataComponent: Tests (remember)" - hamburgscleanest/data-tables - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ccd76c...2762b1 )

by Timo

created 2017-04-11 13:00 UTC

Paginator::shapeData() A

↳ Parent: Paginator

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	0
cts	0
cp	0
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	0
crap	6

<?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;
    }

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

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

        return $this;
    }

    /**
     * How many surrounding pages should be shown?
     *
     * @param int $count
     * @return $this
     */
    public function surroundingPages($count = 2)
    {
        $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);
    }

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

        return $this->_buildPageUrl(1);
    }

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

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

    /**
     * @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);
    }

    /**
     * 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);
    }

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

        if ($symbol === null)
        {
            $symbol = $pagenumber;
        }

        $class = '';
        if (+$pagenumber === $this->_currentPage)
        {
            $class = ' class="active"';
        }

        return '<li' . $class . '><a href="' . $url . '">' . $symbol . '</a></li>';
    }

    /**
     * Renders a list of pages.
     *
     * @return string
     * @throws \RuntimeException
     */
    private function _renderPageList(): string
    {
        $start = $this->_currentPage - $this->_surroundingPages;
        if ($start < 1)
        {
            $start = 1;
        }

        $pageCount = $this->pageCount();
        $end = $this->_currentPage + $this->_surroundingPages;
        if ($end > $pageCount)
        {
            $end = $pageCount;
        }

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

        return $pageList;
    }

    /**
     * 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>';
    }
}

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

hamburgscleanest / data-tables

Push — master ( ccd76c...2762b1 )

Paginator::shapeData() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like