Pager::forge() - 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

Pager::forge() A

↳ Parent: Pager

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
namespace Tuum\Pagination;

use \Closure;
use Psr\Http\Message\ServerRequestInterface;

class Pager
{
    /**
     * a validation closure for $query input.
     *
     * @var \Closure
     */
    public $validator;

    /**
     * name for session storage key.
     *
     * @var string
     */
    private $name;

    /**
     * query key name for setting page number.
     *
     * @var string
     */
    private $pagerKey = '_page';

    /**
     * query key name for setting limit (per page number).
     *
     * @var string
     */
    private $limitKey = '_limit';

    /**
     * query for pager. maybe get from $_GET, or from session.
     *
     * @var array
     */
    private $inputs = [];

    /**
     * default values for input query ($this->inputs).
     *
     * @var array
     */
    private $defaultInputs = [];

    /**
     * path for the query.
     *
     * @var string
     */
    private $path;

    /**
     * @var Inputs
     */
    private $inputObject;

    /**
     * @param array        $default
     * @param null|Inputs  $inputObject
     */
    public function __construct(array $default = [], $inputObject = null)
    {
        $this->defaultInputs = $default + [
                $this->pagerKey => 1,
                $this->limitKey => 20
            ];
        $this->inputObject   = $inputObject;
    }

    /**
     * @param string $name
     * @param array  $default
     * @param null   $inputObject
     * @return Pager
     */
    public static function forge($name = '', array $default, $inputObject = null)
    {
        $self = new self($default, $inputObject);
        $self->name = $name ?: 'pager-' . $name;
        
        return $self;
    }

    /**
     * set a closure for validation.
     *
     * in PHP, sort of...
     * array_walk_recursive($_GET, $validator)
     *
     * @param Closure $validator
     */
    public function useValidator($validator)
    {
        $this->validator = $validator;
    }

    /**
     * set up pager using the PSR7 server request.
     *
     * @API
     * @param ServerRequestInterface $request
     * @return $this
     */
    public function withRequest($request)
    {
        return $this->withQuery(
            $request->getQueryParams(),
            $request->getUri()->getPath()
        );
    }

    /**
     * set up pager using the query data ($_GET) and pathInfo.
     *
     * @API
     * @param array $query query like $_GET
     * @param null  $path  path info
     * @return Pager
     */
    public function withQuery(array $query, $path = null)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $self = clone($this);
        $path = $path ?: htmlspecialchars($_SERVER['PATH_INFO'], ENT_QUOTES, 'UTF-8');
        $self->setSessionName($path);
        $self->loadPageKey($query);
        return $self;
    }

    /**
     * set query input data based on $query, or from session.
     *
     * @param array $query
     */
    private function loadPageKey($query)
    {
        if (!array_key_exists($this->pagerKey, $query)) {
            $this->inputs = $this->secureInput($query);
        } else {
            $this->inputs = $this->loadFromSession($query);
        }
        $this->inputs += $this->defaultInputs;
        $this->saveToSession();
    }

    /**
     * at least check if the input string does not have null-byte
     * and is a UTF-8 valid string.
     *
     * @param array $query
     * @return array
     */
    private function secureInput(array $query)
    {
        $secure = $this->validator ?: function (&$v) {
            if (!is_string($v) && !is_numeric($v)) {
                $v = '';
            } elseif (strpos($v, "\0") !== false) {
                $v = '';
            } elseif (!mb_check_encoding($v, 'UTF-8')) {
                $v = '';
            }
        };
        array_walk_recursive($query, $secure);
        return $query;
    }

    /**
     * load query input data from session.
     * the page number (pagerKey) is replaced with the input query's page.
     *
     * @param array $query
     * @return array
     */
    private function loadFromSession($query)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (isset($_SESSION) && array_key_exists($this->name, $_SESSION)) {
            $loaded = $_SESSION[$this->name];
        } else {
            // no session. just use the $query.
            return $this->secureInput($query);
        }
        // check if _page is specified in $query. if so, replace it with the saved value.
        if (isset($query[$this->pagerKey]) && $query[$this->pagerKey] >= 1) {
            $loaded[$this->pagerKey] = (int)$query[$this->pagerKey];
        }
        return $loaded;
    }

    /**
     * saves $this->inputs to session.
     */
    private function saveToSession()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (isset($_SESSION)) {
            $_SESSION[$this->name] = $this->inputs;
        }
    }

    /**
     * @param string $pathInfo
     */
    private function setSessionName($pathInfo)
    {
        $this->path = $pathInfo;
        $this->name = $this->name ?: 'pager-' . md5($pathInfo);
    }

    /**
     * call to construct your query based on the pager's input.
     *
     * @API
     * @param \Closure $closure
     * @return Inputs
     */
    public function call($closure)
    {
        $inputs = $this->forgeInputs();
        $closure($inputs);
        return $inputs;
    }

    /**
     * @return Inputs
     */
    public function getInputs()
    {
        return $this->forgeInputs();
    }

    /**
     * @return Inputs
     */
    private function forgeInputs()
    {
        $inputs           = $this->inputObject ? clone($this->inputObject) : new Inputs();
        $inputs->pagerKey = $this->pagerKey;
        $inputs->limitKey = $this->limitKey;
        $inputs->path     = $this->path;
        $inputs->inputs   = $this->inputs;

        return $inputs;
    }
}

1			<?php
2			namespace Tuum\Pagination;
3
4			use \Closure;
5			use Psr\Http\Message\ServerRequestInterface;
6
7			class Pager
8			{
9			/**
10			* a validation closure for $query input.
11			*
12			* @var \Closure
13			*/
14			public $validator;
15
16			/**
17			* name for session storage key.
18			*
19			* @var string
20			*/
21			private $name;
22
23			/**
24			* query key name for setting page number.
25			*
26			* @var string
27			*/
28			private $pagerKey = '_page';
29
30			/**
31			* query key name for setting limit (per page number).
32			*
33			* @var string
34			*/
35			private $limitKey = '_limit';
36
37			/**
38			* query for pager. maybe get from $_GET, or from session.
39			*
40			* @var array
41			*/
42			private $inputs = [];
43
44			/**
45			* default values for input query ($this->inputs).
46			*
47			* @var array
48			*/
49			private $defaultInputs = [];
50
51			/**
52			* path for the query.
53			*
54			* @var string
55			*/
56			private $path;
57
58			/**
59			* @var Inputs
60			*/
61			private $inputObject;
62
63			/**
64			* @param array $default
65			* @param null\|Inputs $inputObject
66			*/
67			public function __construct(array $default = [], $inputObject = null)
68			{
69			$this->defaultInputs = $default + [
70			$this->pagerKey => 1,
71			$this->limitKey => 20
72			];
73			$this->inputObject = $inputObject;
74			}
75
76			/**
77			* @param string $name
78			* @param array $default
79			* @param null $inputObject
80			* @return Pager
81			*/
82			public static function forge($name = '', array $default, $inputObject = null)
83			{
84			$self = new self($default, $inputObject);
85			$self->name = $name ?: 'pager-' . $name;
86
87			return $self;
88			}
89
90			/**
91			* set a closure for validation.
92			*
93			* in PHP, sort of...
94			* array_walk_recursive($_GET, $validator)
95			*
96			* @param Closure $validator
97			*/
98			public function useValidator($validator)
99			{
100			$this->validator = $validator;
101			}
102
103			/**
104			* set up pager using the PSR7 server request.
105			*
106			* @API
107			* @param ServerRequestInterface $request
108			* @return $this
109			*/
110			public function withRequest($request)
111			{
112			return $this->withQuery(
113			$request->getQueryParams(),
114			$request->getUri()->getPath()
115			);
116			}
117
118			/**
119			* set up pager using the query data ($_GET) and pathInfo.
120			*
121			* @API
122			* @param array $query query like $_GET
123			* @param null $path path info
124			* @return Pager
125			*/
126			public function withQuery(array $query, $path = null)
			0 ignored issues – show Coding Style introduced 2017-10-15 12:15 UTC by Report Bug Copy Issue Report `withQuery` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
127			{
128			$self = clone($this);
129			$path = $path ?: htmlspecialchars($_SERVER['PATH_INFO'], ENT_QUOTES, 'UTF-8');
130			$self->setSessionName($path);
131			$self->loadPageKey($query);
132			return $self;
133			}
134
135			/**
136			* set query input data based on $query, or from session.
137			*
138			* @param array $query
139			*/
140			private function loadPageKey($query)
141			{
142			if (!array_key_exists($this->pagerKey, $query)) {
143			$this->inputs = $this->secureInput($query);
144			} else {
145			$this->inputs = $this->loadFromSession($query);
146			}
147			$this->inputs += $this->defaultInputs;
148			$this->saveToSession();
149			}
150
151			/**
152			* at least check if the input string does not have null-byte
153			* and is a UTF-8 valid string.
154			*
155			* @param array $query
156			* @return array
157			*/
158			private function secureInput(array $query)
159			{
160			$secure = $this->validator ?: function (&$v) {
161			if (!is_string($v) && !is_numeric($v)) {
162			$v = '';
163			} elseif (strpos($v, "\0") !== false) {
164			$v = '';
165			} elseif (!mb_check_encoding($v, 'UTF-8')) {
166			$v = '';
167			}
168			};
169			array_walk_recursive($query, $secure);
170			return $query;
171			}
172
173			/**
174			* load query input data from session.
175			* the page number (pagerKey) is replaced with the input query's page.
176			*
177			* @param array $query
178			* @return array
179			*/
180			private function loadFromSession($query)
			0 ignored issues – show Coding Style introduced 2017-10-15 12:15 UTC by Report Bug Copy Issue Report `loadFromSession` uses the super-global variable `$_SESSION` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
181			{
182			if (isset($_SESSION) && array_key_exists($this->name, $_SESSION)) {
183			$loaded = $_SESSION[$this->name];
184			} else {
185			// no session. just use the $query.
186			return $this->secureInput($query);
187			}
188			// check if _page is specified in $query. if so, replace it with the saved value.
189			if (isset($query[$this->pagerKey]) && $query[$this->pagerKey] >= 1) {
190			$loaded[$this->pagerKey] = (int)$query[$this->pagerKey];
191			}
192			return $loaded;
193			}
194
195			/**
196			* saves $this->inputs to session.
197			*/
198			private function saveToSession()
			0 ignored issues – show Coding Style introduced 2017-10-15 12:15 UTC by Report Bug Copy Issue Report `saveToSession` uses the super-global variable `$_SESSION` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
199			{
200			if (isset($_SESSION)) {
201			$_SESSION[$this->name] = $this->inputs;
202			}
203			}
204
205			/**
206			* @param string $pathInfo
207			*/
208			private function setSessionName($pathInfo)
209			{
210			$this->path = $pathInfo;
211			$this->name = $this->name ?: 'pager-' . md5($pathInfo);
212			}
213
214			/**
215			* call to construct your query based on the pager's input.
216			*
217			* @API
218			* @param \Closure $closure
219			* @return Inputs
220			*/
221			public function call($closure)
222			{
223			$inputs = $this->forgeInputs();
224			$closure($inputs);
225			return $inputs;
226			}
227
228			/**
229			* @return Inputs
230			*/
231			public function getInputs()
232			{
233			return $this->forgeInputs();
234			}
235
236			/**
237			* @return Inputs
238			*/
239			private function forgeInputs()
240			{
241			$inputs = $this->inputObject ? clone($this->inputObject) : new Inputs();
242			$inputs->pagerKey = $this->pagerKey;
243			$inputs->limitKey = $this->limitKey;
244			$inputs->path = $this->path;
245			$inputs->inputs = $this->inputs;
246
247			return $inputs;
248			}
249			}

TuumPHP / Pagination

GitHub Access Token became invalid

Push — master ( c21a18...869bac )

Pager::forge() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like