DeviceView::getViewType() - Code Metrics - Inspection of "- Upgrading to nette 2.4" - iPublikuj/mobile-detect - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 9edc41...f34eb1 )

by Adam

created 2018-01-14 13:48 UTC

DeviceView::getViewType() A

↳ Parent: DeviceView

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
ccs	1
cts	1
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/**
 * DeviceView.php
 *
 * @copyright      More in license.md
 * @license        http://www.ipublikuj.eu
 * @author         Adam Kadlec http://www.ipublikuj.eu
 * @package        iPublikuj:MobileDetect!
 * @subpackage     Helpers
 * @since          1.0.0
 *
 * @date           23.04.14
 */

declare(strict_types = 1);

namespace IPub\MobileDetect\Helpers;

use Nette;
use Nette\Application;
use Nette\Http;
use Nette\Utils;

/**
 * Device view detector helper
 *
 * @package        iPublikuj:MobileDetect!
 * @subpackage     Helpers
 *
 * @author         Adam Kadlec <[email protected]>
 */
final class DeviceView
{
	/**
	 * Implement nette smart magic
	 */
	use Nette\SmartObject;

	const VIEW_MOBILE = 'mobile';
	const VIEW_PHONE = 'phone';
	const VIEW_TABLET = 'tablet';
	const VIEW_FULL = 'full';
	const VIEW_NOT_MOBILE = 'not_mobile';

	/**
	 * @var Http\IRequest
	 */
	private $httpRequest;

	/**
	 * @var Http\IResponse
	 */
	private $httpResponse;

	/**
	 * @var string
	 */
	private $viewType = self::VIEW_FULL;

	/**
	 * @var CookieSettings
	 */
	private $cookieSettings;

	/**
	 * @var string
	 */
	private $switchParameterName = 'device_view';

	/**
	 * @param string $setSwitchParameterName
	 * @param CookieSettings $cookieSettings
	 * @param Http\IRequest $httpRequest
	 * @param Http\IResponse $httpResponse
	 */
	public function __construct(string $setSwitchParameterName, CookieSettings $cookieSettings, Http\IRequest $httpRequest, Http\IResponse $httpResponse)
	{
		$this->cookieSettings = $cookieSettings;
		$this->httpRequest = $httpRequest;
		$this->httpResponse = $httpResponse;

		$this->switchParameterName = $setSwitchParameterName;

		if ($this->httpRequest->getQuery($this->switchParameterName, FALSE)) {
			$this->viewType = $this->httpRequest->getQuery($this->switchParameterName);

		} elseif ($this->httpRequest->getCookie($this->cookieSettings->getName())) {
			$this->viewType = $this->httpRequest->getCookie($this->cookieSettings->getName());
		}
	}

	/**
	 * Gets the view type for a device
	 *
	 * @return string
	 */
	public function getViewType() : string
	{
		return $this->viewType;
	}

	/**
	 * Is the device in full view
	 *
	 * @return bool
	 */
	public function isFullView() : bool
	{
		return $this->viewType === self::VIEW_FULL;
	}

	/**
	 * Is the device a tablet view type
	 *
	 * @return bool
	 */
	public function isTabletView() : bool
	{
		return $this->viewType === self::VIEW_TABLET;
	}

	/**
	 * Is the device a phone view type
	 *
	 * @return bool
	 */
	public function isPhoneView() : bool
	{
		return $this->viewType === self::VIEW_PHONE;
	}

	/**
	 * Is the device a mobile view type
	 *
	 * @return bool
	 */
	public function isMobileView() : bool
	{
		return $this->viewType === self::VIEW_MOBILE || $this->isPhoneView() || $this->isTabletView();
	}

	/**
	 * Is not the device a mobile view type (PC, Mac, etc.)
	 *
	 * @return bool
	 */
	public function isNotMobileView() : bool
	{
		return $this->viewType === self::VIEW_NOT_MOBILE;
	}

	/**
	 * Sets the tablet view type
	 *
	 * @return void
	 */
	public function setTabletView() : void
	{
		$this->viewType = self::VIEW_TABLET;
	}

	/**
	 * Sets the phone view type
	 *
	 * @return void
	 */
	public function setPhoneView() : void
	{
		$this->viewType = self::VIEW_PHONE;
	}

	/**
	 * Sets the mobile view type
	 *
	 * @return void
	 */
	public function setMobileView() : void
	{
		$this->viewType = self::VIEW_MOBILE;
	}

	/**
	 * Sets the not mobile view type
	 *
	 * @return void
	 */
	public function setNotMobileView() : void
	{
		$this->viewType = self::VIEW_NOT_MOBILE;
	}

	/**
	 * @return string
	 */
	public function getSwitchParameterName() : string
	{
		$this->switchParameterName;
	}

	/**
	 * Gets the switch param value from the query string (GET header)
	 *
	 * @return string
	 */
	public function getSwitchParameterValue() : string
	{
		return $this->httpRequest->getQuery($this->switchParameterName, self::VIEW_FULL);
	}

	/**
	 * Has the Request the switch param in the query string (GET header)
	 *
	 * @return bool
	 */
	public function hasSwitchParameter() : bool
	{
		return $this->httpRequest->getQuery($this->switchParameterName, FALSE) ? TRUE : FALSE;
	}

	/**
	 * Gets the RedirectResponse by switch param value
	 *
	 * @param string $redirectUrl
	 *
	 * @return Application\Responses\RedirectResponse
	 */
	public function getRedirectResponseBySwitchParam(string $redirectUrl) : Application\Responses\RedirectResponse
	{
		$statusCode = 302;

		switch ($this->getSwitchParameterValue()) {
			case self::VIEW_MOBILE:
				$this->createCookie(self::VIEW_MOBILE);
				break;

			case self::VIEW_PHONE:
				$this->createCookie(self::VIEW_PHONE);
				break;

			case self::VIEW_TABLET:
				$this->createCookie(self::VIEW_TABLET);
				break;

			default:
				$this->createCookie(self::VIEW_FULL);
				break;
		}

		return new Application\Responses\RedirectResponse($redirectUrl, $statusCode);
	}

	/**
	 * Modifies the Response for non-mobile devices
	 *
	 * @return Http\IResponse
	 */
	public function modifyNotMobileResponse() : Http\IResponse
	{
		// Create cookie
		$this->createCookie(self::VIEW_NOT_MOBILE);

		return $this->httpResponse;
	}

	/**
	 * Modifies the Response for tablet devices
	 *
	 * @return Http\IResponse
	 */
	public function modifyTabletResponse() : Http\IResponse
	{
		// Create cookie
		$this->createCookie(self::VIEW_TABLET);

		return $this->httpResponse;
	}

	/**
	 * Modifies the Response for phone devices
	 *
	 * @return Http\IResponse
	 */
	public function modifyPhoneResponse() : Http\IResponse
	{
		// Create cookie
		$this->createCookie(self::VIEW_PHONE);

		return $this->httpResponse;
	}

	/**
	 * Modifies the Response for mobile devices
	 *
	 * @return Http\IResponse
	 */
	public function modifyMobileResponse() : Http\IResponse
	{
		// Create cookie
		$this->createCookie(self::VIEW_MOBILE);

		return $this->httpResponse;
	}

	/**
	 * Gets the RedirectResponse for phone devices
	 *
	 * @param string $host    Uri host
	 * @param int $statusCode Status code
	 *
	 * @return Application\Responses\RedirectResponse
	 */
	public function getPhoneRedirectResponse(string $host, int $statusCode) : Application\Responses\RedirectResponse
	{
		// Create cookie
		$this->createCookie(self::VIEW_PHONE);

		return new Application\Responses\RedirectResponse($host, $statusCode);
	}

	/**
	 * Gets the RedirectResponse for tablet devices
	 *
	 * @param string $host    Uri host
	 * @param int $statusCode Status code
	 *
	 * @return Application\Responses\RedirectResponse
	 */
	public function getTabletRedirectResponse(string $host, int $statusCode) : Application\Responses\RedirectResponse
	{
		// Create cookie
		$this->createCookie(self::VIEW_TABLET);

		return new Application\Responses\RedirectResponse($host, $statusCode);
	}

	/**
	 * Gets the RedirectResponse for mobile devices
	 *
	 * @param string $host    Uri host
	 * @param int $statusCode Status code
	 *
	 * @return Application\Responses\RedirectResponse
	 */
	public function getMobileRedirectResponse(string $host, int $statusCode) : Application\Responses\RedirectResponse
	{
		// Create cookie
		$this->createCookie(self::VIEW_MOBILE);

		return new Application\Responses\RedirectResponse($host, $statusCode);
	}

	/**
	 * Gets the cookie
	 *
	 * @param string $cookieValue
	 *
	 * @return void
	 */
	private function createCookie(string $cookieValue) : void
	{
		// Store cookie in response
		$this->httpResponse->setCookie(
			$this->cookieSettings->getName(),
			$cookieValue,
			$this->cookieSettings->getExpiresTime(),
			$this->cookieSettings->getPath(),
			$this->cookieSettings->getDomain(),
			$this->cookieSettings->isSecure(),
			$this->cookieSettings->isHttpOnly()
		);
	}
}


1		<?php
2		/**
3		* DeviceView.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:MobileDetect!
9		* @subpackage Helpers
10		* @since 1.0.0
11		*
12		* @date 23.04.14
13		*/
14
15		declare(strict_types = 1);
16
17		namespace IPub\MobileDetect\Helpers;
18
19		use Nette;
20		use Nette\Application;
21		use Nette\Http;
22		use Nette\Utils;
23
24		/**
25		* Device view detector helper
26		*
27		* @package iPublikuj:MobileDetect!
28		* @subpackage Helpers
29		*
30		* @author Adam Kadlec <[email protected]>
31		*/
32	1	final class DeviceView
33		{
34		/**
35		* Implement nette smart magic
36		*/
37	1	use Nette\SmartObject;
38
39		const VIEW_MOBILE = 'mobile';
40		const VIEW_PHONE = 'phone';
41		const VIEW_TABLET = 'tablet';
42		const VIEW_FULL = 'full';
43		const VIEW_NOT_MOBILE = 'not_mobile';
44
45		/**
46		* @var Http\IRequest
47		*/
48		private $httpRequest;
49
50		/**
51		* @var Http\IResponse
52		*/
53		private $httpResponse;
54
55		/**
56		* @var string
57		*/
58		private $viewType = self::VIEW_FULL;
59
60		/**
61		* @var CookieSettings
62		*/
63		private $cookieSettings;
64
65		/**
66		* @var string
67		*/
68		private $switchParameterName = 'device_view';
69
70		/**
71		* @param string $setSwitchParameterName
72		* @param CookieSettings $cookieSettings
73		* @param Http\IRequest $httpRequest
74		* @param Http\IResponse $httpResponse
75		*/
76		public function __construct(string $setSwitchParameterName, CookieSettings $cookieSettings, Http\IRequest $httpRequest, Http\IResponse $httpResponse)
77		{
78	1	$this->cookieSettings = $cookieSettings;
79	1	$this->httpRequest = $httpRequest;
80	1	$this->httpResponse = $httpResponse;
81
82	1	$this->switchParameterName = $setSwitchParameterName;
83
84	1	if ($this->httpRequest->getQuery($this->switchParameterName, FALSE)) {
85	1	$this->viewType = $this->httpRequest->getQuery($this->switchParameterName);
86
87	1	} elseif ($this->httpRequest->getCookie($this->cookieSettings->getName())) {
88		$this->viewType = $this->httpRequest->getCookie($this->cookieSettings->getName());
89		}
90	1	}
91
92		/**
93		* Gets the view type for a device
94		*
95		* @return string
96		*/
97		public function getViewType() : string
98		{
99	1	return $this->viewType;
100		}
101
102		/**
103		* Is the device in full view
104		*
105		* @return bool
106		*/
107		public function isFullView() : bool
108		{
109	1	return $this->viewType === self::VIEW_FULL;
110		}
111
112		/**
113		* Is the device a tablet view type
114		*
115		* @return bool
116		*/
117		public function isTabletView() : bool
118		{
119		return $this->viewType === self::VIEW_TABLET;
120		}
121
122		/**
123		* Is the device a phone view type
124		*
125		* @return bool
126		*/
127		public function isPhoneView() : bool
128		{
129		return $this->viewType === self::VIEW_PHONE;
130		}
131
132		/**
133		* Is the device a mobile view type
134		*
135		* @return bool
136		*/
137		public function isMobileView() : bool
138		{
139	1	return $this->viewType === self::VIEW_MOBILE \|\| $this->isPhoneView() \|\| $this->isTabletView();
140		}
141
142		/**
143		* Is not the device a mobile view type (PC, Mac, etc.)
144		*
145		* @return bool
146		*/
147		public function isNotMobileView() : bool
148		{
149		return $this->viewType === self::VIEW_NOT_MOBILE;
150		}
151
152		/**
153		* Sets the tablet view type
154		*
155		* @return void
156		*/
157		public function setTabletView() : void
158		{
159	1	$this->viewType = self::VIEW_TABLET;
160	1	}
161
162		/**
163		* Sets the phone view type
164		*
165		* @return void
166		*/
167		public function setPhoneView() : void
168		{
169		$this->viewType = self::VIEW_PHONE;
170		}
171
172		/**
173		* Sets the mobile view type
174		*
175		* @return void
176		*/
177		public function setMobileView() : void
178		{
179		$this->viewType = self::VIEW_MOBILE;
180		}
181
182		/**
183		* Sets the not mobile view type
184		*
185		* @return void
186		*/
187		public function setNotMobileView() : void
188		{
189		$this->viewType = self::VIEW_NOT_MOBILE;
190		}
191
192		/**
193		* @return string
194		*/
195		public function getSwitchParameterName() : string
196		{
197		$this->switchParameterName;
198		}
199
200		/**
201		* Gets the switch param value from the query string (GET header)
202		*
203		* @return string
204		*/
205		public function getSwitchParameterValue() : string
206		{
207	1	return $this->httpRequest->getQuery($this->switchParameterName, self::VIEW_FULL);
208		}
209
210		/**
211		* Has the Request the switch param in the query string (GET header)
212		*
213		* @return bool
214		*/
215		public function hasSwitchParameter() : bool
216		{
217	1	return $this->httpRequest->getQuery($this->switchParameterName, FALSE) ? TRUE : FALSE;
218		}
219
220		/**
221		* Gets the RedirectResponse by switch param value
222		*
223		* @param string $redirectUrl
224		*
225		* @return Application\Responses\RedirectResponse
226		*/
227		public function getRedirectResponseBySwitchParam(string $redirectUrl) : Application\Responses\RedirectResponse
228		{
229		$statusCode = 302;
230
231		switch ($this->getSwitchParameterValue()) {
232		case self::VIEW_MOBILE:
233		$this->createCookie(self::VIEW_MOBILE);
234		break;
235
236		case self::VIEW_PHONE:
237		$this->createCookie(self::VIEW_PHONE);
238		break;
239
240		case self::VIEW_TABLET:
241		$this->createCookie(self::VIEW_TABLET);
242		break;
243
244		default:
245		$this->createCookie(self::VIEW_FULL);
246		break;
247		}
248
249		return new Application\Responses\RedirectResponse($redirectUrl, $statusCode);
250		}
251
252		/**
253		* Modifies the Response for non-mobile devices
254		*
255		* @return Http\IResponse
256		*/
257		public function modifyNotMobileResponse() : Http\IResponse
258		{
259		// Create cookie
260		$this->createCookie(self::VIEW_NOT_MOBILE);
261
262		return $this->httpResponse;
263		}
264
265		/**
266		* Modifies the Response for tablet devices
267		*
268		* @return Http\IResponse
269		*/
270		public function modifyTabletResponse() : Http\IResponse
271		{
272		// Create cookie
273		$this->createCookie(self::VIEW_TABLET);
274
275		return $this->httpResponse;
276		}
277
278		/**
279		* Modifies the Response for phone devices
280		*
281		* @return Http\IResponse
282		*/
283		public function modifyPhoneResponse() : Http\IResponse
284		{
285		// Create cookie
286		$this->createCookie(self::VIEW_PHONE);
287
288		return $this->httpResponse;
289		}
290
291		/**
292		* Modifies the Response for mobile devices
293		*
294		* @return Http\IResponse
295		*/
296		public function modifyMobileResponse() : Http\IResponse
297		{
298		// Create cookie
299		$this->createCookie(self::VIEW_MOBILE);
300
301		return $this->httpResponse;
302		}
303
304		/**
305		* Gets the RedirectResponse for phone devices
306		*
307		* @param string $host Uri host
308		* @param int $statusCode Status code
309		*
310		* @return Application\Responses\RedirectResponse
311		*/
312		public function getPhoneRedirectResponse(string $host, int $statusCode) : Application\Responses\RedirectResponse
313		{
314		// Create cookie
315		$this->createCookie(self::VIEW_PHONE);
316
317		return new Application\Responses\RedirectResponse($host, $statusCode);
318		}
319
320		/**
321		* Gets the RedirectResponse for tablet devices
322		*
323		* @param string $host Uri host
324		* @param int $statusCode Status code
325		*
326		* @return Application\Responses\RedirectResponse
327		*/
328		public function getTabletRedirectResponse(string $host, int $statusCode) : Application\Responses\RedirectResponse
329		{
330		// Create cookie
331		$this->createCookie(self::VIEW_TABLET);
332
333		return new Application\Responses\RedirectResponse($host, $statusCode);
334		}
335
336		/**
337		* Gets the RedirectResponse for mobile devices
338		*
339		* @param string $host Uri host
340		* @param int $statusCode Status code
341		*
342		* @return Application\Responses\RedirectResponse
343		*/
344		public function getMobileRedirectResponse(string $host, int $statusCode) : Application\Responses\RedirectResponse
345		{
346		// Create cookie
347		$this->createCookie(self::VIEW_MOBILE);
348
349		return new Application\Responses\RedirectResponse($host, $statusCode);
350		}
351
352		/**
353		* Gets the cookie
354		*
355		* @param string $cookieValue
356		*
357		* @return void
358		*/
359		private function createCookie(string $cookieValue) : void
360		{
361		// Store cookie in response
362		$this->httpResponse->setCookie(
363		$this->cookieSettings->getName(),
364		$cookieValue,
365		$this->cookieSettings->getExpiresTime(),
366		$this->cookieSettings->getPath(),
367		$this->cookieSettings->getDomain(),
368		$this->cookieSettings->isSecure(),
369		$this->cookieSettings->isHttpOnly()
370		);
371		}
372		}
373

iPublikuj / mobile-detect

Push — master ( 9edc41...f34eb1 )

DeviceView::getViewType() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like