Pagination::getTotalPages() - Code Metrics - Inspection of "Refactoring" - Compolomus/Pagination - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (7fe1ca)

by compolom

created 2022-03-30 22:29 UTC

Pagination::getTotalPages() A

↳ Parent: Pagination

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Compolomus\Pagination;

class Pagination
{
    private int $total;

    private int $page;

    private int $limit;

    private int $totalPages;

    private int $length;

    private string $pos;

    private bool $uiKeys;

    /**
     * @param int $page
     * @param int $limit
     * @param int $total
     * @param int $length
     * @param bool $uiKeys
     */
    public function __construct(int $page, int $limit, int $total, int $length = 3, bool $uiKeys = false)
    {
        $this->totalPages = (int) ceil($total / $limit);
        $this->page = $page > 1 ? ($page > $this->totalPages ? 1 : $page) : 1;
        $this->limit = $limit > 0 ? $limit : 10;
        $this->total = $total;
        $this->length = $length >= 0 ? $length : 3;
        $this->pos = $this->init();
        $this->uiKeys = $uiKeys;
    }

    private function init(): string
    {
        switch ($this->page) {
            case ($this->totalPages < 7):
            default:
                $pos = 'full';
                break;
            case (($this->page - $this->length) < 3):
                $pos = 'noLeftDots';
                break;
            case (($this->page - $this->length) >= 3 && ($this->totalPages - $this->page - $this->length) > 1):
                $pos = 'center';
                break;
            case (abs($this->totalPages - $this->page - $this->length) >= 0):
                $pos = 'noRightDots';
                break;
        }

        return $pos;
    }

    /**
     * @return int
     */
    public function getLimit(): int
    {
        return $this->limit;
    }

    /**
     * @return int
     */
    public function getEnd(): int
    {
        return $this->page === $this->totalPages ? $this->total : $this->page * $this->limit;
    }

    /**
     * @return int
     */
    public function getOffset(): int
    {
        return $this->page === 1 ? 0 : ($this->page - 1) * $this->limit;
    }

    /**
     * @return array
     */
    private function uiStart(): array
    {
        $result = [];

        if ($this->page > 1) {
            $result['prev'] = $this->page - 1;
        }
        if ($this->page !== 1) {
            $result['first'] = 1;
        }
        if ($this->page > 3) {
            $result['second'] = 2;
        }

        return $result;
    }

    /**
     * @return array
     */
    private function start(): array
    {
        $result = $this->uiKeys ? $this->uiStart() : [];

        return $this->pos !== 'full' ? $result : [];
    }

    /**
     * @return array
     */
    private function uiEnd(): array
    {
        $result = [];

        if ($this->page !== $this->totalPages) {
            $result['last'] = $this->totalPages;
        }
        if ($this->totalPages - $this->page > 0) {
            $result['next'] = $this->page + 1;
        }
        if ($this->totalPages - $this->page + $this->length > 3) {
            $result['preLast'] = $this->totalPages - 1;
        }

        return $result;
    }

    /**
     * @return array
     */
    private function end(): array
    {
        $result = $this->uiKeys ? $this->uiEnd() : [];

        return $this->pos !== 'full' ? $result : [];
    }

    /**
     * @return array
     */
    private function leftDots(): array
    {
        $result = [];

        if ($this->pos !== 'noLeftDots') {
            if ($this->uiKeys) {
                $result['leftDots'] = '...';
            } else {
                $result[] = '...';
            }
        }

        return $result;
    }

    /**
     * @return array
     */
    private function leftPad(): array
    {
        $result = [];
        $for = [];

        if ($this->page - $this->length > 1) {
            $result[] = 1;
        }
        foreach (range($this->page - 1, $this->page - $this->length) as $value) {
            if ($value > 0) {
                $for[] = $value;
            }
        }

        return $this->pos === 'full' ? [] : array_merge($result, $this->leftDots(), array_reverse($for));
    }

    /**
     * @return array
     */
    private function rightDots(): array
    {
        $result = [];

        if ($this->pos !== 'noRightDots') {
            if ($this->uiKeys) {
                $result['rightDots'] = '...';
            } else {
                $result[] = '...';
            }
        }

        return $result;
    }

    /**
     * @return array
     */
    private function rightPad(): array
    {
        $result = [];

        foreach (range($this->page + 1, $this->page + $this->length) as $value) {
            if ($value <= $this->totalPages) {
                $result[] = $value;
            }
        }

        $last = ($this->totalPages - $this->page - $this->length > 0) ? [$this->totalPages] : [];

        return $this->pos === 'full' ? [] : array_merge($result, $this->rightDots(), $last);
    }

    /**
     * @return array
     */
    private function full(): array
    {
        $result = [];

        foreach (range(1, $this->totalPages) as $value) {
            if ($this->uiKeys && $value === $this->page) {
                $result['current'] = $value;
            } else {
                $result[] = $value;
            }
        }

        return $result;
    }

    /**
     * @return array
     */
    private function getCurrent(): array
    {
        if ($this->uiKeys) {
            $result['current'] = $this->page;

        } else {
            $result[] = $this->page;
        }

        if ($this->pos === 'full') {
            $result = $this->full();
        }

        return $result;
    }

    /**
     * @return array
     */
    public function get(): array
    {
        return array_merge($this->start(), $this->leftPad(), $this->getCurrent(), $this->rightPad(), $this->end());
    }

    /**
     * @return int
     */
    public function getTotalPages(): int
    {
        return $this->totalPages;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Compolomus\Pagination;
6
7		class Pagination
8		{
9		private int $total;
10
11		private int $page;
12
13		private int $limit;
14
15		private int $totalPages;
16
17		private int $length;
18
19		private string $pos;
20
21		private bool $uiKeys;
22
23		/**
24		* @param int $page
25		* @param int $limit
26		* @param int $total
27		* @param int $length
28		* @param bool $uiKeys
29		*/
30	5	public function __construct(int $page, int $limit, int $total, int $length = 3, bool $uiKeys = false)
31		{
32	5	$this->totalPages = (int) ceil($total / $limit);
33	5	$this->page = $page > 1 ? ($page > $this->totalPages ? 1 : $page) : 1;
34	5	$this->limit = $limit > 0 ? $limit : 10;
35	5	$this->total = $total;
36	5	$this->length = $length >= 0 ? $length : 3;
37	5	$this->pos = $this->init();
38	5	$this->uiKeys = $uiKeys;
39		}
40
41	5	private function init(): string
42		{
43	5	switch ($this->page) {
44	5	case ($this->totalPages < 7):
45		default:
46	4	$pos = 'full';
47	4	break;
48	1	case (($this->page - $this->length) < 3):
49	1	$pos = 'noLeftDots';
50	1	break;
51	1	case (($this->page - $this->length) >= 3 && ($this->totalPages - $this->page - $this->length) > 1):
52	1	$pos = 'center';
53	1	break;
54	1	case (abs($this->totalPages - $this->page - $this->length) >= 0):
55	1	$pos = 'noRightDots';
56	1	break;
57		}
58
59	5	return $pos;
60		}
61
62		/**
63		* @return int
64		*/
65	1	public function getLimit(): int
66		{
67	1	return $this->limit;
68		}
69
70		/**
71		* @return int
72		*/
73	1	public function getEnd(): int
74		{
75	1	return $this->page === $this->totalPages ? $this->total : $this->page * $this->limit;
76		}
77
78		/**
79		* @return int
80		*/
81	1	public function getOffset(): int
82		{
83	1	return $this->page === 1 ? 0 : ($this->page - 1) * $this->limit;
84		}
85
86		/**
87		* @return array
88		*/
89		private function uiStart(): array
90		{
91		$result = [];
92
93		if ($this->page > 1) {
94		$result['prev'] = $this->page - 1;
95		}
96		if ($this->page !== 1) {
97		$result['first'] = 1;
98		}
99		if ($this->page > 3) {
100		$result['second'] = 2;
101		}
102
103		return $result;
104		}
105
106		/**
107		* @return array
108		*/
109	1	private function start(): array
110		{
111	1	$result = $this->uiKeys ? $this->uiStart() : [];
112
113	1	return $this->pos !== 'full' ? $result : [];
114		}
115
116		/**
117		* @return array
118		*/
119		private function uiEnd(): array
120		{
121		$result = [];
122
123		if ($this->page !== $this->totalPages) {
124		$result['last'] = $this->totalPages;
125		}
126		if ($this->totalPages - $this->page > 0) {
127		$result['next'] = $this->page + 1;
128		}
129		if ($this->totalPages - $this->page + $this->length > 3) {
130		$result['preLast'] = $this->totalPages - 1;
131		}
132
133		return $result;
134		}
135
136		/**
137		* @return array
138		*/
139	1	private function end(): array
140		{
141	1	$result = $this->uiKeys ? $this->uiEnd() : [];
142
143	1	return $this->pos !== 'full' ? $result : [];
144		}
145
146		/**
147		* @return array
148		*/
149	1	private function leftDots(): array
150		{
151	1	$result = [];
152
153	1	if ($this->pos !== 'noLeftDots') {
154	1	if ($this->uiKeys) {
155		$result['leftDots'] = '...';
156		} else {
157	1	$result[] = '...';
158		}
159		}
160
161	1	return $result;
162		}
163
164		/**
165		* @return array
166		*/
167	1	private function leftPad(): array
168		{
169	1	$result = [];
170	1	$for = [];
171
172	1	if ($this->page - $this->length > 1) {
173	1	$result[] = 1;
174		}
175	1	foreach (range($this->page - 1, $this->page - $this->length) as $value) {
176	1	if ($value > 0) {
177	1	$for[] = $value;
178		}
179		}
180
181	1	return $this->pos === 'full' ? [] : array_merge($result, $this->leftDots(), array_reverse($for));
182		}
183
184		/**
185		* @return array
186		*/
187	1	private function rightDots(): array
188		{
189	1	$result = [];
190
191	1	if ($this->pos !== 'noRightDots') {
192	1	if ($this->uiKeys) {
193		$result['rightDots'] = '...';
194		} else {
195	1	$result[] = '...';
196		}
197		}
198
199	1	return $result;
200		}
201
202		/**
203		* @return array
204		*/
205	1	private function rightPad(): array
206		{
207	1	$result = [];
208
209	1	foreach (range($this->page + 1, $this->page + $this->length) as $value) {
210	1	if ($value <= $this->totalPages) {
211	1	$result[] = $value;
212		}
213		}
214
215	1	$last = ($this->totalPages - $this->page - $this->length > 0) ? [$this->totalPages] : [];
216
217	1	return $this->pos === 'full' ? [] : array_merge($result, $this->rightDots(), $last);
218		}
219
220		/**
221		* @return array
222		*/
223		private function full(): array
224		{
225		$result = [];
226
227		foreach (range(1, $this->totalPages) as $value) {
228		if ($this->uiKeys && $value === $this->page) {
229		$result['current'] = $value;
230		} else {
231		$result[] = $value;
232		}
233		}
234
235		return $result;
236		}
237
238		/**
239		* @return array
240		*/
241	1	private function getCurrent(): array
242		{
243	1	if ($this->uiKeys) {
244		$result['current'] = $this->page;
		0 ignored issues – show Comprehensibility Best Practice introduced 2022-03-29 22:28 UTC by Report Bug Copy Issue Report `$result` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$result = array();` before regardless. Loading history...
245		} else {
246	1	$result[] = $this->page;
247		}
248
249	1	if ($this->pos === 'full') {
250		$result = $this->full();
251		}
252
253	1	return $result;
254		}
255
256		/**
257		* @return array
258		*/
259	1	public function get(): array
260		{
261	1	return array_merge($this->start(), $this->leftPad(), $this->getCurrent(), $this->rightPad(), $this->end());
262		}
263
264		/**
265		* @return int
266		*/
267		public function getTotalPages(): int
268		{
269		return $this->totalPages;
270		}
271		}
272

Compolomus / Pagination

Branch — master (7fe1ca)

Pagination::getTotalPages() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like