MembersMapper::editMember() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master'-e" - nextcloud/circles - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b60009...a65047 )

by Maxence

created 2017-05-11 11:02 UTC

MembersMapper::editMember() A

↳ Parent: MembersMapper

Complexity

Conditions	1
Paths	1

Size

Total Lines	22
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	9.2
c	0
b	0
f	0
cc	1
eloc	14
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 OC\L10N\L10N;
use OCA\Circles\Exceptions\MemberAlreadyExistsException;
use OCA\Circles\Exceptions\MemberDoesNotExistException;
use OCA\Circles\Model\Member;

use OCA\Circles\Service\MiscService;
use OCP\IDBConnection;
use OCP\AppFramework\Db\Mapper;

class MembersMapper extends Mapper {

	const TABLENAME = 'circles_members';

	/** @var L10N */
	private $l10n;

	/** @var MiscService */
	private $miscService;


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


	/**
	 * @param $circleId
	 * @param $userId
	 * @param bool $moderator
	 *
	 * @return 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($this->l10n->t('This member does not exist'));
		}

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

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

		return $member;
	}


	/**
	 * 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) {
		try {
			$user->hasToBeMember();

			$qb = $this->getMembersFromCircleSql((int)$circleId);
			$cursor = $qb->execute();
			$result = [];
			while ($data = $cursor->fetch()) {
				if (!$user->isLevel(Member::LEVEL_MODERATOR)) {
					$data['note'] = '';
				}

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

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

		return $result;
	}


	/**
	 * Generate SQL Request for getMemberFromCircle()
	 *
	 * @param integer $circleId
	 * @param $userId
	 *
	 * @return \OCP\DB\QueryBuilder\IQueryBuilder
	 */
	private function getMemberFromCircleSql($circleId, $userId) {
		$qb = $this->getMembersFromCircleSqlBase($circleId);
		$expr = $qb->expr();

		$qb->andWhere(
			$expr->eq('user_id', $qb->createNamedParameter($userId))
		);

		return $qb;
	}


	/**
	 * Return SQL for getMembersFromCircle.
	 *
	 * @param integer $circleId
	 *
	 * @return \OCP\DB\QueryBuilder\IQueryBuilder
	 */
	private function getMembersFromCircleSql($circleId) {
		$qb = $this->getMembersFromCircleSqlBase($circleId);
		$expr = $qb->expr();

		/** @noinspection PhpMethodParametersCountMismatchInspection */
		$qb->andwhere(
			$expr->neq('status', $qb->createNamedParameter(Member::STATUS_NONMEMBER))
		);

		return $qb;
	}


	/**
	 *
	 * Return the base select request for both
	 * getMembersFromCircleSql()
	 * getMemberFromCircleSql()
	 *
	 * @param $circleId
	 *
	 * @return \OCP\DB\QueryBuilder\IQueryBuilder
	 */
	private function getMembersFromCircleSqlBase($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))
		   );

		return $qb;
	}


	/**
	 * update database entry for a specific Member.
	 *
	 * @param Member $member
	 *
	 * @return bool
	 */
	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()))
			   ->setValue('joined', $qb->createFunction('NOW()'));

			$qb->execute();
		} catch (UniqueConstraintViolationException $e) {

			throw new MemberAlreadyExistsException(
				$this->l10n->t('This user is already a member of the circle')
			);
		}
	}


	/**
	 * 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 int $circleId
	 *
	 * @return bool
	 */
	public function removeAllFromCircle($circleId) {
		$qb = $this->db->getQueryBuilder();
		$qb->delete(self::TABLENAME)
		   ->where(
			   $qb->expr()
				  ->eq('circle_id', $qb->createNamedParameter($circleId))
		   );

		$qb->execute();

		return true;
	}


	/**
	 * remove all members/owner from a circle
	 *
	 * @param string $userId
	 *
	 * @return bool
	 */
	public function removeAllFromUserId($userId) {

		$qb = $this->db->getQueryBuilder();
		$qb->delete(self::TABLENAME)
		   ->where(
			   $qb->expr()
				  ->eq('user_id', $qb->createNamedParameter($userId))
		   );

		$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 OC\L10N\L10N;
31		use OCA\Circles\Exceptions\MemberAlreadyExistsException;
32		use OCA\Circles\Exceptions\MemberDoesNotExistException;
33		use OCA\Circles\Model\Member;
34
35		use OCA\Circles\Service\MiscService;
36		use OCP\IDBConnection;
37		use OCP\AppFramework\Db\Mapper;
38
39		class MembersMapper extends Mapper {
40
41		const TABLENAME = 'circles_members';
42
43		/** @var L10N */
44		private $l10n;
45
46		/** @var MiscService */
47		private $miscService;
48
49
50		public function __construct(IDBConnection $db, $l10n, $miscService) {
51		parent::__construct($db, self::TABLENAME, 'OCA\Circles\Db\Members');
52		$this->l10n = $l10n;
53		$this->miscService = $miscService;
54		}
55
56
57		/**
58		* @param $circleId
59		* @param $userId
60		* @param bool $moderator
61		*
62		* @return Member
63		* @throws MemberDoesNotExistException
64		*/
65		public function getMemberFromCircle($circleId, $userId, $moderator = false) {
66
67		$circleId = (int)$circleId;
68		$qb = $this->getMemberFromCircleSql($circleId, $userId);
69		$cursor = $qb->setMaxResults(1)
70		->execute();
71
72		$data = $cursor->fetch();
73		if ($data === false) {
74		throw new MemberDoesNotExistException($this->l10n->t('This member does not exist'));
75		}
76
77		if ($moderator !== true) {
78		$data['note'] = '';
79		}
80
81		$member = new Member($this->l10n);
82		$member->fromArray($data);
83		$cursor->closeCursor();
84
85		return $member;
86		}
87
88
89		/**
90		* get members list from a circle. If moderator, returns also notes about each member.
91		*
92		* @param $circleId
93		* @param Member $user
94		*
95		* @return array
96		* @internal param Member $member
97		* @internal param bool $moderator
98		*
99		*/
100		public function getMembersFromCircle($circleId, Member $user) {
101		try {
102		$user->hasToBeMember();
103
104		$qb = $this->getMembersFromCircleSql((int)$circleId);
105		$cursor = $qb->execute();
106		$result = [];
107		while ($data = $cursor->fetch()) {
108		if (!$user->isLevel(Member::LEVEL_MODERATOR)) {
109		$data['note'] = '';
110		}
111
112		$member = new Member($this->l10n);
113		$member->fromArray($data);
114		$result[] = $member;
115		}
116		$cursor->closeCursor();
117
118		} catch (MemberDoesNotExistException $e) {
119		throw new $e;
120		}
121
122		return $result;
123		}
124
125
126		/**
127		* Generate SQL Request for getMemberFromCircle()
128		*
129		* @param integer $circleId
130		* @param $userId
131		*
132		* @return \OCP\DB\QueryBuilder\IQueryBuilder
133		*/
134		private function getMemberFromCircleSql($circleId, $userId) {
135		$qb = $this->getMembersFromCircleSqlBase($circleId);
136		$expr = $qb->expr();
137
138		$qb->andWhere(
139		$expr->eq('user_id', $qb->createNamedParameter($userId))
140		);
141
142		return $qb;
143		}
144
145
146		/**
147		* Return SQL for getMembersFromCircle.
148		*
149		* @param integer $circleId
150		*
151		* @return \OCP\DB\QueryBuilder\IQueryBuilder
152		*/
153		private function getMembersFromCircleSql($circleId) {
154		$qb = $this->getMembersFromCircleSqlBase($circleId);
155		$expr = $qb->expr();
156
157		/** @noinspection PhpMethodParametersCountMismatchInspection */
158		$qb->andwhere(
159		$expr->neq('status', $qb->createNamedParameter(Member::STATUS_NONMEMBER))
160		);
161
162		return $qb;
163		}
164
165
166		/**
167		*
168		* Return the base select request for both
169		* getMembersFromCircleSql()
170		* getMemberFromCircleSql()
171		*
172		* @param $circleId
173		*
174		* @return \OCP\DB\QueryBuilder\IQueryBuilder
175		*/
176		private function getMembersFromCircleSqlBase($circleId) {
177		$qb = $this->db->getQueryBuilder();
178		$expr = $qb->expr();
179
180		/** @noinspection PhpMethodParametersCountMismatchInspection */
181		$qb->select(
182		'circle_id', 'user_id', 'level', 'status', 'note', 'joined'
183		)
184		->from(self::TABLENAME)
185		->where(
186		$expr->eq('circle_id', $qb->createNamedParameter($circleId))
187		);
188
189		return $qb;
190		}
191
192
193		/**
194		* update database entry for a specific Member.
195		*
196		* @param Member $member
197		*
198		* @return bool
199		*/
200		public function editMember(Member $member) {
201
202		$qb = $this->db->getQueryBuilder();
203
204		/** @noinspection PhpMethodParametersCountMismatchInspection */
205		$qb->update(self::TABLENAME)
206		->set('level', $qb->createNamedParameter($member->getLevel()))
207		->set('status', $qb->createNamedParameter($member->getStatus()))
208		->where(
209		$qb->expr()
210		->andX(
211		$qb->expr()
212		->eq('circle_id', $qb->createNamedParameter($member->getCircleId())),
213		$qb->expr()
214		->eq('user_id', $qb->createNamedParameter($member->getUserId()))
215		)
216		);
217
218		$qb->execute();
219
220		return true;
221		}
222
223
224		/**
225		* Insert Member into database.
226		*
227		* @param Member $member
228		*
229		* @throws MemberAlreadyExistsException
230		*/
231		public function add(Member $member) {
232
233		try {
234		$qb = $this->db->getQueryBuilder();
235		$qb->insert(self::TABLENAME)
236		->setValue('circle_id', $qb->createNamedParameter($member->getCircleId()))
237		->setValue('user_id', $qb->createNamedParameter($member->getUserId()))
238		->setValue('level', $qb->createNamedParameter($member->getLevel()))
239		->setValue('status', $qb->createNamedParameter($member->getStatus()))
240		->setValue('note', $qb->createNamedParameter($member->getNote()))
241		->setValue('joined', $qb->createFunction('NOW()'));
242
243		$qb->execute();
244		} 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...
245		throw new MemberAlreadyExistsException(
246		$this->l10n->t('This user is already a member of the circle')
247		);
248		}
249		}
250
251
252		/**
253		* Remove a member from a circle.
254		*
255		* @param Member $member
256		*
257		* @return bool
258		*/
259		public function remove(Member $member) {
260
261		$qb = $this->db->getQueryBuilder();
262
263		/** @noinspection PhpMethodParametersCountMismatchInspection */
264		$qb->delete(self::TABLENAME)
265		->where(
266		$qb->expr()
267		->eq('circle_id', $qb->createNamedParameter($member->getCircleId())),
268		$qb->expr()
269		->eq('user_id', $qb->createNamedParameter($member->getUserId()))
270		);
271
272		$qb->execute();
273
274		return true;
275		}
276
277		/**
278		* remove all members/owner from a circle
279		*
280		* @param int $circleId
281		*
282		* @return bool
283		*/
284	View Code Duplication	public function removeAllFromCircle($circleId) {
285		$qb = $this->db->getQueryBuilder();
286		$qb->delete(self::TABLENAME)
287		->where(
288		$qb->expr()
289		->eq('circle_id', $qb->createNamedParameter($circleId))
290		);
291
292		$qb->execute();
293
294		return true;
295		}
296
297
298		/**
299		* remove all members/owner from a circle
300		*
301		* @param string $userId
302		*
303		* @return bool
304		*/
305	View Code Duplication	public function removeAllFromUserId($userId) {
		0 ignored issues – show Duplication introduced 2017-05-11 11:05 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...
306		$qb = $this->db->getQueryBuilder();
307		$qb->delete(self::TABLENAME)
308		->where(
309		$qb->expr()
310		->eq('user_id', $qb->createNamedParameter($userId))
311		);
312
313		$qb->execute();
314
315		return true;
316		}
317		}
318
319

nextcloud / circles

Push — master ( b60009...a65047 )

MembersMapper::editMember() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like