Control::loadState() - Code Metrics - ipublikuj-ui/visual-paginator - Measure and Improve Code Quality continuously with Scrutinizer

Control::loadState() A
last analyzed 2019-04-07 08:07 UTC

↳ Parent: Control

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Control.php
 *
 * @copyright	More in license.md
 * @license		http://www.ipublikuj.eu
 * @author		Adam Kadlec http://www.ipublikuj.eu
 * @package		iPublikuj:VisualPaginator!
 * @subpackage	Components
 * @since		5.0
 *
 * @date		12.03.14
 */

namespace IPub\VisualPaginator\Components;

use Nette;
use Nette\Application;
use Nette\Localization;
use Nette\Utils;

use IPub;
use IPub\VisualPaginator;
use IPub\VisualPaginator\Exceptions;

/**
 * Visual paginator control
 *
 * @package		iPublikuj:VisualPaginator!
 * @subpackage	Components
 *
 * @method onShowPage(Control $self, $page)
 *
 * @property Application\UI\ITemplate $template
 */
class Control extends Application\UI\Control
{
	/**
	 * @persistent int
	 */
	public $page = 1;

	/**
	 * Events
	 *
	 * @var array
	 */
	public $onShowPage;

	/**
	 * @var Utils\Paginator
	 */
	protected $paginator;

	/**
	 * @var string
	 */
	protected $templateFile;
        
        /**
         * @var int 
         */
        protected $displayRelatedPages;

	/**
	 * @var Localization\ITranslator
	 */
	protected $translator;

	/**
	 * @var bool
	 */
	protected $useAjax = TRUE;

	/**
	 * @param Localization\ITranslator $translator
	 */
	public function injectTranslator(Localization\ITranslator $translator = NULL)
	{
		$this->translator = $translator;
	}

	/**
	 * @param NULL|string $templateFile
	 * @param Nette\ComponentModel\IContainer $parent
	 * @param null $name
	 */
	public function __construct(
		$templateFile = NULL,
                $displayRelatedPages = NULL,
		Nette\ComponentModel\IContainer $parent = NULL, $name = NULL
	) {
		if ($templateFile) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$this->setTemplateFile($templateFile);
		}
                $this->displayRelatedPages = (int)$displayRelatedPages;
	}

	/**
	 * Render control
	 */
	public function render()
	{
		// Check if control has template
		if ($this->template instanceof Nette\Bridges\ApplicationLatte\Template) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
			// Assign vars to template
			$this->template->steps		= $this->getSteps();
			$this->template->paginator	= $this->getPaginator();
			$this->template->handle		= 'showPage!';
			$this->template->useAjax	= $this->useAjax;

			// Check if translator is available
			if ($this->getTranslator() instanceof Localization\ITranslator) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
				$this->template->setTranslator($this->getTranslator());
			}

			// If template was not defined before...
			if ($this->template->getFile() === NULL) {
				// ...try to get base component template file
				$templateFile = !empty($this->templateFile) ? $this->templateFile : __DIR__ . DIRECTORY_SEPARATOR .'template'. DIRECTORY_SEPARATOR .'default.latte';
				$this->template->setFile($templateFile);
			}

			// Render component template
			$this->template->render();

		} else {
			throw new Exceptions\InvalidStateException('Visual paginator control is without template.');
		}
	}

	/**
	 * @return $this
	 */
	public function enableAjax()
	{
		$this->useAjax = TRUE;

		return $this;
	}

	/**
	 * @return $this
	 */
	public function disableAjax()
	{
		$this->useAjax = FALSE;

		return $this;
	}

	/**
	 * @return Utils\Paginator
	 */
	public function getPaginator()
	{
		// Check if paginator is created
		if (!$this->paginator) {
			$this->paginator = new Utils\Paginator;
		}

		return $this->paginator;
	}

	/**
	 * Change default control template path
	 *
	 * @param string $templateFile
	 *
	 * @return $this
	 *
	 * @throws Exceptions\FileNotFoundException
	 */
	public function setTemplateFile($templateFile)
	{
		// Check if template file exists...
		if (!is_file($templateFile)) {
			// ...check if extension template is used
			if (is_file(__DIR__ . DIRECTORY_SEPARATOR .'template'. DIRECTORY_SEPARATOR . $templateFile)) {
				$templateFile = __DIR__ . DIRECTORY_SEPARATOR .'template'. DIRECTORY_SEPARATOR . $templateFile;

			} else {
				// ...if not throw exception
				throw new Exceptions\FileNotFoundException('Template file "'. $templateFile .'" was not found.');
			}
		}

		$this->templateFile = $templateFile;

		return $this;
	}

	/**
	 * @param Localization\ITranslator $translator
	 *
	 * @return $this
	 */
	public function setTranslator(Localization\ITranslator $translator)
	{
		$this->translator = $translator;

		return $this;
	}

	/**
	 * @return Localization\ITranslator|null
	 */
	public function getTranslator()
	{
		if ($this->translator instanceof Localization\ITranslator) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
			return $this->translator;
		}

		return NULL;
	}

	/**
	 * @return array
	 */
	public function getSteps()
	{
		// Get Nette paginator
		$paginator = $this->getPaginator();

		// Get actual paginator page
		$page = $paginator->page;

		if ($paginator->pageCount < 2) {
			$steps = [$page];

		} else {
                        $relatedPages = $this->displayRelatedPages ?: 3;
			$arr = range(max($paginator->firstPage, $page - $relatedPages), min($paginator->lastPage, $page + $relatedPages));
			$count = 4;
			$quotient = ($paginator->pageCount - 1) / $count;

			for ($i = 0; $i <= $count; $i++) {
				$arr[] = round($quotient * $i) + $paginator->firstPage;
			}

			sort($arr);

			$steps = array_values(array_unique($arr));
		}

		return $steps;
	}

	/**
	 * Loads state information
	 *
	 * @param  array
	 *
	 * @return void
	 */
	public function loadState(array $params): void
	{
		parent::loadState($params);

		$this->getPaginator()->page = $this->page;
	}

	/**
	 * @param int $page
	 */
	public function handleShowPage($page)
	{
		$this->onShowPage($this, $page);
	}
}


Control::loadState() A
last analyzed 2019-04-07 08:07 UTC

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1			<?php
2			/**
3			* Control.php
4			*
5			* @copyright More in license.md
6			* @license http://www.ipublikuj.eu
7			* @author Adam Kadlec http://www.ipublikuj.eu
8			* @package iPublikuj:VisualPaginator!
9			* @subpackage Components
10			* @since 5.0
11			*
12			* @date 12.03.14
13			*/
14
15			namespace IPub\VisualPaginator\Components;
16
17			use Nette;
18			use Nette\Application;
19			use Nette\Localization;
20			use Nette\Utils;
21
22			use IPub;
23			use IPub\VisualPaginator;
24			use IPub\VisualPaginator\Exceptions;
25
26			/**
27			* Visual paginator control
28			*
29			* @package iPublikuj:VisualPaginator!
30			* @subpackage Components
31			*
32			* @method onShowPage(Control $self, $page)
33			*
34			* @property Application\UI\ITemplate $template
35			*/
36			class Control extends Application\UI\Control
37			{
38			/**
39			* @persistent int
40			*/
41			public $page = 1;
42
43			/**
44			* Events
45			*
46			* @var array
47			*/
48			public $onShowPage;
49
50			/**
51			* @var Utils\Paginator
52			*/
53			protected $paginator;
54
55			/**
56			* @var string
57			*/
58			protected $templateFile;
59
60			/**
61			* @var int
62			*/
63			protected $displayRelatedPages;
64
65			/**
66			* @var Localization\ITranslator
67			*/
68			protected $translator;
69
70			/**
71			* @var bool
72			*/
73			protected $useAjax = TRUE;
74
75			/**
76			* @param Localization\ITranslator $translator
77			*/
78			public function injectTranslator(Localization\ITranslator $translator = NULL)
79			{
80			$this->translator = $translator;
81			}
82
83			/**
84			* @param NULL\|string $templateFile
85			* @param Nette\ComponentModel\IContainer $parent
86			* @param null $name
87			*/
88			public function __construct(
89			$templateFile = NULL,
90			$displayRelatedPages = NULL,
91			Nette\ComponentModel\IContainer $parent = NULL, $name = NULL
92			) {
93			if ($templateFile) {
			0 ignored issues – show Bug Best Practice introduced 2019-04-02 14:01 UTC by Report Bug Copy Issue Report The expression `$templateFile` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. 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 `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
94			$this->setTemplateFile($templateFile);
95			}
96			$this->displayRelatedPages = (int)$displayRelatedPages;
97			}
98
99			/**
100			* Render control
101			*/
102			public function render()
103			{
104			// Check if control has template
105			if ($this->template instanceof Nette\Bridges\ApplicationLatte\Template) {
			0 ignored issues – show Bug introduced 2017-07-07 14:44 UTC by Report Bug Copy Issue Report The class `Nette\Bridges\ApplicationLatte\Template` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
106			// Assign vars to template
107			$this->template->steps = $this->getSteps();
108			$this->template->paginator = $this->getPaginator();
109			$this->template->handle = 'showPage!';
110			$this->template->useAjax = $this->useAjax;
111
112			// Check if translator is available
113			if ($this->getTranslator() instanceof Localization\ITranslator) {
			0 ignored issues – show Bug introduced 2017-07-07 14:44 UTC by Report Bug Copy Issue Report The class `Nette\Localization\ITranslator` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
114			$this->template->setTranslator($this->getTranslator());
115			}
116
117			// If template was not defined before...
118			if ($this->template->getFile() === NULL) {
119			// ...try to get base component template file
120			$templateFile = !empty($this->templateFile) ? $this->templateFile : __DIR__ . DIRECTORY_SEPARATOR .'template'. DIRECTORY_SEPARATOR .'default.latte';
121			$this->template->setFile($templateFile);
122			}
123
124			// Render component template
125			$this->template->render();
126
127			} else {
128			throw new Exceptions\InvalidStateException('Visual paginator control is without template.');
129			}
130			}
131
132			/**
133			* @return $this
134			*/
135			public function enableAjax()
136			{
137			$this->useAjax = TRUE;
138
139			return $this;
140			}
141
142			/**
143			* @return $this
144			*/
145			public function disableAjax()
146			{
147			$this->useAjax = FALSE;
148
149			return $this;
150			}
151
152			/**
153			* @return Utils\Paginator
154			*/
155			public function getPaginator()
156			{
157			// Check if paginator is created
158			if (!$this->paginator) {
159			$this->paginator = new Utils\Paginator;
160			}
161
162			return $this->paginator;
163			}
164
165			/**
166			* Change default control template path
167			*
168			* @param string $templateFile
169			*
170			* @return $this
171			*
172			* @throws Exceptions\FileNotFoundException
173			*/
174			public function setTemplateFile($templateFile)
175			{
176			// Check if template file exists...
177			if (!is_file($templateFile)) {
178			// ...check if extension template is used
179			if (is_file(__DIR__ . DIRECTORY_SEPARATOR .'template'. DIRECTORY_SEPARATOR . $templateFile)) {
180			$templateFile = __DIR__ . DIRECTORY_SEPARATOR .'template'. DIRECTORY_SEPARATOR . $templateFile;
181
182			} else {
183			// ...if not throw exception
184			throw new Exceptions\FileNotFoundException('Template file "'. $templateFile .'" was not found.');
185			}
186			}
187
188			$this->templateFile = $templateFile;
189
190			return $this;
191			}
192
193			/**
194			* @param Localization\ITranslator $translator
195			*
196			* @return $this
197			*/
198			public function setTranslator(Localization\ITranslator $translator)
199			{
200			$this->translator = $translator;
201
202			return $this;
203			}
204
205			/**
206			* @return Localization\ITranslator\|null
207			*/
208			public function getTranslator()
209			{
210			if ($this->translator instanceof Localization\ITranslator) {
			0 ignored issues – show Bug introduced 2017-07-07 14:44 UTC by Report Bug Copy Issue Report The class `Nette\Localization\ITranslator` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
211			return $this->translator;
212			}
213
214			return NULL;
215			}
216
217			/**
218			* @return array
219			*/
220			public function getSteps()
221			{
222			// Get Nette paginator
223			$paginator = $this->getPaginator();
224
225			// Get actual paginator page
226			$page = $paginator->page;
227
228			if ($paginator->pageCount < 2) {
229			$steps = [$page];
230
231			} else {
232			$relatedPages = $this->displayRelatedPages ?: 3;
233			$arr = range(max($paginator->firstPage, $page - $relatedPages), min($paginator->lastPage, $page + $relatedPages));
234			$count = 4;
235			$quotient = ($paginator->pageCount - 1) / $count;
236
237			for ($i = 0; $i <= $count; $i++) {
238			$arr[] = round($quotient * $i) + $paginator->firstPage;
239			}
240
241			sort($arr);
242
243			$steps = array_values(array_unique($arr));
244			}
245
246			return $steps;
247			}
248
249			/**
250			* Loads state information
251			*
252			* @param array
253			*
254			* @return void
255			*/
256			public function loadState(array $params): void
257			{
258			parent::loadState($params);
259
260			$this->getPaginator()->page = $this->page;
261			}
262
263			/**
264			* @param int $page
265			*/
266			public function handleShowPage($page)
267			{
268			$this->onShowPage($this, $page);
269			}
270			}
271

ipublikuj-ui / visual-paginator

Control::loadState() A last analyzed 2019-04-07 08:07 UTC

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like

Control::loadState() A
last analyzed 2019-04-07 08:07 UTC