DeviceView::detectViewType() - Code Metrics - Inspection of "- Updating device view logic" - iPublikuj/mobile-detect - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( de8bcd...65488a )

by Adam

created 2017-01-15 12:46 UTC

DeviceView::detectViewType() A

↳ Parent: DeviceView

Complexity

Conditions	3
Paths	3

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	3
eloc	5
nc	3
nop	0

<?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;

final class DeviceView extends Nette\Object
{
	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()
	{
		$this->viewType = self::VIEW_TABLET;
	}

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

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

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

iPublikuj / mobile-detect

Push — master ( de8bcd...65488a )

DeviceView::detectViewType() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like