PollController::__construct() - Code Metrics - Inspection of "Collect email addresses" - nextcloud/polls - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1030)

by René

created 2020-07-26 17:37 UTC

PollController::__construct() A

↳ Parent: PollController

Complexity

Conditions	1
Paths	1

Size

Total Lines	17
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

How to fix Many Parameters

<?php
/**
 * @copyright Copyright (c) 2017 Vinzenz Rosenkranz <[email protected]>
 *
 * @author René Gieling <[email protected]>
 *
 * @license GNU AGPL version 3 or any later version
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  This program 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 program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCA\Polls\Controller;

use Exception;
use OCP\AppFramework\Db\DoesNotExistException;
use OCA\Polls\Exceptions\EmptyTitleException;
use OCA\Polls\Exceptions\InvalidAccessException;
use OCA\Polls\Exceptions\InvalidShowResultsException;
use OCA\Polls\Exceptions\InvalidPollTypeException;
use OCA\Polls\Exceptions\NotAuthorizedException;

use OCP\IRequest;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse;

use OCA\Polls\Service\PollService;
use OCA\Polls\Service\CommentService;
use OCA\Polls\Service\OptionService;
use OCA\Polls\Service\ShareService;
use OCA\Polls\Service\VoteService;
use OCA\Polls\Model\Acl;

class PollController extends Controller {

	/** @var PollService */
	private $pollService;

	/** @var CommentService */
	private $commentService;

	/** @var OptionService */
	private $optionService;

	/** @var ShareService */
	private $shareService;

	/** @var VoteService */
	private $voteService;

	/** @var Acl */
	private $acl;

 	/**
 	 * PollController constructor.
 	 * @param string $appName
 	 * @param IRequest $request
 	 * @param PollService $pollService
 	 * @param CommentService $commentService
 	 * @param OptionService $optionService
 	 * @param ShareService $shareService
 	 * @param VoteService $voteService
 	 * @param Acl $acl
 	 */

 	public function __construct(
		string $appName,
 		IRequest $request,
 		PollService $pollService,
		CommentService $commentService,
 		OptionService $optionService,
 		ShareService $shareService,
 		VoteService $voteService,
  		Acl $acl
	) {
 		parent::__construct($appName, $request);
		$this->pollService = $pollService;
		$this->commentService = $commentService;
  		$this->optionService = $optionService;
  		$this->shareService = $shareService;
  		$this->voteService = $voteService;
  		$this->acl = $acl;
	}


	/**
	 * Get list of polls
	 * @NoAdminRequired
	 * @return DataResponse
	 */

	public function list() {
		try {
			return new DataResponse($this->pollService->list(), Http::STATUS_OK);
		} catch (DoesNotExistException $e) {
			return new DataResponse([], Http::STATUS_NOT_FOUND);
		} catch (NotAuthorizedException $e) {
			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
		}
	}


	/**
	 * get complete poll
	 * @NoAdminRequired
	 * @PublicPage
	 * @param int $pollId
	 * @param string $token
	 * @return DataResponse
	 */
 	public function get($pollId, $token) {
		try {
			if ($token) {
				$poll = $this->pollService->getByToken($token);
				$acl = $this->acl->setToken($token);
			} else {
				$poll = $this->pollService->get($pollId);
				$acl = $this->acl->setPollId($pollId);
			}

		} catch (DoesNotExistException $e) {
			return new DataResponse(['error' => 'Not found'], Http::STATUS_NOT_FOUND);
		} catch (NotAuthorizedException $e) {
			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
		}

		try {
			$comments = $this->commentService->list($poll->getId(), $token);
		} catch (Exception $e) {
			$comments = [];
		}

		try {
			$options = $this->optionService->list($poll->getId(), $token);
		} catch (Exception $e) {
			$options = [];
		}

		try {
			$votes = $this->voteService->list($poll->getId(), $token);
		} catch (Exception $e) {
			$votes = [];
		}

		try {
			$shares = $this->shareService->list($poll->getId());
		} catch (Exception $e) {
			$shares = [];
		}

		return new DataResponse([
			'acl' => $acl,
			'poll' => $poll,
			'comments' => $comments,
			'options' => $options,
			'shares' => $shares,
			'votes' => $votes
		], Http::STATUS_OK);
 	}

	/**
	 * Add poll
	 * @NoAdminRequired
	 * @param string $type
	 * @param string $title
	 * @return DataResponse
	 */

	public function add($type, $title) {
		try {
			return new DataResponse($this->pollService->add($type, $title), Http::STATUS_OK);
		} catch (NotAuthorizedException $e) {
			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
		} catch (InvalidPollTypeException $e) {
			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
		} catch (EmptyTitleException $e) {
			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
		}
	}

	/**
	 * Update poll configuration
	 * @NoAdminRequired
	 * @param int $pollId
	 * @param array $poll
	 * @return DataResponse
	 */

	public function update($pollId, $poll) {
		try {
			return new DataResponse($this->pollService->update($pollId, $poll), Http::STATUS_OK);
		} catch (DoesNotExistException $e) {
			return new DataResponse(['error' => 'Poll not found'], Http::STATUS_NOT_FOUND);
		} catch (NotAuthorizedException $e) {
			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
		} catch (InvalidAccessException $e) {
			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
		} catch (InvalidShowResultsException $e) {
			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
		} catch (EmptyTitleException $e) {
			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
		}
	}

	/**
	 * Switch deleted status (move to deleted polls)
	 * @NoAdminRequired
	 * @param int $pollId
	 * @return DataResponse
	 */

	public function delete($pollId) {
		try {
			return new DataResponse($this->pollService->delete($pollId), Http::STATUS_OK);
		} catch (DoesNotExistException $e) {
			return new DataResponse(['error' => 'Poll not found'], Http::STATUS_NOT_FOUND);
		} catch (NotAuthorizedException $e) {
			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
		}
	}

	/**
	 * Delete poll
	 * @NoAdminRequired
	 * @param Array $poll
	 * @return DataResponse
	 */

	public function deletePermanently($pollId) {
		try {
			return new DataResponse($this->pollService->deletePermanently($pollId), Http::STATUS_OK);
		} catch (DoesNotExistException $e) {
			return new DataResponse(['error' => 'Poll not found'], Http::STATUS_NOT_FOUND);
		} catch (NotAuthorizedException $e) {
			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
		}
	}

	/**
	 * Clone poll
	 * @NoAdminRequired
	 * @param int $pollId
	 * @return DataResponse
	 */
	public function clone($pollId) {
		try {
			$poll = $this->pollService->clone($pollId);
			$this->optionService->clone($pollId, $poll->getId());

			return new DataResponse($poll, Http::STATUS_OK);
		} catch (DoesNotExistException $e) {
			return new DataResponse(['error' => 'Poll not found'], Http::STATUS_NOT_FOUND);
		} catch (NotAuthorizedException $e) {
			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
		}
	}

	/**
	 * Collect email addresses from particitipants
	 * @NoAdminRequired
	 * @param Array $poll
	 * @return DataResponse
	 */

	public function getParticipantsEmailAddresses($pollId) {
		try {
			return new DataResponse($this->pollService->getParticipantsEmailAddresses($pollId), Http::STATUS_OK);
		} catch (DoesNotExistException $e) {
			return new DataResponse(['error' => 'Poll not found'], Http::STATUS_NOT_FOUND);
		} catch (NotAuthorizedException $e) {
			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
		}
	}

}


1			<?php
2			/**
3			* @copyright Copyright (c) 2017 Vinzenz Rosenkranz <[email protected]>
4			*
5			* @author René Gieling <[email protected]>
6			*
7			* @license GNU AGPL version 3 or any later version
8			*
9			* This program is free software: you can redistribute it and/or modify
10			* it under the terms of the GNU Affero General Public License as
11			* published by the Free Software Foundation, either version 3 of the
12			* License, or (at your option) any later version.
13			*
14			* This program is distributed in the hope that it will be useful,
15			* but WITHOUT ANY WARRANTY; without even the implied warranty of
16			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17			* GNU Affero General Public License for more details.
18			*
19			* You should have received a copy of the GNU Affero General Public License
20			* along with this program. If not, see <http://www.gnu.org/licenses/>.
21			*
22			*/
23
24			namespace OCA\Polls\Controller;
25
26			use Exception;
27			use OCP\AppFramework\Db\DoesNotExistException;
28			use OCA\Polls\Exceptions\EmptyTitleException;
29			use OCA\Polls\Exceptions\InvalidAccessException;
30			use OCA\Polls\Exceptions\InvalidShowResultsException;
31			use OCA\Polls\Exceptions\InvalidPollTypeException;
32			use OCA\Polls\Exceptions\NotAuthorizedException;
33
34			use OCP\IRequest;
35			use OCP\AppFramework\Controller;
36			use OCP\AppFramework\Http;
37			use OCP\AppFramework\Http\DataResponse;
38
39			use OCA\Polls\Service\PollService;
40			use OCA\Polls\Service\CommentService;
41			use OCA\Polls\Service\OptionService;
42			use OCA\Polls\Service\ShareService;
43			use OCA\Polls\Service\VoteService;
44			use OCA\Polls\Model\Acl;
45
46			class PollController extends Controller {
47
48			/** @var PollService */
49			private $pollService;
50
51			/** @var CommentService */
52			private $commentService;
53
54			/** @var OptionService */
55			private $optionService;
56
57			/** @var ShareService */
58			private $shareService;
59
60			/** @var VoteService */
61			private $voteService;
62
63			/** @var Acl */
64			private $acl;
65
66			/**
67			* PollController constructor.
68			* @param string $appName
69			* @param IRequest $request
70			* @param PollService $pollService
71			* @param CommentService $commentService
72			* @param OptionService $optionService
73			* @param ShareService $shareService
74			* @param VoteService $voteService
75			* @param Acl $acl
76			*/
77
78			public function __construct(
79			string $appName,
80			IRequest $request,
81			PollService $pollService,
82			CommentService $commentService,
83			OptionService $optionService,
84			ShareService $shareService,
85			VoteService $voteService,
86			Acl $acl
87			) {
88			parent::__construct($appName, $request);
89			$this->pollService = $pollService;
90			$this->commentService = $commentService;
91			$this->optionService = $optionService;
92			$this->shareService = $shareService;
93			$this->voteService = $voteService;
94			$this->acl = $acl;
95			}
96
97
98			/**
99			* Get list of polls
100			* @NoAdminRequired
101			* @return DataResponse
102			*/
103
104			public function list() {
105			try {
106			return new DataResponse($this->pollService->list(), Http::STATUS_OK);
107			} catch (DoesNotExistException $e) {
108			return new DataResponse([], Http::STATUS_NOT_FOUND);
109			} catch (NotAuthorizedException $e) {
110			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
111			}
112			}
113
114
115			/**
116			* get complete poll
117			* @NoAdminRequired
118			* @PublicPage
119			* @param int $pollId
120			* @param string $token
121			* @return DataResponse
122			*/
123			public function get($pollId, $token) {
124			try {
125			if ($token) {
126			$poll = $this->pollService->getByToken($token);
127			$acl = $this->acl->setToken($token);
128			} else {
129			$poll = $this->pollService->get($pollId);
130			$acl = $this->acl->setPollId($pollId);
131			}
132
133			} catch (DoesNotExistException $e) {
134			return new DataResponse(['error' => 'Not found'], Http::STATUS_NOT_FOUND);
135			} catch (NotAuthorizedException $e) {
136			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
137			}
138
139			try {
140			$comments = $this->commentService->list($poll->getId(), $token);
141			} catch (Exception $e) {
142			$comments = [];
143			}
144
145			try {
146			$options = $this->optionService->list($poll->getId(), $token);
147			} catch (Exception $e) {
148			$options = [];
149			}
150
151			try {
152			$votes = $this->voteService->list($poll->getId(), $token);
153			} catch (Exception $e) {
154			$votes = [];
155			}
156
157			try {
158			$shares = $this->shareService->list($poll->getId());
159			} catch (Exception $e) {
160			$shares = [];
161			}
162
163			return new DataResponse([
164			'acl' => $acl,
165			'poll' => $poll,
166			'comments' => $comments,
167			'options' => $options,
168			'shares' => $shares,
169			'votes' => $votes
170			], Http::STATUS_OK);
171			}
172
173			/**
174			* Add poll
175			* @NoAdminRequired
176			* @param string $type
177			* @param string $title
178			* @return DataResponse
179			*/
180
181			public function add($type, $title) {
182			try {
183			return new DataResponse($this->pollService->add($type, $title), Http::STATUS_OK);
184			} catch (NotAuthorizedException $e) {
185			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
186			} catch (InvalidPollTypeException $e) {
187			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
188			} catch (EmptyTitleException $e) {
189			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
190			}
191			}
192
193			/**
194			* Update poll configuration
195			* @NoAdminRequired
196			* @param int $pollId
197			* @param array $poll
198			* @return DataResponse
199			*/
200
201			public function update($pollId, $poll) {
202			try {
203			return new DataResponse($this->pollService->update($pollId, $poll), Http::STATUS_OK);
204			} catch (DoesNotExistException $e) {
205			return new DataResponse(['error' => 'Poll not found'], Http::STATUS_NOT_FOUND);
206			} catch (NotAuthorizedException $e) {
207			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
208			} catch (InvalidAccessException $e) {
209			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
210			} catch (InvalidShowResultsException $e) {
211			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
212			} catch (EmptyTitleException $e) {
213			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
214			}
215			}
216
217			/**
218			* Switch deleted status (move to deleted polls)
219			* @NoAdminRequired
220			* @param int $pollId
221			* @return DataResponse
222			*/
223
224			public function delete($pollId) {
225			try {
226			return new DataResponse($this->pollService->delete($pollId), Http::STATUS_OK);
227			} catch (DoesNotExistException $e) {
228			return new DataResponse(['error' => 'Poll not found'], Http::STATUS_NOT_FOUND);
229			} catch (NotAuthorizedException $e) {
230			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
231			}
232			}
233
234			/**
235			* Delete poll
236			* @NoAdminRequired
237			* @param Array $poll
238			* @return DataResponse
239			*/
240
241			public function deletePermanently($pollId) {
242			try {
243			return new DataResponse($this->pollService->deletePermanently($pollId), Http::STATUS_OK);
244			} catch (DoesNotExistException $e) {
245			return new DataResponse(['error' => 'Poll not found'], Http::STATUS_NOT_FOUND);
246			} catch (NotAuthorizedException $e) {
247			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
248			}
249			}
250
251			/**
252			* Clone poll
253			* @NoAdminRequired
254			* @param int $pollId
255			* @return DataResponse
256			*/
257			public function clone($pollId) {
258			try {
259			$poll = $this->pollService->clone($pollId);
260			$this->optionService->clone($pollId, $poll->getId());
261
262			return new DataResponse($poll, Http::STATUS_OK);
263			} catch (DoesNotExistException $e) {
264			return new DataResponse(['error' => 'Poll not found'], Http::STATUS_NOT_FOUND);
265			} catch (NotAuthorizedException $e) {
266			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
267			}
268			}
269
270			/**
271			* Collect email addresses from particitipants
272			* @NoAdminRequired
273			* @param Array $poll
274			* @return DataResponse
275			*/
276
277			public function getParticipantsEmailAddresses($pollId) {
278			try {
279			return new DataResponse($this->pollService->getParticipantsEmailAddresses($pollId), Http::STATUS_OK);
280			} catch (DoesNotExistException $e) {
281			return new DataResponse(['error' => 'Poll not found'], Http::STATUS_NOT_FOUND);
282			} catch (NotAuthorizedException $e) {
283			return new DataResponse(['error' => $e->getMessage()], $e->getStatus());
284			}
285			}
286
287			}
288

nextcloud / polls

Pull Request — master (#1030)

PollController::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like