MembersMapper::remove() - Code Metrics - Inspection of "lighter methods" - nextcloud/circles - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — some-scrutinizing ( 29b6ab...e5bac5 )

by Maxence

created 2017-03-09 02:17 UTC

MembersMapper::remove() A

↳ Parent: MembersMapper

Complexity

Conditions	1
Paths	1

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	17
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	10
nc	1
nop	1

<?php
/**
 * Circles - Bring cloud-users closer together.
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Maxence Lange <[email protected]>
 * @copyright 2017
 * @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\Circles\Db;

use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
use OCA\Circles\Exceptions\MemberAlreadyExistsException;
use OCA\Circles\Exceptions\MemberDoesNotExistException;
use OCA\Circles\Model\Circle;
use OCA\Circles\Model\Member;

use OCP\IDBConnection;
use OCP\AppFramework\Db\Mapper;

class MembersMapper extends Mapper {

	const TABLENAME = 'circles_members';

	private $miscService;

	public function __construct(IDBConnection $db, $miscService) {
		parent::__construct($db, self::TABLENAME, 'OCA\Circles\Db\Members');
		$this->miscService = $miscService;
	}


	/**
	 * @param $circleId
	 * @param $userId
	 * @param bool $moderator
	 *
	 * @return null|Member
	 * @throws MemberDoesNotExistException
	 */
	public function getMemberFromCircle($circleId, $userId, $moderator = false) {

		$circleId = (int)$circleId;
		$qb = $this->getMemberFromCircleSql($circleId, $userId);
		$cursor = $qb->setMaxResults(1)
					 ->execute();

		$data = $cursor->fetch();
		if ($data === false) {
			throw new MemberDoesNotExistException();
		}

		if ($moderator !== true) {
			unset($data['note']);
		}

		$member = new Member();
		$member->fromArray($data);
		$cursor->closeCursor();

		return $member;
	}


	/**
	 * Generate SQL Request for getMemberFromCircle()
	 *
	 * @param $circleId
	 * @param $userId
	 *
	 * @return \OCP\DB\QueryBuilder\IQueryBuilder
	 */
	private function getMemberFromCircleSql($circleId, $userId) {


		$qb = $this->db->getQueryBuilder();
		$expr = $qb->expr();

		/** @noinspection PhpMethodParametersCountMismatchInspection */
		$qb->select(
			'circle_id', 'user_id', 'level', 'status', 'note', 'joined'
		)
		   ->from(self::TABLENAME)
		   ->where(
			   $expr->eq('circle_id', $qb->createNamedParameter($circleId))
		   )
		   ->andWhere(
			   $expr->eq('user_id', $qb->createNamedParameter($userId))
		   );

		return $qb;
	}

	/**
	 * get members list from a circle. If moderator, returns also notes about each member.
	 *
	 * @param $circleId
	 * @param Member $user
	 *
	 * @return array
	 * @internal param Member $member
	 * @internal param bool $moderator
	 *
	 */
	public function getMembersFromCircle($circleId, Member $user) {

		$circleId = (int)$circleId;
		try {
			$user->hasToBeMember();

			$qb = $this->getMembersFromCircleSql($circleId);
			$cursor = $qb->execute();
			$result = [];
			while ($data = $cursor->fetch()) {
				if (!$user->isModerator()) {
					unset($data['note']);
				}

				$member = new Member();
				$member->fromArray($data);
				$result[] = $member;
			}
			$cursor->closeCursor();

		} catch (MemberDoesNotExistException $e) {
			throw new $e;
		}

		return $result;

	}


	/**
	 * Return SQL for getMembersFromCircle.
	 *
	 * @param $circleId
	 *
	 * @return \OCP\DB\QueryBuilder\IQueryBuilder
	 */
	private function getMembersFromCircleSql($circleId) {

		$qb = $this->db->getQueryBuilder();
		$expr = $qb->expr();

		/** @noinspection PhpMethodParametersCountMismatchInspection */
		$qb->select(
			'circle_id', 'user_id', 'level', 'status', 'note', 'joined'
		)
		   ->from(self::TABLENAME)
		   ->where(
			   $expr->eq('circle_id', $qb->createNamedParameter($circleId))
		   )
		   ->andwhere(
			   $expr->neq('status', $qb->createNamedParameter(Member::STATUS_NONMEMBER))
		   );

		return $qb;
	}

	public function editMember(Member $member) {

		$qb = $this->db->getQueryBuilder();

		/** @noinspection PhpMethodParametersCountMismatchInspection */
		$qb->update(self::TABLENAME)
		   ->set('level', $qb->createNamedParameter($member->getLevel()))
		   ->set('status', $qb->createNamedParameter($member->getStatus()))
		   ->where(
			   $qb->expr()
				  ->andX(
					  $qb->expr()
						 ->eq('circle_id', $qb->createNamedParameter($member->getCircleId())),
					  $qb->expr()
						 ->eq('user_id', $qb->createNamedParameter($member->getUserId()))
				  )
		   );

		$qb->execute();

		return true;
	}


	/**
	 * Insert Member into database.
	 *
	 * @param Member $member
	 *
	 * @throws MemberAlreadyExistsException
	 */
	public function add(Member $member) {

		try {
			$qb = $this->db->getQueryBuilder();
			$qb->insert(self::TABLENAME)
			   ->setValue('circle_id', $qb->createNamedParameter($member->getCircleId()))
			   ->setValue('user_id', $qb->createNamedParameter($member->getUserId()))
			   ->setValue('level', $qb->createNamedParameter($member->getLevel()))
			   ->setValue('status', $qb->createNamedParameter($member->getStatus()))
			   ->setValue('note', $qb->createNamedParameter($member->getNote()));
			$qb->execute();
		} catch (UniqueConstraintViolationException $e) {

			throw new MemberAlreadyExistsException();
		}
	}


	/**
	 * Remove a member from a circle.
	 *
	 * @param Member $member
	 *
	 * @return bool
	 */
	public function remove(Member $member) {

		$qb = $this->db->getQueryBuilder();

		/** @noinspection PhpMethodParametersCountMismatchInspection */
		$qb->delete(self::TABLENAME)
		   ->where(
			   $qb->expr()
				  ->eq('circle_id', $qb->createNamedParameter($member->getCircleId())),
			   $qb->expr()
				  ->eq('user_id', $qb->createNamedParameter($member->getUserId()))
		   );

		$qb->execute();

		return true;
	}

	/**
	 * remove all members/owner from a circle
	 *
	 * @param Circle $circle
	 *
	 * @return bool
	 */
	public function removeAllFromCircle(Circle $circle) {
		$qb = $this->db->getQueryBuilder();
		$qb->delete(self::TABLENAME)
		   ->where(
			   $qb->expr()
				  ->eq('circle_id', $qb->createNamedParameter($circle->getId()))
		   );

		$qb->execute();

		return true;

	}
}



1		<?php
2		/**
3		* Circles - Bring cloud-users closer together.
4		*
5		* This file is licensed under the Affero General Public License version 3 or
6		* later. See the COPYING file.
7		*
8		* @author Maxence Lange <[email protected]>
9		* @copyright 2017
10		* @license GNU AGPL version 3 or any later version
11		*
12		* This program is free software: you can redistribute it and/or modify
13		* it under the terms of the GNU Affero General Public License as
14		* published by the Free Software Foundation, either version 3 of the
15		* License, or (at your option) any later version.
16		*
17		* This program is distributed in the hope that it will be useful,
18		* but WITHOUT ANY WARRANTY; without even the implied warranty of
19		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20		* GNU Affero General Public License for more details.
21		*
22		* You should have received a copy of the GNU Affero General Public License
23		* along with this program. If not, see <http://www.gnu.org/licenses/>.
24		*
25		*/
26
27		namespace OCA\Circles\Db;
28
29		use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
30		use OCA\Circles\Exceptions\MemberAlreadyExistsException;
31		use OCA\Circles\Exceptions\MemberDoesNotExistException;
32		use OCA\Circles\Model\Circle;
33		use OCA\Circles\Model\Member;
34
35		use OCP\IDBConnection;
36		use OCP\AppFramework\Db\Mapper;
37
38		class MembersMapper extends Mapper {
39
40		const TABLENAME = 'circles_members';
41
42		private $miscService;
43
44		public function __construct(IDBConnection $db, $miscService) {
45		parent::__construct($db, self::TABLENAME, 'OCA\Circles\Db\Members');
46		$this->miscService = $miscService;
47		}
48
49
50		/**
51		* @param $circleId
52		* @param $userId
53		* @param bool $moderator
54		*
55		* @return null\|Member
56		* @throws MemberDoesNotExistException
57		*/
58		public function getMemberFromCircle($circleId, $userId, $moderator = false) {
59
60		$circleId = (int)$circleId;
61		$qb = $this->getMemberFromCircleSql($circleId, $userId);
62		$cursor = $qb->setMaxResults(1)
63		->execute();
64
65		$data = $cursor->fetch();
66		if ($data === false) {
67		throw new MemberDoesNotExistException();
68		}
69
70		if ($moderator !== true) {
71		unset($data['note']);
72		}
73
74		$member = new Member();
75		$member->fromArray($data);
76		$cursor->closeCursor();
77
78		return $member;
79		}
80
81
82		/**
83		* Generate SQL Request for getMemberFromCircle()
84		*
85		* @param $circleId
86		* @param $userId
87		*
88		* @return \OCP\DB\QueryBuilder\IQueryBuilder
89		*/
90	View Code Duplication	private function getMemberFromCircleSql($circleId, $userId) {
		0 ignored issues – show Duplication introduced 2017-03-09 02:35 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...
91
92		$qb = $this->db->getQueryBuilder();
93		$expr = $qb->expr();
94
95		/** @noinspection PhpMethodParametersCountMismatchInspection */
96		$qb->select(
97		'circle_id', 'user_id', 'level', 'status', 'note', 'joined'
98		)
99		->from(self::TABLENAME)
100		->where(
101		$expr->eq('circle_id', $qb->createNamedParameter($circleId))
102		)
103		->andWhere(
104		$expr->eq('user_id', $qb->createNamedParameter($userId))
105		);
106
107		return $qb;
108		}
109
110		/**
111		* get members list from a circle. If moderator, returns also notes about each member.
112		*
113		* @param $circleId
114		* @param Member $user
115		*
116		* @return array
117		* @internal param Member $member
118		* @internal param bool $moderator
119		*
120		*/
121		public function getMembersFromCircle($circleId, Member $user) {
122
123		$circleId = (int)$circleId;
124		try {
125		$user->hasToBeMember();
126
127		$qb = $this->getMembersFromCircleSql($circleId);
128		$cursor = $qb->execute();
129		$result = [];
130		while ($data = $cursor->fetch()) {
131		if (!$user->isModerator()) {
132		unset($data['note']);
133		}
134
135		$member = new Member();
136		$member->fromArray($data);
137		$result[] = $member;
138		}
139		$cursor->closeCursor();
140
141		} catch (MemberDoesNotExistException $e) {
142		throw new $e;
143		}
144
145		return $result;
146
147		}
148
149
150		/**
151		* Return SQL for getMembersFromCircle.
152		*
153		* @param $circleId
154		*
155		* @return \OCP\DB\QueryBuilder\IQueryBuilder
156		*/
157	View Code Duplication	private function getMembersFromCircleSql($circleId) {
		0 ignored issues – show Duplication introduced 2017-03-09 02:35 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...
158		$qb = $this->db->getQueryBuilder();
159		$expr = $qb->expr();
160
161		/** @noinspection PhpMethodParametersCountMismatchInspection */
162		$qb->select(
163		'circle_id', 'user_id', 'level', 'status', 'note', 'joined'
164		)
165		->from(self::TABLENAME)
166		->where(
167		$expr->eq('circle_id', $qb->createNamedParameter($circleId))
168		)
169		->andwhere(
170		$expr->neq('status', $qb->createNamedParameter(Member::STATUS_NONMEMBER))
171		);
172
173		return $qb;
174		}
175
176		public function editMember(Member $member) {
177
178		$qb = $this->db->getQueryBuilder();
179
180		/** @noinspection PhpMethodParametersCountMismatchInspection */
181		$qb->update(self::TABLENAME)
182		->set('level', $qb->createNamedParameter($member->getLevel()))
183		->set('status', $qb->createNamedParameter($member->getStatus()))
184		->where(
185		$qb->expr()
186		->andX(
187		$qb->expr()
188		->eq('circle_id', $qb->createNamedParameter($member->getCircleId())),
189		$qb->expr()
190		->eq('user_id', $qb->createNamedParameter($member->getUserId()))
191		)
192		);
193
194		$qb->execute();
195
196		return true;
197		}
198
199
200		/**
201		* Insert Member into database.
202		*
203		* @param Member $member
204		*
205		* @throws MemberAlreadyExistsException
206		*/
207		public function add(Member $member) {
208
209		try {
210		$qb = $this->db->getQueryBuilder();
211		$qb->insert(self::TABLENAME)
212		->setValue('circle_id', $qb->createNamedParameter($member->getCircleId()))
213		->setValue('user_id', $qb->createNamedParameter($member->getUserId()))
214		->setValue('level', $qb->createNamedParameter($member->getLevel()))
215		->setValue('status', $qb->createNamedParameter($member->getStatus()))
216		->setValue('note', $qb->createNamedParameter($member->getNote()));
217		$qb->execute();
218		} catch (UniqueConstraintViolationException $e) {
		1 ignored issue – show Bug introduced 2017-03-07 02:28 UTC by Report Bug Copy Issue Report The class `Doctrine\DBAL\Exception\...raintViolationException` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
219		throw new MemberAlreadyExistsException();
220		}
221		}
222
223
224		/**
225		* Remove a member from a circle.
226		*
227		* @param Member $member
228		*
229		* @return bool
230		*/
231		public function remove(Member $member) {
232
233		$qb = $this->db->getQueryBuilder();
234
235		/** @noinspection PhpMethodParametersCountMismatchInspection */
236		$qb->delete(self::TABLENAME)
237		->where(
238		$qb->expr()
239		->eq('circle_id', $qb->createNamedParameter($member->getCircleId())),
240		$qb->expr()
241		->eq('user_id', $qb->createNamedParameter($member->getUserId()))
242		);
243
244		$qb->execute();
245
246		return true;
247		}
248
249		/**
250		* remove all members/owner from a circle
251		*
252		* @param Circle $circle
253		*
254		* @return bool
255		*/
256	View Code Duplication	public function removeAllFromCircle(Circle $circle) {
257		$qb = $this->db->getQueryBuilder();
258		$qb->delete(self::TABLENAME)
259		->where(
260		$qb->expr()
261		->eq('circle_id', $qb->createNamedParameter($circle->getId()))
262		);
263
264		$qb->execute();
265
266		return true;
267
268		}
269		}
270
271

nextcloud / circles

Push — some-scrutinizing ( 29b6ab...e5bac5 )

MembersMapper::remove() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like