Inputs::getPagination() - Code Metrics - Inspection of "Merge branch 'refactor/output'" - TuumPHP/Pagination - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c21a18...869bac )

by Asao

created 2017-10-27 08:31 UTC

Inputs::getPagination() A

↳ Parent: Inputs

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
namespace Tuum\Pagination;

use Tuum\Pagination\Paginate\Paginate;
use Tuum\Pagination\Paginate\PaginateInterface;

class Inputs
{
    /**
     * @var string
     */
    public $pagerKey = '_page';

    /**
     * @var string
     */
    public $limitKey = '_limit';

    /**
     * @var int|null
     */
    private $total = null;

    /**
     * @var array
     */
    private $list = [];

    /**
     * @var string
     */
    public $path = '';

    /**
     * @var array
     */
    public $inputs = [];

    /**
     * @var PaginateInterface
     */
    private $paginate;

    /**
     * Inputs constructor.
     *
     * @param PaginateInterface $paginate
     */
    public function __construct($paginate = null)
    {
        $this->paginate = $paginate;
    }

    /**
     * get the limit, i.e. number of data per page.
     *
     * @return int
     */
    public function getLimit()
    {
        return (int)isset($this->inputs[$this->limitKey]) ? $this->inputs[$this->limitKey] : 20;
    }

    /**
     * get the offset for retrieving data.
     *
     * @return int
     */
    public function getOffset()
    {
        return $this->getLimit() * ($this->getPage() - 1);
    }

    /**
     * get the current page number, starting from 1.
     *
     * @return int
     */
    public function getPage()
    {
        return (int)isset($this->inputs[$this->pagerKey]) ? $this->inputs[$this->pagerKey] : 1;
    }

    /**
     * get any key from query.
     *
     * @param string     $key
     * @param null|mixed $alt
     * @return null|mixed
     */
    public function get($key, $alt = null)
    {
        return array_key_exists($key, $this->inputs)
            ? $this->inputs[$key]
            : $this->inputs[$key] = $alt;
    }

    /**
     * get total number of data.
     * - total: number of all the possible data which can be retrieved.
     * - count: number of data in the current list.
     *
     * @return int|null
     */
    public function getTotal()
    {
        return $this->total;
    }

    /**
     * set the total of data.
     *
     * @param int|null $total
     */
    public function setTotal($total)
    {
        $this->total = $total;
    }

    /**
     * set the data for list.
     *
     * @param mixed $list
     */
    public function setList($list)
    {
        $this->list = $list;

    }

    /**
     * get the data for list.
     *
     * @return null|array|mixed
     */
    public function getList()
    {
        return $this->list;
    }

    /**
     * get the count, i.e. number of data in the current list.
     * count is the number of data in the current list.
     *
     * @return int
     */
    public function getCount()
    {
        if (isset($this->list) && is_array($this->list)) {
            return count($this->list);
        }
        return 0;
    }
    
    /**
     * calculates the first page number, that is 1.
     *
     * @return int
     */
    public function calcFirstPage()
    {
        return 1;
    }

    /**
     * calculates the last pager number.
     *
     * @return int
     */
    public function calcLastPage()
    {
        $total = $this->getTotal();
        if (!$total) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            return $this->getPage() + 1;
        }
        $pages = $this->getLimit();
        return (integer)(ceil($total / $pages));
    }
    
    /**
     * @param null|int $page
     * @return string
     */
    public function getPath($page = null)
    {
        if (is_null($page)) {
            return $this->path;
        }
        $page = (int)$page;
        return $this->path . '?' . $this->pagerKey . '=' . $page;
    }

    /**
     * @return PaginateInterface
     */
    public function getPagination()
    {
        $paginate = $this->paginate ? $this->paginate->setInputs($this): Paginate::forge($this);
        
        return $paginate;
    }
}

1			<?php
2			namespace Tuum\Pagination;
3
4			use Tuum\Pagination\Paginate\Paginate;
5			use Tuum\Pagination\Paginate\PaginateInterface;
6
7			class Inputs
8			{
9			/**
10			* @var string
11			*/
12			public $pagerKey = '_page';
13
14			/**
15			* @var string
16			*/
17			public $limitKey = '_limit';
18
19			/**
20			* @var int\|null
21			*/
22			private $total = null;
23
24			/**
25			* @var array
26			*/
27			private $list = [];
28
29			/**
30			* @var string
31			*/
32			public $path = '';
33
34			/**
35			* @var array
36			*/
37			public $inputs = [];
38
39			/**
40			* @var PaginateInterface
41			*/
42			private $paginate;
43
44			/**
45			* Inputs constructor.
46			*
47			* @param PaginateInterface $paginate
48			*/
49			public function __construct($paginate = null)
50			{
51			$this->paginate = $paginate;
52			}
53
54			/**
55			* get the limit, i.e. number of data per page.
56			*
57			* @return int
58			*/
59			public function getLimit()
60			{
61			return (int)isset($this->inputs[$this->limitKey]) ? $this->inputs[$this->limitKey] : 20;
62			}
63
64			/**
65			* get the offset for retrieving data.
66			*
67			* @return int
68			*/
69			public function getOffset()
70			{
71			return $this->getLimit() * ($this->getPage() - 1);
72			}
73
74			/**
75			* get the current page number, starting from 1.
76			*
77			* @return int
78			*/
79			public function getPage()
80			{
81			return (int)isset($this->inputs[$this->pagerKey]) ? $this->inputs[$this->pagerKey] : 1;
82			}
83
84			/**
85			* get any key from query.
86			*
87			* @param string $key
88			* @param null\|mixed $alt
89			* @return null\|mixed
90			*/
91			public function get($key, $alt = null)
92			{
93			return array_key_exists($key, $this->inputs)
94			? $this->inputs[$key]
95			: $this->inputs[$key] = $alt;
96			}
97
98			/**
99			* get total number of data.
100			* - total: number of all the possible data which can be retrieved.
101			* - count: number of data in the current list.
102			*
103			* @return int\|null
104			*/
105			public function getTotal()
106			{
107			return $this->total;
108			}
109
110			/**
111			* set the total of data.
112			*
113			* @param int\|null $total
114			*/
115			public function setTotal($total)
116			{
117			$this->total = $total;
118			}
119
120			/**
121			* set the data for list.
122			*
123			* @param mixed $list
124			*/
125			public function setList($list)
126			{
127			$this->list = $list;
			0 ignored issues – show Documentation Bug introduced 2016-09-03 04:07 UTC by Report Bug Copy Issue Report It seems like `$list` of type `*` is incompatible with the declared type `array` of property `$list`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
128			}
129
130			/**
131			* get the data for list.
132			*
133			* @return null\|array\|mixed
134			*/
135			public function getList()
136			{
137			return $this->list;
138			}
139
140			/**
141			* get the count, i.e. number of data in the current list.
142			* count is the number of data in the current list.
143			*
144			* @return int
145			*/
146			public function getCount()
147			{
148			if (isset($this->list) && is_array($this->list)) {
149			return count($this->list);
150			}
151			return 0;
152			}
153
154			/**
155			* calculates the first page number, that is 1.
156			*
157			* @return int
158			*/
159			public function calcFirstPage()
160			{
161			return 1;
162			}
163
164			/**
165			* calculates the last pager number.
166			*
167			* @return int
168			*/
169			public function calcLastPage()
170			{
171			$total = $this->getTotal();
172			if (!$total) {
			0 ignored issues – show Bug Best Practice introduced 2016-09-03 04:07 UTC by Report Bug Copy Issue Report The expression `$total` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be zero. 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 `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
173			return $this->getPage() + 1;
174			}
175			$pages = $this->getLimit();
176			return (integer)(ceil($total / $pages));
177			}
178
179			/**
180			* @param null\|int $page
181			* @return string
182			*/
183			public function getPath($page = null)
184			{
185			if (is_null($page)) {
186			return $this->path;
187			}
188			$page = (int)$page;
189			return $this->path . '?' . $this->pagerKey . '=' . $page;
190			}
191
192			/**
193			* @return PaginateInterface
194			*/
195			public function getPagination()
196			{
197			$paginate = $this->paginate ? $this->paginate->setInputs($this): Paginate::forge($this);
198
199			return $paginate;
200			}
201			}

TuumPHP / Pagination

GitHub Access Token became invalid

Push — master ( c21a18...869bac )

Inputs::getPagination() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like