Inputs::setDefaultToHtml() - Code Metrics - Inspection of "support Bootstrap version 4. and allow Inputs to s..." - TuumPHP/Pagination - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5cf04a...7a5848 )

by Asao

created 2018-08-14 06:42 UTC

Inputs::setDefaultToHtml() A

↳ Parent: Inputs

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
namespace Tuum\Pagination;

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

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

TuumPHP / Pagination

GitHub Access Token became invalid

Push — master ( 5cf04a...7a5848 )

Inputs::setDefaultToHtml() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like