OptionService::add() - Code Metrics - Inspection of "REST POC - initializing with comments" - nextcloud/polls - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#966)

by René

created 2020-06-14 20:42 UTC

OptionService::add() A

↳ Parent: OptionService

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

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

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

use \Exception;

use OCP\IGroupManager;
use OCP\ILogger;

use OCA\Polls\Exceptions\NotAuthorizedException;

use OCP\Security\ISecureRandom;

use OCA\Polls\Db\Poll;
use OCA\Polls\Db\PollMapper;
use OCA\Polls\Db\Option;
use OCA\Polls\Db\OptionMapper;
use OCA\Polls\Service\LogService;
use OCA\Polls\Model\Acl;

class OptionService  {

	private $userId;
	private $optionMapper;
	private $options;

	private $option;
	private $groupManager;
	private $pollMapper;
	private $logger;
	private $logService;
	private $acl;

	/**
	 * OptionController constructor.
	 * @param string $appName
	 * @param $userId
	 * @param ILogger $logger
	 * @param OptionMapper $optionMapper
	 * @param IGroupManager $groupManager
	 * @param PollMapper $pollMapper
	 * @param LogService $logService
	 * @param Acl $acl
	 */

	public function __construct(
		string $appName,
		/** @scrutinizer ignore-unused */ string $appName,
		$userId,
		OptionMapper $optionMapper,
		Option $option,
		IGroupManager $groupManager,
		PollMapper $pollMapper,
		ILogger $logger,
		LogService $logService,
		Acl $acl
	) {
		$this->userId = $userId;
		$this->optionMapper = $optionMapper;
		$this->option = $option;
		$this->groupManager = $groupManager;
		$this->pollMapper = $pollMapper;
		$this->logger = $logger;
		$this->logService = $logService;
		$this->acl = $acl;
	}

	/**
	 * Set properties from option array
	 * @NoAdminRequired
	 * @param Array $option
	 */
	private function set($option) {

		$this->option->setPollId($option['pollId']);
		$this->option->setPollOptionText(trim(htmlspecialchars($option['pollOptionText'])));
		$this->option->setTimestamp($option['timestamp']);

		if ($option['timestamp']) {
			$this->option->setOrder($option['timestamp']);
		} else {
			$this->option->setOrder($option['order']);
		}

		if ($option['confirmed']) {
			// do not update confirmation date, if option is already confirmed
			if (!$this->option->getConfirmed()) {
				$this->option->setConfirmed(time());
			}
		} else {
			$this->option->setConfirmed(0);
		}
	}

	/**
	 * Get all options of given poll
	 * @NoAdminRequired
	 * @param integer $pollId
	 * @param string $token
	 * @return array Array of Option objects
	 */
	public function list($pollId = 0, $token = '') {
		$this->logger->debug('call optionService->list(' . $pollId . ', '. $token . ')');

		if (!$this->acl->checkAuthorize($pollId, $token)) {
			throw new NotAuthorizedException;
		}

		return $this->optionMapper->findByPoll($pollId);
	}


	/**
	 * Add a new Option to poll
	 * @NoAdminRequired
	 * @param Array $option
	 * @return Option
	 */
	public function add($option) {
		$this->logger->debug('call optionService->add(' . json_encode($option) . ')');

		if (!$this->acl->setPollId($option['pollId'])->getAllowEdit()) {
			throw new NotAuthorizedException;
		}
		$this->option = new Option();
		$this->set($option);
		$this->optionMapper->insert($this->option);
		$this->logService->setLog($option['pollId'], 'addOption');
		return $this->option;
	}

	/**
	 * Remove a single option
	 * @NoAdminRequired
	 * @param Option $option
	 * @return array Array of Option objects
	 */
	public function delete($optionId) {
		$this->logger->debug('call optionService->delete(' . json_encode($optionId) . ')');

		$this->option = $this->optionMapper->find($optionId);
		if (!$this->acl->setPollId($this->option->getPollId())->getAllowEdit()) {
			throw new NotAuthorizedException;
		}

		$this->optionMapper->delete($this->option);

		return $this->option;
	}

	/**
	 * Update poll option
	 * @NoAdminRequired
	 * @param array $option
	 * @return Option
	 */
	public function update($option) {
		$this->logger->debug('call optionService->update(' . json_encode($option) . ')');

		if (!$this->acl->setPollId($option['pollId'])->getAllowEdit()) {
			throw new NotAuthorizedException;
		}

		try {
			$this->option = $this->optionMapper->find($option['id']);
			$this->set($option);
			$this->optionMapper->update($this->option);
			$this->logService->setLog($option['pollId'], 'updateOption');
			return $this->option;
		} catch (Exception $e) {
			return new DoesNotExistException($e);
filter:
    dependency_paths: ["lib/*"]
		}
	}

	/**
	 * Set order by order of the given array
	 * @NoAdminRequired
	 * @param array $options
	 * @return array Array of Option objects
	 */
	public function reorder($pollId, $options) {
		$this->logger->debug('call optionService->reorder(' . $pollId . ', ' . json_encode($options) . ')');

		if (!$this->acl->setPollId($pollId)->getAllowEdit()) {
			throw new NotAuthorizedException;
		}

		$i = 0;
		foreach ($options as $option) {
			$this->option = $this->optionMapper->find($option['id']);
			if ($pollId === intval($this->option->getPollId())) {
				$this->option->setOrder(++$i);
				$this->optionMapper->update($this->option);
			}
		}

		return $this->get($pollId);
		return $this->/** @scrutinizer ignore-call */ get($pollId);

	}
}


nextcloud / polls

Pull Request — master (#966)

OptionService::add() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like