Inputs::getList() - Code Metrics - TuumPHP/Pagination - Measure and Improve Code Quality continuously with Scrutinizer

Inputs::getList() A
last analyzed 2019-01-31 01:23 UTC

↳ Parent: Inputs

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
namespace Tuum\Pagination;

use Tuum\Pagination\Paginate\Paginate;
use Tuum\Pagination\Paginate\PaginateInterface;
use Tuum\Pagination\ToHtml\ToBootstrap3;

class Inputs
{
    /**
     * @var int
     */
    public $defaultLimit = 20;

    /**
     * @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 string      class name of ToHtmlInterface.
     */
    private $defaultToHtml = ToBootstrap3::class;

    /**
     * Inputs constructor.
     *
     */
    public function __construct()
    {
    }

    /**
     * get the limit, i.e. number of data per page.
     *
     * @return int
     */
    public function getLimit()
    {
        $limit = $this->getInt($this->limitKey, 0);
        return $limit > 1 ? $limit : $this->defaultLimit;
    }

    /**
     * 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()
    {
        $page = $this->getInt($this->pagerKey, 1);
        return $page > 0 ? $page : 1;
    }

    /**
     * @param string $key
     * @param int    $default
     * @return int
     */
    private function getInt($key, $default)
    {
        if (!isset($this->inputs[$key])) {
            return $default;
        }
        if (!$this->inputs[$key]) {
            return $default;
        }
        return (int) $this->inputs[$key];
    }

    /**
     * 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()
    {
        return Paginate::forge($this);
    }

    /**
     * @return string
     */
    public function __toString()
    {
        $class = $this->defaultToHtml;
        $toHtml = new $class(Paginate::forge($this));
        return (string) $toHtml;
    }

    /**
     * set a class to convert to html pagination.
     * The class must implement ToHtmlInterface.
     *
     * @param string $defaultToHtml
     */
    public function setDefaultToHtml($defaultToHtml)
    {
        $this->defaultToHtml = $defaultToHtml;
    }
}


1			<?php
2			namespace Tuum\Pagination;
3
4			use Tuum\Pagination\Paginate\Paginate;
5			use Tuum\Pagination\Paginate\PaginateInterface;
6			use Tuum\Pagination\ToHtml\ToBootstrap3;
7
8			class Inputs
9			{
10			/**
11			* @var int
12			*/
13			public $defaultLimit = 20;
14
15			/**
16			* @var string
17			*/
18			public $pagerKey = '_page';
19
20			/**
21			* @var string
22			*/
23			public $limitKey = '_limit';
24
25			/**
26			* @var int\|null
27			*/
28			private $total = null;
29
30			/**
31			* @var array
32			*/
33			private $list = [];
34
35			/**
36			* @var string
37			*/
38			public $path = '';
39
40			/**
41			* @var array
42			*/
43			public $inputs = [];
44
45			/**
46			* @var string class name of ToHtmlInterface.
47			*/
48			private $defaultToHtml = ToBootstrap3::class;
49
50			/**
51			* Inputs constructor.
52			*
53			*/
54			public function __construct()
55			{
56			}
57
58			/**
59			* get the limit, i.e. number of data per page.
60			*
61			* @return int
62			*/
63			public function getLimit()
64			{
65			$limit = $this->getInt($this->limitKey, 0);
66			return $limit > 1 ? $limit : $this->defaultLimit;
67			}
68
69			/**
70			* get the offset for retrieving data.
71			*
72			* @return int
73			*/
74			public function getOffset()
75			{
76			return $this->getLimit() * ($this->getPage() - 1);
77			}
78
79			/**
80			* get the current page number, starting from 1.
81			*
82			* @return int
83			*/
84			public function getPage()
85			{
86			$page = $this->getInt($this->pagerKey, 1);
87			return $page > 0 ? $page : 1;
88			}
89
90			/**
91			* @param string $key
92			* @param int $default
93			* @return int
94			*/
95			private function getInt($key, $default)
96			{
97			if (!isset($this->inputs[$key])) {
98			return $default;
99			}
100			if (!$this->inputs[$key]) {
101			return $default;
102			}
103			return (int) $this->inputs[$key];
104			}
105
106			/**
107			* get any key from query.
108			*
109			* @param string $key
110			* @param null\|mixed $alt
111			* @return null\|mixed
112			*/
113			public function get($key, $alt = null)
114			{
115			return array_key_exists($key, $this->inputs)
116			? $this->inputs[$key]
117			: $this->inputs[$key] = $alt;
118			}
119
120			/**
121			* get total number of data.
122			* - total: number of all the possible data which can be retrieved.
123			* - count: number of data in the current list.
124			*
125			* @return int\|null
126			*/
127			public function getTotal()
128			{
129			return $this->total;
130			}
131
132			/**
133			* set the total of data.
134			*
135			* @param int\|null $total
136			*/
137			public function setTotal($total)
138			{
139			$this->total = $total;
140			}
141
142			/**
143			* set the data for list.
144			*
145			* @param mixed $list
146			*/
147			public function setList($list)
148			{
149			$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...
150			}
151
152			/**
153			* get the data for list.
154			*
155			* @return null\|array\|mixed
156			*/
157			public function getList()
158			{
159			return $this->list;
160			}
161
162			/**
163			* get the count, i.e. number of data in the current list.
164			* count is the number of data in the current list.
165			*
166			* @return int
167			*/
168			public function getCount()
169			{
170			if (isset($this->list) && is_array($this->list)) {
171			return count($this->list);
172			}
173			return 0;
174			}
175
176			/**
177			* calculates the first page number, that is 1.
178			*
179			* @return int
180			*/
181			public function calcFirstPage()
182			{
183			return 1;
184			}
185
186			/**
187			* calculates the last pager number.
188			*
189			* @return int
190			*/
191			public function calcLastPage()
192			{
193			$total = $this->getTotal();
194			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...
195			return $this->getPage() + 1;
196			}
197			$pages = $this->getLimit();
198			return (integer)(ceil($total / $pages));
199			}
200
201			/**
202			* @param null\|int $page
203			* @return string
204			*/
205			public function getPath($page = null)
206			{
207			if (is_null($page)) {
208			return $this->path;
209			}
210			$page = (int)$page;
211			return $this->path . '?' . $this->pagerKey . '=' . $page;
212			}
213
214			/**
215			* @return PaginateInterface
216			*/
217			public function getPagination()
218			{
219			return Paginate::forge($this);
220			}
221
222			/**
223			* @return string
224			*/
225			public function __toString()
226			{
227			$class = $this->defaultToHtml;
228			$toHtml = new $class(Paginate::forge($this));
229			return (string) $toHtml;
230			}
231
232			/**
233			* set a class to convert to html pagination.
234			* The class must implement ToHtmlInterface.
235			*
236			* @param string $defaultToHtml
237			*/
238			public function setDefaultToHtml($defaultToHtml)
239			{
240			$this->defaultToHtml = $defaultToHtml;
241			}
242			}
243

TuumPHP / Pagination

GitHub Access Token became invalid

Inputs::getList() A last analyzed 2019-01-31 01:23 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Inputs::getList() A
last analyzed 2019-01-31 01:23 UTC