Pages::__construct() - Code Metrics - csphere-cms/cSphere - Measure and Improve Code Quality continuously with Scrutinizer

Pages::__construct() A
last analyzed 2017-04-21 16:53 UTC

↳ Parent: Pages

Complexity

Conditions	2
Paths	2

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * Generate page turn links
 *
 * PHP Version 5
 *
 * @category  Core
 * @package   Pagination
 * @author    Hans-Joachim Piepereit <[email protected]>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

namespace csphere\core\pagination;

/**
 * Generate page turn links
 *
 * @category  Core
 * @package   Pagination
 * @author    Hans-Joachim Piepereit <[email protected]>
 * @copyright 2013 cSphere Team
 * @license   http://opensource.org/licenses/bsd-license Simplified BSD License
 * @link      http://www.csphere.eu
 **/

class Pages
{
    /**
     * Plugin name
     **/
    private $_plugin;

    /**
     * Action name
     **/
    private $_action;

    /**
     * Total amount of entries
     **/
    private $_total;

    /**
     * Limit of entries on a page
     **/
    private $_limit;

    /**
     * Page to start from
     **/
    private $_start;

    /**
     * Additional parameters for url
     **/
    private $_params = [];

    /**
     * Start a new page generator
     *
     * @param string $plugin Plugin name
     * @param string $action Action name
     * @param string $total  Amount of entries
     * @param string $limit  Limit of entries per page
     *
     * @return \csphere\core\pagination\Pages
     **/


    public function __construct($plugin, $action, $total, $limit)
    {
        // Store settings
        $this->_plugin = $plugin;
        $this->_action = $action;
        $this->_total  = (int)$total;
        $this->_limit  = (int)$limit;

        // Get start page and make sure its above zero
        $this->_start = (int)\csphere\core\http\Input::get('get', 'page');

        if ($this->_start < 1) {

            $this->_start = 1;
        }
    }

    /**
     * Generate page turn links
     *
     * @param boolean $light  Light version with only last, current and next page
     * @param boolean $arrows Whether or not to attach arrows for page turns
     *
     * @return string
     **/


    public function navigation($light = false, $arrows = true)
    {
        $data = [];

        // Set amount of pages and build page navigation
        $pages = ceil($this->_total / $this->_limit);

        // Use full or light mode
        if ($light == true) {


            $data['groups'] = $this->_light($pages);

        } else {

            $end = 3;

            // If there are very few pages end earlier or skip groups
            if ($end > $pages || $pages < 10) {

                $end = $pages;

            } elseif ($this->_start > 2 && $this->_start < 6) {

                $end = $this->_start + 1;
            }

            $data['groups'] = $this->_full($pages, $end);
        }

        // Generate template output
        $data['pages'] = $pages;

        $result = $this->_build($data, $arrows);

        return $result;
    }

    /**
     * Generate light layout
     *
     * @param integer $pages Amount of pages
     *
     * @return array
     **/


    private function _light($pages)
    {
        $groups = [];

        // Use current page as default
        $next = $this->_start - 1;
        $end  = $next + 2;

        // Handle special cases
        if ($this->_start == 1) {

            $next = 1;
            $end  = $next + 2;
        }

        if ($pages < 3) {

            $next = 1;
            $end  = $pages;

        } elseif ($this->_start >= $pages) {

            $next = $pages - 2;
            $end  = $pages;
        }

        $first    = $this->_group($next, $end);
        $groups[] = ['links' => $first, 'space' => 'no'];

        return $groups;
    }

    /**
     * Generate full layout
     *
     * @param integer $pages Amount of pages
     * @param integer $end   End of first group
     *
     * @return array
     **/


    private function _full($pages, $end)
    {
        $groups = [];

        // Generate first group of links
        $first    = $this->_group(1, $end);
        $groups[] = ['links' => $first, 'space' => 'no'];

        // Generate second group of links
        if ($pages > $end && $end < 4) {

            $middle = $this->_middle($pages);
            $end    = $middle['end'];

            $second   = $this->_group($middle['next'], $end);
            $groups[] = ['links' => $second, 'space' => 'yes'];
        }

        // Generate third group of links
        if ($pages > $end) {

            $next = $pages - 2;

            $third    = $this->_group($next, $pages);
            $groups[] = ['links' => $third, 'space' => 'yes'];
        }

        return $groups;
    }

    /**
     * Determine page start and end for middle part of full layout
     *
     * @param integer $pages Amount of pages
     *
     * @return array
     **/


    private function _middle($pages)
    {
        // Use current page as default
        $next = floor($pages / 2);
        $end  = $next + 2;

        // Handle special cases
        if ($this->_start > 5 && $this->_start < ($pages - 1)) {

            $next = $this->_start - 1;
            $end  = $next + 2;

            if ($this->_start > ($pages - 5)) {

                $next = $this->_start - 1;
                $end  = $pages;

                if ($next == ($pages - 1)) {

                    $next--;
                }
            }
        }

        // Build array for group method
        return ['next' => $next, 'end' => $end];
    }

    /**
     * Generate a group of links
     *
     * @param integer $start Start page
     * @param integer $end   Last page
     *
     * @return array
     **/


    private function _group($start, $end)
    {
        $params = $this->_params;
        $links  = [];

        // Display at least one page on start
        if ($start == 1 && $end < 1) {

            $end = 1;
        }

        // Create and concat all links
        for ($i = $start; $i <= $end; $i++) {

            // Check if link is to current page
            if ($i == $this->_start) {

                $links[] = ['page' => $i, 'href' => '', 'active' => 'yes'];

            } else {

                // Build href for link
                $params['page'] = $i;

                $href = \csphere\core\url\Link::href(
                    $this->_plugin, $this->_action, $params
                );

                $links[] = ['page' => $i, 'href' => $href, 'active' => 'no'];
            }
        }

        return $links;
    }

    /**
     * Generate arrows for navigation
     *
     * @param integer $pages Amount of pages
     *
     * @return array
     **/


    private function _arrows($pages)
    {
        $params = $this->_params;
        $arrows = [];

        // Add << and < arrows
        $arrows['first'] = 1;

        $prev = $this->_start - 1;

        if ($this->_start < 2) {

            $prev = 1;
        }

        $arrows['previous'] = $prev;

        // Add > and >> arrows
        $next = $this->_start + 1;

        if ($next > $pages) {

            $next = $pages;
        }

        $arrows['next'] = $next;

        $arrows['last'] = $pages;

        // Change arrows to links
        foreach ($arrows AS $name => $page) {

            $params['page'] = $page;

            $href = \csphere\core\url\Link::href(
                $this->_plugin, $this->_action, $params
            );

            $arrows[$name] = $href;
        }

        return $arrows;
    }

    /**
     * Create content from template file
     *
     * @param array   $data   Data array for template
     * @param boolean $arrows Whether or not to attach arrows for page turns
     *
     * @return string
     **/


    private function _build(array $data, $arrows)
    {
        $data['arrow'] = ['show' => 'no'];

        // Add links for arrows if requested
        if ($arrows == true) {


            $data['arrow'] = $this->_arrows((int)$data['pages']);

            $data['arrow']['show'] = 'yes';
        }


        // Get view driver object
        $loader = \csphere\core\service\Locator::get();
        $view = $loader->load('view');

        // Send data to view and fetch box result
        $view->template('default', 'core_pages', $data, true);
        $result = $view->box();

        return $result;
    }

    /**
     * Get offset e.g. for database queries
     *
     * @return integer
     **/


    public function offset()
    {
        $offset = ($this->_start - 1) * $this->_limit;

        return $offset;
    }

    /**
     * Set additional parameters
     *
     * @param array $params Parameters as an array of key value pairs
     *
     * @return boolean
     **/


    public function params(array $params)
    {
        $this->_params = $params;

        return true;
    }
}


1			<?php
2
3			/**
4			* Generate page turn links
5			*
6			* PHP Version 5
7			*
8			* @category Core
9			* @package Pagination
10			* @author Hans-Joachim Piepereit <[email protected]>
11			* @copyright 2013 cSphere Team
12			* @license http://opensource.org/licenses/bsd-license Simplified BSD License
13			* @link http://www.csphere.eu
14			**/
15
16			namespace csphere\core\pagination;
17
18			/**
19			* Generate page turn links
20			*
21			* @category Core
22			* @package Pagination
23			* @author Hans-Joachim Piepereit <[email protected]>
24			* @copyright 2013 cSphere Team
25			* @license http://opensource.org/licenses/bsd-license Simplified BSD License
26			* @link http://www.csphere.eu
27			**/
28
29			class Pages
30			{
31			/**
32			* Plugin name
33			**/
34			private $_plugin;
35
36			/**
37			* Action name
38			**/
39			private $_action;
40
41			/**
42			* Total amount of entries
43			**/
44			private $_total;
45
46			/**
47			* Limit of entries on a page
48			**/
49			private $_limit;
50
51			/**
52			* Page to start from
53			**/
54			private $_start;
55
56			/**
57			* Additional parameters for url
58			**/
59			private $_params = [];
60
61			/**
62			* Start a new page generator
63			*
64			* @param string $plugin Plugin name
65			* @param string $action Action name
66			* @param string $total Amount of entries
67			* @param string $limit Limit of entries per page
68			*
69			* @return \csphere\core\pagination\Pages
70			**/
			0 ignored issues – show Comprehensibility Best Practice introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history... Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
71
72			public function __construct($plugin, $action, $total, $limit)
73			{
74			// Store settings
75			$this->_plugin = $plugin;
76			$this->_action = $action;
77			$this->_total = (int)$total;
78			$this->_limit = (int)$limit;
79
80			// Get start page and make sure its above zero
81			$this->_start = (int)\csphere\core\http\Input::get('get', 'page');
82
83			if ($this->_start < 1) {
84
85			$this->_start = 1;
86			}
87			}
88
89			/**
90			* Generate page turn links
91			*
92			* @param boolean $light Light version with only last, current and next page
93			* @param boolean $arrows Whether or not to attach arrows for page turns
94			*
95			* @return string
96			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
97
98			public function navigation($light = false, $arrows = true)
99			{
100			$data = [];
101
102			// Set amount of pages and build page navigation
103			$pages = ceil($this->_total / $this->_limit);
104
105			// Use full or light mode
106			if ($light == true) {
			0 ignored issues – show Coding Style Best Practice introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
107
108			$data['groups'] = $this->_light($pages);
109
110			} else {
111
112			$end = 3;
113
114			// If there are very few pages end earlier or skip groups
115			if ($end > $pages \|\| $pages < 10) {
116
117			$end = $pages;
118
119			} elseif ($this->_start > 2 && $this->_start < 6) {
120
121			$end = $this->_start + 1;
122			}
123
124			$data['groups'] = $this->_full($pages, $end);
125			}
126
127			// Generate template output
128			$data['pages'] = $pages;
129
130			$result = $this->_build($data, $arrows);
131
132			return $result;
133			}
134
135			/**
136			* Generate light layout
137			*
138			* @param integer $pages Amount of pages
139			*
140			* @return array
141			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
142
143			private function _light($pages)
144			{
145			$groups = [];
146
147			// Use current page as default
148			$next = $this->_start - 1;
149			$end = $next + 2;
150
151			// Handle special cases
152			if ($this->_start == 1) {
153
154			$next = 1;
155			$end = $next + 2;
156			}
157
158			if ($pages < 3) {
159
160			$next = 1;
161			$end = $pages;
162
163			} elseif ($this->_start >= $pages) {
164
165			$next = $pages - 2;
166			$end = $pages;
167			}
168
169			$first = $this->_group($next, $end);
170			$groups[] = ['links' => $first, 'space' => 'no'];
171
172			return $groups;
173			}
174
175			/**
176			* Generate full layout
177			*
178			* @param integer $pages Amount of pages
179			* @param integer $end End of first group
180			*
181			* @return array
182			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
183
184			private function _full($pages, $end)
185			{
186			$groups = [];
187
188			// Generate first group of links
189			$first = $this->_group(1, $end);
190			$groups[] = ['links' => $first, 'space' => 'no'];
191
192			// Generate second group of links
193			if ($pages > $end && $end < 4) {
194
195			$middle = $this->_middle($pages);
196			$end = $middle['end'];
197
198			$second = $this->_group($middle['next'], $end);
199			$groups[] = ['links' => $second, 'space' => 'yes'];
200			}
201
202			// Generate third group of links
203			if ($pages > $end) {
204
205			$next = $pages - 2;
206
207			$third = $this->_group($next, $pages);
208			$groups[] = ['links' => $third, 'space' => 'yes'];
209			}
210
211			return $groups;
212			}
213
214			/**
215			* Determine page start and end for middle part of full layout
216			*
217			* @param integer $pages Amount of pages
218			*
219			* @return array
220			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
221
222			private function _middle($pages)
223			{
224			// Use current page as default
225			$next = floor($pages / 2);
226			$end = $next + 2;
227
228			// Handle special cases
229			if ($this->_start > 5 && $this->_start < ($pages - 1)) {
230
231			$next = $this->_start - 1;
232			$end = $next + 2;
233
234			if ($this->_start > ($pages - 5)) {
235
236			$next = $this->_start - 1;
237			$end = $pages;
238
239			if ($next == ($pages - 1)) {
240
241			$next--;
242			}
243			}
244			}
245
246			// Build array for group method
247			return ['next' => $next, 'end' => $end];
248			}
249
250			/**
251			* Generate a group of links
252			*
253			* @param integer $start Start page
254			* @param integer $end Last page
255			*
256			* @return array
257			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
258
259			private function _group($start, $end)
260			{
261			$params = $this->_params;
262			$links = [];
263
264			// Display at least one page on start
265			if ($start == 1 && $end < 1) {
266
267			$end = 1;
268			}
269
270			// Create and concat all links
271			for ($i = $start; $i <= $end; $i++) {
272
273			// Check if link is to current page
274			if ($i == $this->_start) {
275
276			$links[] = ['page' => $i, 'href' => '', 'active' => 'yes'];
277
278			} else {
279
280			// Build href for link
281			$params['page'] = $i;
282
283			$href = \csphere\core\url\Link::href(
284			$this->_plugin, $this->_action, $params
285			);
286
287			$links[] = ['page' => $i, 'href' => $href, 'active' => 'no'];
288			}
289			}
290
291			return $links;
292			}
293
294			/**
295			* Generate arrows for navigation
296			*
297			* @param integer $pages Amount of pages
298			*
299			* @return array
300			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
301
302			private function _arrows($pages)
303			{
304			$params = $this->_params;
305			$arrows = [];
306
307			// Add << and < arrows
308			$arrows['first'] = 1;
309
310			$prev = $this->_start - 1;
311
312			if ($this->_start < 2) {
313
314			$prev = 1;
315			}
316
317			$arrows['previous'] = $prev;
318
319			// Add > and >> arrows
320			$next = $this->_start + 1;
321
322			if ($next > $pages) {
323
324			$next = $pages;
325			}
326
327			$arrows['next'] = $next;
328
329			$arrows['last'] = $pages;
330
331			// Change arrows to links
332			foreach ($arrows AS $name => $page) {
333
334			$params['page'] = $page;
335
336			$href = \csphere\core\url\Link::href(
337			$this->_plugin, $this->_action, $params
338			);
339
340			$arrows[$name] = $href;
341			}
342
343			return $arrows;
344			}
345
346			/**
347			* Create content from template file
348			*
349			* @param array $data Data array for template
350			* @param boolean $arrows Whether or not to attach arrows for page turns
351			*
352			* @return string
353			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
354
355			private function _build(array $data, $arrows)
356			{
357			$data['arrow'] = ['show' => 'no'];
358
359			// Add links for arrows if requested
360			if ($arrows == true) {
			0 ignored issues – show Coding Style Best Practice introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
361
362			$data['arrow'] = $this->_arrows((int)$data['pages']);
363
364			$data['arrow']['show'] = 'yes';
365			}
366
367
368			// Get view driver object
369			$loader = \csphere\core\service\Locator::get();
370			$view = $loader->load('view');
371
372			// Send data to view and fetch box result
373			$view->template('default', 'core_pages', $data, true);
374			$result = $view->box();
375
376			return $result;
377			}
378
379			/**
380			* Get offset e.g. for database queries
381			*
382			* @return integer
383			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
384
385			public function offset()
386			{
387			$offset = ($this->_start - 1) * $this->_limit;
388
389			return $offset;
390			}
391
392			/**
393			* Set additional parameters
394			*
395			* @param array $params Parameters as an array of key value pairs
396			*
397			* @return boolean
398			**/
			0 ignored issues – show Coding Style introduced 2017-04-21 16:53 UTC by Report Bug Copy Issue Report There must be no blank lines after the function comment Loading history...
399
400			public function params(array $params)
401			{
402			$this->_params = $params;
403
404			return true;
405			}
406			}
407

csphere-cms / cSphere

Pages::__construct() A last analyzed 2017-04-21 16:53 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Pages::__construct() A
last analyzed 2017-04-21 16:53 UTC