SettingsController - Code Metrics - owncloud/calendar - Measure and Improve Code Quality continuously with Scrutinizer

SettingsController A
last analyzed 2018-10-23 12:16 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	309
Duplicated Lines	42.72 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

77.78%

Importance

Changes

Metric	Value
wmc	33
lcom	1
cbo	0
dl	132
loc	309
ccs	91
cts	117
cp	0.7778
rs	9.76
c	0
b	0
f	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getConfig()	0	14	5
A	setConfig()	0	14	5
A	setView()	18	18	3
A	getView()	16	16	2
A	isViewAllowed()	0	9	1
A	setSkipPopover()	18	18	3
A	getSkipPopover()	16	16	2
A	isSkipPopoverValueAllowed()	0	8	1
A	setShowWeekNr()	18	18	3
A	getShowWeekNr()	16	16	2
A	isShowWeekNrValueAllowed()	0	8	1
A	setFirstRun()	14	14	2
A	getFirstRun()	16	16	2

How to fix Duplicated Code

<?php
/**
 * Calendar App
 *
 * @author Georg Ehrke
 * @copyright 2016 Georg Ehrke <[email protected]>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this library.  If not, see <http://www.gnu.org/g/>.
 *
 */
namespace OCA\Calendar\Controller;

use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\JSONResponse;
use OCP\AppFramework\Http;
use OCP\IConfig;
use OCP\IRequest;
use OCP\IUserSession;

class SettingsController extends Controller {

	/**
	 * @var IConfig
	 */
	private $config;

	/**
	 * @var IUserSession
	 */
	private $userSession;

	/**
	 * @var string
	 */
	private $userId;

	/**
	 * @param string $appName
	 * @param IRequest $request an instance of the request
	 * @param IUserSession $userSession
	 * @param IConfig $config
	 */
	public function __construct($appName, IRequest $request, IUserSession $userSession,
								IConfig $config) {
		parent::__construct($appName, $request);
		$this->config = $config;
		$this->userSession = $userSession;
		$this->userId = $userSession->getUser()->getUID();
	}

	/**
	 * get a configuration item
	 *
	 * @NoAdminRequired
	 *
	 * @param string $key
	 * @return JSONResponse
	 */
	public function getConfig($key) {
		switch ($key) {
			case 'view':
				return $this->getView();
			case 'skipPopover':
				return $this->getSkipPopover();
			case 'showWeekNr':
				return $this->getShowWeekNr();
			case 'firstRun':
				return $this->getFirstRun();
			default:
				return new JSONResponse([], Http::STATUS_BAD_REQUEST);
		}
	}

	/**
	 * set a configuration item
	 *
	 * @NoAdminRequired
	 *
	 * @param string $key
	 * @param mixed $value
	 * @return JSONResponse
	 */
	public function setConfig($key, $value) {
		switch ($key) {
			case 'view':
				return $this->setView($value);
			case 'skipPopover':
				return $this->setSkipPopover($value);
			case 'showWeekNr':
				return $this->setShowWeekNr($value);
			case 'firstRun':
				return $this->setFirstRun();
			default:
				return new JSONResponse([], Http::STATUS_BAD_REQUEST);
		}
	}


	/**
	 * set a new view
	 *
	 * @param string $view
	 * @return JSONResponse
	 */
	private function setView($view) {

		if (!$this->isViewAllowed($view)) {
			return new JSONResponse([], Http::STATUS_UNPROCESSABLE_ENTITY);
		}

		try {
			$this->config->setUserValue(
				$this->userId,
				$this->appName,
				'currentView',
				$view
			);
		} catch(\Exception $e) {
			return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
		}

		return new JSONResponse();
	}


	/**
	 * get a config value
	 *
	 * @return JSONResponse
	 */
	private function getView() {

		try {
			$view = $this->config->getUserValue(
				$this->userId,
				$this->appName,
				'currentView',
				'month'
			);
		} catch(\Exception $e) {
			return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
		}

		return new JSONResponse([
			'value' => $view,
		]);
	}

	/**
	 * check if view is allowed
	 *
	 * @param $view
	 * @return bool
	 */
	private function isViewAllowed($view) {
		$allowedViews = [
			'agendaDay',
			'agendaWeek',
			'month',
		];

		return in_array($view, $allowedViews);
	}

	/**
	 * set if popover shall be skipped
	 *
	 * @param $value
	 * @return JSONResponse
	 */
	private function setSkipPopover($value) {

		if (!$this->isSkipPopoverValueAllowed($value)) {
			return new JSONResponse([], Http::STATUS_UNPROCESSABLE_ENTITY);
		}

		try {
			$this->config->setUserValue(
				$this->userId,
				$this->appName,
				'skipPopover',
				$value
			);
		} catch(\Exception $e) {
			return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
		}

		return new JSONResponse();
	}

	/**
	 * get if popover shall be skipped
	 *
	 * @return JSONResponse
	 */
	private function getSkipPopover() {

		try {
			$view = $this->config->getUserValue(
				$this->userId,
				$this->appName,
				'skipPopover',
				'no'
			);
		} catch(\Exception $e) {
			return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
		}

		return new JSONResponse([
			'value' => $view,
		]);
	}

	/**
	 * check if value for skipPopover is allowed
	 *
	 * @param $value
	 * @return bool
	 */
	private function isSkipPopoverValueAllowed($value) {
		$allowedValues = [
			'yes',
			'no'
		];

		return in_array($value, $allowedValues);
	}

	/**
	 * set config value for showing week numbers
	 *
	 * @param $value
	 * @return JSONResponse
	 */
	private function setShowWeekNr($value) {

		if (!$this->isShowWeekNrValueAllowed($value)) {
			return new JSONResponse([], Http::STATUS_UNPROCESSABLE_ENTITY);
		}

		try {
			$this->config->setUserValue(
				$this->userId,
				$this->appName,
				'showWeekNr',
				$value
			);
		} catch(\Exception $e) {
			return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
		}

		return new JSONResponse();
	}

	/**
	 * get config value for showing week numbers
	 *
	 * @return JSONResponse
	 */
	private function getShowWeekNr() {

		try {
			$value = $this->config->getUserValue(
				$this->userId,
				$this->appName,
				'showWeekNr',
				'no'
			);
		} catch(\Exception $e) {
			return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
		}

		return new JSONResponse([
			'value' => $value,
		]);
	}

	/**
	 * check if value for showWeekNr is allowed
	 *
	 * @param $value
	 * @return bool
	 */
	private function isShowWeekNrValueAllowed($value) {
		$allowedValues = [
			'yes',
			'no'
		];

		return in_array($value, $allowedValues);
	}

	/**
	 * remember that first run routines executed
	 *
	 * @return JSONResponse
	 */
	private function setFirstRun() {

		try {
			$this->config->setUserValue(
				$this->userId,
				$this->appName,
				'firstRun',
				'no'
			);
		} catch(\Exception $e) {
			return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
		}

		return new JSONResponse();
	}

	/**
	 * get stored value for first run
	 *
	 * @return JSONResponse
	 */
	private function getFirstRun() {

		try {
			$value = $this->config->getUserValue(
				$this->userId,
				$this->appName,
				'firstRun',
				'yes'
			);
		} catch(\Exception $e) {
			return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
		}

		return new JSONResponse([
			'value' => $value,
		]);
	}
}


1			<?php
2			/**
3			* Calendar App
4			*
5			* @author Georg Ehrke
6			* @copyright 2016 Georg Ehrke <[email protected]>
7			*
8			* This library is free software; you can redistribute it and/or
9			* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
10			* License as published by the Free Software Foundation; either
11			* version 3 of the License, or any later version.
12			*
13			* This library is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
17			*
18			* You should have received a copy of the GNU Affero General Public
19			* License along with this library. If not, see <http://www.gnu.org/g/>.
20			*
21			*/
22			namespace OCA\Calendar\Controller;
23
24			use OCP\AppFramework\Controller;
25			use OCP\AppFramework\Http\JSONResponse;
26			use OCP\AppFramework\Http;
27			use OCP\IConfig;
28			use OCP\IRequest;
29			use OCP\IUserSession;
30
31			class SettingsController extends Controller {
32
33			/**
34			* @var IConfig
35			*/
36			private $config;
37
38			/**
39			* @var IUserSession
40			*/
41			private $userSession;
42
43			/**
44			* @var string
45			*/
46			private $userId;
47
48			/**
49			* @param string $appName
50			* @param IRequest $request an instance of the request
51			* @param IUserSession $userSession
52			* @param IConfig $config
53			*/
54	19		public function __construct($appName, IRequest $request, IUserSession $userSession,
55			IConfig $config) {
56	19		parent::__construct($appName, $request);
57	19		$this->config = $config;
58	19		$this->userSession = $userSession;
59	19		$this->userId = $userSession->getUser()->getUID();
60	19		}
61
62			/**
63			* get a configuration item
64			*
65			* @NoAdminRequired
66			*
67			* @param string $key
68			* @return JSONResponse
69			*/
70	7		public function getConfig($key) {
71			switch ($key) {
72	7		case 'view':
73	2		return $this->getView();
74	5		case 'skipPopover':
75	2		return $this->getSkipPopover();
76	3		case 'showWeekNr':
77			return $this->getShowWeekNr();
78	3		case 'firstRun':
79	2		return $this->getFirstRun();
80			default:
81	1		return new JSONResponse([], Http::STATUS_BAD_REQUEST);
82			}
83			}
84
85			/**
86			* set a configuration item
87			*
88			* @NoAdminRequired
89			*
90			* @param string $key
91			* @param mixed $value
92			* @return JSONResponse
93			*/
94	12		public function setConfig($key, $value) {
95			switch ($key) {
96	12		case 'view':
97	5		return $this->setView($value);
98	7		case 'skipPopover':
99	4		return $this->setSkipPopover($value);
100	3		case 'showWeekNr':
101			return $this->setShowWeekNr($value);
102	3		case 'firstRun':
103	2		return $this->setFirstRun();
104			default:
105	1		return new JSONResponse([], Http::STATUS_BAD_REQUEST);
106			}
107			}
108
109
110			/**
111			* set a new view
112			*
113			* @param string $view
114			* @return JSONResponse
115			*/
116	5	View Code Duplication	private function setView($view) {
			0 ignored issues – show Duplication introduced 2017-08-12 00:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
117	5		if (!$this->isViewAllowed($view)) {
118	1		return new JSONResponse([], Http::STATUS_UNPROCESSABLE_ENTITY);
119			}
120
121			try {
122	4		$this->config->setUserValue(
123	4		$this->userId,
124	4		$this->appName,
125	4		'currentView',
126	4		$view
127			);
128	1		} catch(\Exception $e) {
129	1		return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
130			}
131
132	3		return new JSONResponse();
133			}
134
135
136			/**
137			* get a config value
138			*
139			* @return JSONResponse
140			*/
141	2	View Code Duplication	private function getView() {
			0 ignored issues – show Duplication introduced 2017-08-12 00:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
142			try {
143	2		$view = $this->config->getUserValue(
144	2		$this->userId,
145	2		$this->appName,
146	2		'currentView',
147	2		'month'
148			);
149	1		} catch(\Exception $e) {
150	1		return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
151			}
152
153	1		return new JSONResponse([
154	1		'value' => $view,
155			]);
156			}
157
158			/**
159			* check if view is allowed
160			*
161			* @param $view
162			* @return bool
163			*/
164	5		private function isViewAllowed($view) {
165			$allowedViews = [
166	5		'agendaDay',
167			'agendaWeek',
168			'month',
169			];
170
171	5		return in_array($view, $allowedViews);
172			}
173
174			/**
175			* set if popover shall be skipped
176			*
177			* @param $value
178			* @return JSONResponse
179			*/
180	4	View Code Duplication	private function setSkipPopover($value) {
			0 ignored issues – show Duplication introduced 2017-08-12 00:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
181	4		if (!$this->isSkipPopoverValueAllowed($value)) {
182	1		return new JSONResponse([], Http::STATUS_UNPROCESSABLE_ENTITY);
183			}
184
185			try {
186	3		$this->config->setUserValue(
187	3		$this->userId,
188	3		$this->appName,
189	3		'skipPopover',
190	3		$value
191			);
192	1		} catch(\Exception $e) {
193	1		return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
194			}
195
196	2		return new JSONResponse();
197			}
198
199			/**
200			* get if popover shall be skipped
201			*
202			* @return JSONResponse
203			*/
204	2	View Code Duplication	private function getSkipPopover() {
			0 ignored issues – show Duplication introduced 2017-08-12 00:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
205			try {
206	2		$view = $this->config->getUserValue(
207	2		$this->userId,
208	2		$this->appName,
209	2		'skipPopover',
210	2		'no'
211			);
212	1		} catch(\Exception $e) {
213	1		return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
214			}
215
216	1		return new JSONResponse([
217	1		'value' => $view,
218			]);
219			}
220
221			/**
222			* check if value for skipPopover is allowed
223			*
224			* @param $value
225			* @return bool
226			*/
227	4		private function isSkipPopoverValueAllowed($value) {
228			$allowedValues = [
229	4		'yes',
230			'no'
231			];
232
233	4		return in_array($value, $allowedValues);
234			}
235
236			/**
237			* set config value for showing week numbers
238			*
239			* @param $value
240			* @return JSONResponse
241			*/
242		View Code Duplication	private function setShowWeekNr($value) {
			0 ignored issues – show Duplication introduced 2017-08-22 15:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
243			if (!$this->isShowWeekNrValueAllowed($value)) {
244			return new JSONResponse([], Http::STATUS_UNPROCESSABLE_ENTITY);
245			}
246
247			try {
248			$this->config->setUserValue(
249			$this->userId,
250			$this->appName,
251			'showWeekNr',
252			$value
253			);
254			} catch(\Exception $e) {
255			return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
256			}
257
258			return new JSONResponse();
259			}
260
261			/**
262			* get config value for showing week numbers
263			*
264			* @return JSONResponse
265			*/
266		View Code Duplication	private function getShowWeekNr() {
			0 ignored issues – show Duplication introduced 2017-08-12 00:23 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
267			try {
268			$value = $this->config->getUserValue(
269			$this->userId,
270			$this->appName,
271			'showWeekNr',
272			'no'
273			);
274			} catch(\Exception $e) {
275			return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
276			}
277
278			return new JSONResponse([
279			'value' => $value,
280			]);
281			}
282
283			/**
284			* check if value for showWeekNr is allowed
285			*
286			* @param $value
287			* @return bool
288			*/
289			private function isShowWeekNrValueAllowed($value) {
290			$allowedValues = [
291			'yes',
292			'no'
293			];
294
295			return in_array($value, $allowedValues);
296			}
297
298			/**
299			* remember that first run routines executed
300			*
301			* @return JSONResponse
302			*/
303	2	View Code Duplication	private function setFirstRun() {
			0 ignored issues – show Duplication introduced 2017-08-22 15:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
304			try {
305	2		$this->config->setUserValue(
306	2		$this->userId,
307	2		$this->appName,
308	2		'firstRun',
309	2		'no'
310			);
311	1		} catch(\Exception $e) {
312	1		return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
313			}
314
315	1		return new JSONResponse();
316			}
317
318			/**
319			* get stored value for first run
320			*
321			* @return JSONResponse
322			*/
323	2	View Code Duplication	private function getFirstRun() {
			0 ignored issues – show Duplication introduced 2017-08-22 15:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
324			try {
325	2		$value = $this->config->getUserValue(
326	2		$this->userId,
327	2		$this->appName,
328	2		'firstRun',
329	2		'yes'
330			);
331	1		} catch(\Exception $e) {
332	1		return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
333			}
334
335	1		return new JSONResponse([
336	1		'value' => $value,
337			]);
338			}
339			}
340

owncloud / calendar

SettingsController A last analyzed 2018-10-23 12:16 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

14 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

SettingsController A
last analyzed 2018-10-23 12:16 UTC