Member - Code Metrics - Inspection of "Circles 22" - nextcloud/circles - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#551)

by Maxence

created 2021-02-20 13:22 UTC

Member D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	579
Duplicated Lines	3.8 %

Coupling/Cohesion

Components	3
Dependencies	8

Importance

Changes

Metric	Value
wmc	58
lcom	3
cbo	8
dl	22
loc	579
rs	4.5599
c	0
b	0
f	0

39 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	2	1
A	setId()	0	5	1
A	getId()	0	3	1
A	setCircleId()	0	5	1
A	getCircleId()	0	3	1
A	setSingleId()	0	5	1
A	getSingleId()	0	3	1
A	setUserId()	0	5	1
A	getUserId()	0	3	1
A	setUserType()	0	5	1
A	getUserType()	0	3	1
A	setInstance()	0	5	1
A	getInstance()	0	3	1
A	setLevel()	0	5	1
A	getLevel()	0	3	1
A	setStatus()	0	5	1
A	getStatus()	0	3	1
A	setNote()	0	5	1
A	getNote()	0	3	1
A	setCachedName()	0	5	1
A	setCachedUpdate()	0	5	1
A	getCachedUpdate()	0	3	1
A	getCachedName()	0	3	1
A	setContactId()	0	5	1
A	getContactId()	0	3	1
A	setContactMeta()	0	5	1
A	getContactMeta()	0	3	1
A	setCircle()	0	5	1
A	getCircle()	0	3	1
A	hasCircle()	0	3	1
A	setJoined()	0	5	1
A	getJoined()	0	3	1
A	isMember()	0	3	1
B	compareWith()	0	18	10
A	import()	0	29	3
A	jsonSerialize()	0	26	2
B	importFromDatabase()	0	38	6
A	parseLevelString()	11	11	2
A	parseTypeString()	11	11	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Member often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Member, and based on these observations, apply Extract Interface, too.

<?php

declare(strict_types=1);


/**
 * 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 2021
 * @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\Model;

use daita\MySmallPhpTools\Db\Nextcloud\nc21\INC21QueryRow;
use daita\MySmallPhpTools\Exceptions\InvalidItemException;
use daita\MySmallPhpTools\IDeserializable;
use daita\MySmallPhpTools\Traits\Nextcloud\nc21\TNC21Deserialize;
use daita\MySmallPhpTools\Traits\TArrayTools;
use DateTime;
use JsonSerializable;
use OCA\Circles\Exceptions\MemberLevelException;
use OCA\Circles\Exceptions\MemberNotFoundException;
use OCA\Circles\Exceptions\UserTypeNotFoundException;
use OCA\Circles\IFederatedUser;


/**
 * Class Member
 *
 * @package OCA\Circles\Model
 */
class Member extends ManagedModel implements IFederatedUser, IDeserializable, INC21QueryRow, JsonSerializable {


	use TArrayTools;
	use TNC21Deserialize;


	const LEVEL_NONE = 0;
	const LEVEL_MEMBER = 1;
	const LEVEL_MODERATOR = 4;
	const LEVEL_ADMIN = 8;
	const LEVEL_OWNER = 9;

	const TYPE_CIRCLE = 16;
	const TYPE_SINGLE = 8;
	const TYPE_USER = 1;
	const TYPE_GROUP = 2;
	const TYPE_MAIL = 3;
	const TYPE_CONTACT = 4;

	const STATUS_NONMEMBER = 'Unknown';
	const STATUS_INVITED = 'Invited';
	const STATUS_REQUEST = 'Requesting';
	const STATUS_MEMBER = 'Member';
	const STATUS_BLOCKED = 'Blocked';
	const STATUS_KICKED = 'Kicked';


	public static $DEF_LEVEL = [
		1 => 'Member',
		4 => 'Moderator',
		8 => 'Admin',
		9 => 'Owner'
	];

	public static $DEF_TYPE = [
		1  => 'user',
		16 => 'circle',
		8  => 'single',
		3  => 'mail',
		4  => 'contact',
	];

	/** @var string */
	private $id = '';

	/** @var string */
	private $circleId = '';

	/** @var string */
	private $singleId = '';

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

	/** @var int */
	private $userType = self::TYPE_USER;

	/** @var string */
	private $instance = '';

	/** @var int */
	private $level = 0;

	/** @var string */
	private $status = 'Unknown';

	/** @var string */
	private $note = '';

	/** @var string */
	private $cachedName = '';

	/** @var int */
	private $cachedUpdate = 0;

	/** @var string */
	private $contactId = '';

	/** @var string */
	private $contactMeta = '';

	/** @var Circle */
	private $circle;


	/** @var int */
	private $joined = 0;


	/**
	 * Member constructor.
	 */
	public function __construct() {
	}


	/**
	 * @param string $id
	 *
	 * @return $this
	 */
	public function setId(string $id): self {
		$this->id = $id;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getId(): string {
		return $this->id;
	}


	/**
	 * @param string $circleId
	 *
	 * @return Member
	 */
	public function setCircleId(string $circleId): self {
		$this->circleId = $circleId;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getCircleId(): string {
		return $this->circleId;
	}


	/**
	 * This should replace user_id, user_type and instance; and will use the data from Circle with
	 * Config=CFG_SINGLE
	 *
	 * @param string $singleId
	 *
	 * @return $this
	 */
	public function setSingleId(string $singleId): self {
		$this->singleId = $singleId;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getSingleId(): string {
		return $this->singleId;
	}


	/**
	 * @param string $userId
	 *
	 * @return Member
	 */
	public function setUserId(string $userId): self {
		$this->userId = $userId;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getUserId(): string {
		return $this->userId;
	}


	/**
	 * @param int $userType
	 *
	 * @return Member
	 */
	public function setUserType(int $userType): self {
		$this->userType = $userType;

		return $this;
	}

	/**
	 * @return int
	 */
	public function getUserType(): int {
		return $this->userType;
	}


	/**
	 * @param string $instance
	 *
	 * @return Member
	 */
	public function setInstance(string $instance): self {
		$this->instance = $instance;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getInstance(): string {
		return $this->instance;
	}


	/**
	 * @param int $level
	 *
	 * @return Member
	 */
	public function setLevel(int $level): self {
		$this->level = $level;

		return $this;
	}

	/**
	 * @return int
	 */
	public function getLevel(): int {
		return $this->level;
	}


	/**
	 * @param string $status
	 *
	 * @return Member
	 */
	public function setStatus(string $status): self {
		$this->status = $status;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getStatus(): string {
		return $this->status;
	}


	/**
	 * @param string $note
	 *
	 * @return Member
	 */
	public function setNote(string $note): self {
		$this->note = $note;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getNote(): string {
		return $this->note;
	}


	/**
	 * @param string $cachedName
	 *
	 * @return Member
	 */
	public function setCachedName(string $cachedName): self {
		$this->cachedName = $cachedName;

		return $this;
	}


	/**
	 * @param int $cachedUpdate
	 *
	 * @return Member
	 */
	public function setCachedUpdate(int $cachedUpdate): self {
		$this->cachedUpdate = $cachedUpdate;

		return $this;
	}

	/**
	 * @return int
	 */
	public function getCachedUpdate(): int {
		return $this->cachedUpdate;
	}


	/**
	 * @return string
	 */
	public function getCachedName(): string {
		return $this->cachedName;
	}


	/**
	 * @param string $contactId
	 *
	 * @return Member
	 */
	public function setContactId(string $contactId): self {
		$this->contactId = $contactId;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getContactId(): string {
		return $this->contactId;
	}


	/**
	 * @param string $contactMeta
	 *
	 * @return Member
	 */
	public function setContactMeta(string $contactMeta): self {
		$this->contactMeta = $contactMeta;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getContactMeta(): string {
		return $this->contactMeta;
	}


	/**
	 * @param Circle $circle
	 *
	 * @return self
	 */
	public function setCircle(Circle $circle): self {
		$this->circle = $circle;

		return $this;
	}

	/**
	 * @return Circle
	 */
	public function getCircle(): Circle {
		return $this->circle;
	}

	/**
	 * @return bool
	 */
	public function hasCircle(): bool {
		return (!is_null($this->circle));
	}


	/**
	 * @param int $joined
	 *
	 * @return Member
	 */
	public function setJoined(int $joined): self {
		$this->joined = $joined;

		return $this;
	}

	/**
	 * @return int
	 */
	public function getJoined(): int {
		return $this->joined;
	}


	/**
	 * @return bool
	 */
	public function isMember(): bool {
		return ($this->level > 0);
	}


	/**
	 * @param Member $member
	 * @param bool $full
	 *
	 * @return bool
	 */
	public function compareWith(Member $member, bool $full = true): bool {
		if ($this->getId() !== $member->getId()
			|| $this->getCircleId() !== $member->getCircleId()
			|| $this->getSingleId() !== $member->getSingleId()
			|| $this->getUserId() !== $member->getUserId()
			|| $this->getUserType() <> $member->getUserType()
			|| $this->getInstance() !== $member->getInstance()) {
			return false;
		}

		if ($full

			&& ($this->getLevel() <> $member->getLevel()
				|| $this->getStatus() !== $member->getStatus())) {
			return false;
		}

		return true;
	}


	/**
	 * @param array $data
	 *
	 * @return $this
	 * @throws InvalidItemException
	 */
	public function import(array $data): IDeserializable {
		if ($this->get('user_id', $data) === '') {
			throw new InvalidItemException();
		}

		$this->setId($this->get('id', $data));
		$this->setCircleId($this->get('circle_id', $data));
		$this->setSingleId($this->get('single_id', $data));
		$this->setUserId($this->get('user_id', $data));
		$this->setUserType($this->getInt('user_type', $data));
		$this->setInstance($this->get('instance', $data));
		$this->setLevel($this->getInt('level', $data));
		$this->setStatus($this->get('status', $data));
		$this->setCachedName($this->get('cached_name', $data));
		$this->setCachedUpdate($this->getInt('cached_update', $data));
		$this->setNote($this->get('note', $data));
		$this->setContactId($this->get('contact_id', $data));
		$this->setContactMeta($this->get('contact_meta', $data));
		$this->setJoined($this->getInt('joined', $data));

		try {
			/** @var Circle $circle */
			$circle = $this->deserialize($this->getArray('circle', $data), Circle::class);
			$this->setCircle($circle);
		} catch (InvalidItemException $e) {

		}

		return $this;
	}


	/**
	 * @return string[]
	 */
	public function jsonSerialize(): array {
		$arr = array_filter(
			[
				'id'            => $this->getId(),
				'circle_id'     => $this->getCircleId(),
				'single_id'     => $this->getSingleId(),
				'user_id'       => $this->getUserId(),
				'user_type'     => $this->getUserType(),
				'instance'      => $this->getInstance(),
				'level'         => $this->getLevel(),
				'status'        => $this->getStatus(),
				'cached_name'   => $this->getCachedName(),
				'cached_update' => $this->getCachedUpdate(),
				'note'          => $this->getNote(),
				'contact_id'    => $this->getContactId(),
				'contact_meta'  => $this->getContactMeta(),
				'joined'        => $this->getJoined()
			]
		);

		if ($this->hasCircle()) {
			$arr['circle'] = $this->getCircle();
		}

		return $arr;
	}


	/**
	 * @param array $data
	 * @param string $prefix
	 *
	 * @return INC21QueryRow
	 * @throws MemberNotFoundException
	 */
	public function importFromDatabase(array $data, string $prefix = ''): INC21QueryRow {
		if (!array_key_exists($prefix . 'member_id', $data)) {
			throw new MemberNotFoundException();
		}

		$this->setId($this->get($prefix . 'member_id', $data));
		$this->setCircleId($this->get($prefix . 'circle_id', $data));
		$this->setSingleId($this->get($prefix . 'single_id', $data));
		$this->setUserId($this->get($prefix . 'user_id', $data));
		$this->setUserType($this->getInt($prefix . 'user_type', $data));
		$this->setInstance($this->get($prefix . 'instance', $data));
		$this->setLevel($this->getInt($prefix . 'level', $data));
		$this->setStatus($this->get($prefix . 'status', $data));
		$this->setCachedName($this->get($prefix . 'cached_name', $data));
		$this->setNote($this->get($prefix . 'note', $data));
		$this->setContactId($this->get($prefix . 'contact_id', $data));
		$this->setContactMeta($this->get($prefix . 'contact_meta', $data));

		$cachedUpdate = $this->get($prefix . 'cached_update', $data);
		if ($cachedUpdate !== '') {
			$this->setCachedUpdate(DateTime::createFromFormat('Y-m-d H:i:s', $cachedUpdate)->getTimestamp());
		}

		$joined = $this->get($prefix . 'joined', $data);
		if ($joined !== '') {
			$this->setJoined(DateTime::createFromFormat('Y-m-d H:i:s', $joined)->getTimestamp());
		}

		if ($this->getInstance() === '') {
			$this->setInstance($this->get('_params.local', $data));
		}

		if ($prefix === '') {
			$this->getManager()->importCircleFromDatabase($this, $data);
		}

		return $this;
	}


	/**
	 * @param string $levelString
	 *
	 * @return int
	 * @throws MemberLevelException
	 */
	public static function parseLevelString(string $levelString): int {

		$levelString = ucfirst(strtolower($levelString));
		$level = array_search($levelString, Member::$DEF_LEVEL);

		if (!$level) {
			$all = implode(', ', array_values(self::$DEF_LEVEL));
			throw new MemberLevelException('Available levels: ' . $all);
		}

		return (int)$level;
	}

	/**
	 * @param string $typeString
	 *
	 * @return int
	 * @throws UserTypeNotFoundException
	 */
	public static function parseTypeString(string $typeString): int {

		$typeString = strtolower($typeString);
		$type = array_search($typeString, Member::$DEF_TYPE);

		if (!$type) {
			$all = implode(', ', array_values(self::$DEF_TYPE));
			throw new UserTypeNotFoundException('Available types: ' . $all);
		}

		return (int)$type;
	}

}



1		<?php
2
3		declare(strict_types=1);
4
5
6		/**
7		* Circles - Bring cloud-users closer together.
8		*
9		* This file is licensed under the Affero General Public License version 3 or
10		* later. See the COPYING file.
11		*
12		* @author Maxence Lange <[email protected]>
13		* @copyright 2021
14		* @license GNU AGPL version 3 or any later version
15		*
16		* This program is free software: you can redistribute it and/or modify
17		* it under the terms of the GNU Affero General Public License as
18		* published by the Free Software Foundation, either version 3 of the
19		* License, or (at your option) any later version.
20		*
21		* This program is distributed in the hope that it will be useful,
22		* but WITHOUT ANY WARRANTY; without even the implied warranty of
23		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24		* GNU Affero General Public License for more details.
25		*
26		* You should have received a copy of the GNU Affero General Public License
27		* along with this program. If not, see <http://www.gnu.org/licenses/>.
28		*
29		*/
30
31
32		namespace OCA\Circles\Model;
33
34		use daita\MySmallPhpTools\Db\Nextcloud\nc21\INC21QueryRow;
35		use daita\MySmallPhpTools\Exceptions\InvalidItemException;
36		use daita\MySmallPhpTools\IDeserializable;
37		use daita\MySmallPhpTools\Traits\Nextcloud\nc21\TNC21Deserialize;
38		use daita\MySmallPhpTools\Traits\TArrayTools;
39		use DateTime;
40		use JsonSerializable;
41		use OCA\Circles\Exceptions\MemberLevelException;
42		use OCA\Circles\Exceptions\MemberNotFoundException;
43		use OCA\Circles\Exceptions\UserTypeNotFoundException;
44		use OCA\Circles\IFederatedUser;
45
46
47		/**
48		* Class Member
49		*
50		* @package OCA\Circles\Model
51		*/
52		class Member extends ManagedModel implements IFederatedUser, IDeserializable, INC21QueryRow, JsonSerializable {
53
54
55		use TArrayTools;
56		use TNC21Deserialize;
57
58
59		const LEVEL_NONE = 0;
60		const LEVEL_MEMBER = 1;
61		const LEVEL_MODERATOR = 4;
62		const LEVEL_ADMIN = 8;
63		const LEVEL_OWNER = 9;
64
65		const TYPE_CIRCLE = 16;
66		const TYPE_SINGLE = 8;
67		const TYPE_USER = 1;
68		const TYPE_GROUP = 2;
69		const TYPE_MAIL = 3;
70		const TYPE_CONTACT = 4;
71
72		const STATUS_NONMEMBER = 'Unknown';
73		const STATUS_INVITED = 'Invited';
74		const STATUS_REQUEST = 'Requesting';
75		const STATUS_MEMBER = 'Member';
76		const STATUS_BLOCKED = 'Blocked';
77		const STATUS_KICKED = 'Kicked';
78
79
80		public static $DEF_LEVEL = [
81		1 => 'Member',
82		4 => 'Moderator',
83		8 => 'Admin',
84		9 => 'Owner'
85		];
86
87		public static $DEF_TYPE = [
88		1 => 'user',
89		16 => 'circle',
90		8 => 'single',
91		3 => 'mail',
92		4 => 'contact',
93		];
94
95		/** @var string */
96		private $id = '';
97
98		/** @var string */
99		private $circleId = '';
100
101		/** @var string */
102		private $singleId = '';
103
104		/** @var string */
105		private $userId = '';
106
107		/** @var int */
108		private $userType = self::TYPE_USER;
109
110		/** @var string */
111		private $instance = '';
112
113		/** @var int */
114		private $level = 0;
115
116		/** @var string */
117		private $status = 'Unknown';
118
119		/** @var string */
120		private $note = '';
121
122		/** @var string */
123		private $cachedName = '';
124
125		/** @var int */
126		private $cachedUpdate = 0;
127
128		/** @var string */
129		private $contactId = '';
130
131		/** @var string */
132		private $contactMeta = '';
133
134		/** @var Circle */
135		private $circle;
136
137
138		/** @var int */
139		private $joined = 0;
140
141
142		/**
143		* Member constructor.
144		*/
145		public function __construct() {
146		}
147
148
149		/**
150		* @param string $id
151		*
152		* @return $this
153		*/
154		public function setId(string $id): self {
155		$this->id = $id;
156
157		return $this;
158		}
159
160		/**
161		* @return string
162		*/
163		public function getId(): string {
164		return $this->id;
165		}
166
167
168		/**
169		* @param string $circleId
170		*
171		* @return Member
172		*/
173		public function setCircleId(string $circleId): self {
174		$this->circleId = $circleId;
175
176		return $this;
177		}
178
179		/**
180		* @return string
181		*/
182		public function getCircleId(): string {
183		return $this->circleId;
184		}
185
186
187		/**
188		* This should replace user_id, user_type and instance; and will use the data from Circle with
189		* Config=CFG_SINGLE
190		*
191		* @param string $singleId
192		*
193		* @return $this
194		*/
195		public function setSingleId(string $singleId): self {
196		$this->singleId = $singleId;
197
198		return $this;
199		}
200
201		/**
202		* @return string
203		*/
204		public function getSingleId(): string {
205		return $this->singleId;
206		}
207
208
209		/**
210		* @param string $userId
211		*
212		* @return Member
213		*/
214		public function setUserId(string $userId): self {
215		$this->userId = $userId;
216
217		return $this;
218		}
219
220		/**
221		* @return string
222		*/
223		public function getUserId(): string {
224		return $this->userId;
225		}
226
227
228		/**
229		* @param int $userType
230		*
231		* @return Member
232		*/
233		public function setUserType(int $userType): self {
234		$this->userType = $userType;
235
236		return $this;
237		}
238
239		/**
240		* @return int
241		*/
242		public function getUserType(): int {
243		return $this->userType;
244		}
245
246
247		/**
248		* @param string $instance
249		*
250		* @return Member
251		*/
252		public function setInstance(string $instance): self {
253		$this->instance = $instance;
254
255		return $this;
256		}
257
258		/**
259		* @return string
260		*/
261		public function getInstance(): string {
262		return $this->instance;
263		}
264
265
266		/**
267		* @param int $level
268		*
269		* @return Member
270		*/
271		public function setLevel(int $level): self {
272		$this->level = $level;
273
274		return $this;
275		}
276
277		/**
278		* @return int
279		*/
280		public function getLevel(): int {
281		return $this->level;
282		}
283
284
285		/**
286		* @param string $status
287		*
288		* @return Member
289		*/
290		public function setStatus(string $status): self {
291		$this->status = $status;
292
293		return $this;
294		}
295
296		/**
297		* @return string
298		*/
299		public function getStatus(): string {
300		return $this->status;
301		}
302
303
304		/**
305		* @param string $note
306		*
307		* @return Member
308		*/
309		public function setNote(string $note): self {
310		$this->note = $note;
311
312		return $this;
313		}
314
315		/**
316		* @return string
317		*/
318		public function getNote(): string {
319		return $this->note;
320		}
321
322
323		/**
324		* @param string $cachedName
325		*
326		* @return Member
327		*/
328		public function setCachedName(string $cachedName): self {
329		$this->cachedName = $cachedName;
330
331		return $this;
332		}
333
334
335		/**
336		* @param int $cachedUpdate
337		*
338		* @return Member
339		*/
340		public function setCachedUpdate(int $cachedUpdate): self {
341		$this->cachedUpdate = $cachedUpdate;
342
343		return $this;
344		}
345
346		/**
347		* @return int
348		*/
349		public function getCachedUpdate(): int {
350		return $this->cachedUpdate;
351		}
352
353
354		/**
355		* @return string
356		*/
357		public function getCachedName(): string {
358		return $this->cachedName;
359		}
360
361
362		/**
363		* @param string $contactId
364		*
365		* @return Member
366		*/
367		public function setContactId(string $contactId): self {
368		$this->contactId = $contactId;
369
370		return $this;
371		}
372
373		/**
374		* @return string
375		*/
376		public function getContactId(): string {
377		return $this->contactId;
378		}
379
380
381		/**
382		* @param string $contactMeta
383		*
384		* @return Member
385		*/
386		public function setContactMeta(string $contactMeta): self {
387		$this->contactMeta = $contactMeta;
388
389		return $this;
390		}
391
392		/**
393		* @return string
394		*/
395		public function getContactMeta(): string {
396		return $this->contactMeta;
397		}
398
399
400		/**
401		* @param Circle $circle
402		*
403		* @return self
404		*/
405		public function setCircle(Circle $circle): self {
406		$this->circle = $circle;
407
408		return $this;
409		}
410
411		/**
412		* @return Circle
413		*/
414		public function getCircle(): Circle {
415		return $this->circle;
416		}
417
418		/**
419		* @return bool
420		*/
421		public function hasCircle(): bool {
422		return (!is_null($this->circle));
423		}
424
425
426		/**
427		* @param int $joined
428		*
429		* @return Member
430		*/
431		public function setJoined(int $joined): self {
432		$this->joined = $joined;
433
434		return $this;
435		}
436
437		/**
438		* @return int
439		*/
440		public function getJoined(): int {
441		return $this->joined;
442		}
443
444
445		/**
446		* @return bool
447		*/
448		public function isMember(): bool {
449		return ($this->level > 0);
450		}
451
452
453		/**
454		* @param Member $member
455		* @param bool $full
456		*
457		* @return bool
458		*/
459		public function compareWith(Member $member, bool $full = true): bool {
460		if ($this->getId() !== $member->getId()
461		\|\| $this->getCircleId() !== $member->getCircleId()
462		\|\| $this->getSingleId() !== $member->getSingleId()
463		\|\| $this->getUserId() !== $member->getUserId()
464		\|\| $this->getUserType() <> $member->getUserType()
465		\|\| $this->getInstance() !== $member->getInstance()) {
466		return false;
467		}
468
469		if ($full
		0 ignored issues – show Unused Code introduced 2021-02-07 12:48 UTC by Report Bug Copy Issue Report This `if` statement, and the following `return` statement can be replaced with `return !($full && ($this...$member->getStatus()));`. Loading history...
470		&& ($this->getLevel() <> $member->getLevel()
471		\|\| $this->getStatus() !== $member->getStatus())) {
472		return false;
473		}
474
475		return true;
476		}
477
478
479		/**
480		* @param array $data
481		*
482		* @return $this
483		* @throws InvalidItemException
484		*/
485		public function import(array $data): IDeserializable {
486		if ($this->get('user_id', $data) === '') {
487		throw new InvalidItemException();
488		}
489
490		$this->setId($this->get('id', $data));
491		$this->setCircleId($this->get('circle_id', $data));
492		$this->setSingleId($this->get('single_id', $data));
493		$this->setUserId($this->get('user_id', $data));
494		$this->setUserType($this->getInt('user_type', $data));
495		$this->setInstance($this->get('instance', $data));
496		$this->setLevel($this->getInt('level', $data));
497		$this->setStatus($this->get('status', $data));
498		$this->setCachedName($this->get('cached_name', $data));
499		$this->setCachedUpdate($this->getInt('cached_update', $data));
500		$this->setNote($this->get('note', $data));
501		$this->setContactId($this->get('contact_id', $data));
502		$this->setContactMeta($this->get('contact_meta', $data));
503		$this->setJoined($this->getInt('joined', $data));
504
505		try {
506		/** @var Circle $circle */
507		$circle = $this->deserialize($this->getArray('circle', $data), Circle::class);
508		$this->setCircle($circle);
509		} catch (InvalidItemException $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2021-02-07 12:48 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
510		}
511
512		return $this;
513		}
514
515
516		/**
517		* @return string[]
518		*/
519		public function jsonSerialize(): array {
520		$arr = array_filter(
521		[
522		'id' => $this->getId(),
523		'circle_id' => $this->getCircleId(),
524		'single_id' => $this->getSingleId(),
525		'user_id' => $this->getUserId(),
526		'user_type' => $this->getUserType(),
527		'instance' => $this->getInstance(),
528		'level' => $this->getLevel(),
529		'status' => $this->getStatus(),
530		'cached_name' => $this->getCachedName(),
531		'cached_update' => $this->getCachedUpdate(),
532		'note' => $this->getNote(),
533		'contact_id' => $this->getContactId(),
534		'contact_meta' => $this->getContactMeta(),
535		'joined' => $this->getJoined()
536		]
537		);
538
539		if ($this->hasCircle()) {
540		$arr['circle'] = $this->getCircle();
541		}
542
543		return $arr;
544		}
545
546
547		/**
548		* @param array $data
549		* @param string $prefix
550		*
551		* @return INC21QueryRow
552		* @throws MemberNotFoundException
553		*/
554		public function importFromDatabase(array $data, string $prefix = ''): INC21QueryRow {
555		if (!array_key_exists($prefix . 'member_id', $data)) {
556		throw new MemberNotFoundException();
557		}
558
559		$this->setId($this->get($prefix . 'member_id', $data));
560		$this->setCircleId($this->get($prefix . 'circle_id', $data));
561		$this->setSingleId($this->get($prefix . 'single_id', $data));
562		$this->setUserId($this->get($prefix . 'user_id', $data));
563		$this->setUserType($this->getInt($prefix . 'user_type', $data));
564		$this->setInstance($this->get($prefix . 'instance', $data));
565		$this->setLevel($this->getInt($prefix . 'level', $data));
566		$this->setStatus($this->get($prefix . 'status', $data));
567		$this->setCachedName($this->get($prefix . 'cached_name', $data));
568		$this->setNote($this->get($prefix . 'note', $data));
569		$this->setContactId($this->get($prefix . 'contact_id', $data));
570		$this->setContactMeta($this->get($prefix . 'contact_meta', $data));
571
572		$cachedUpdate = $this->get($prefix . 'cached_update', $data);
573		if ($cachedUpdate !== '') {
574		$this->setCachedUpdate(DateTime::createFromFormat('Y-m-d H:i:s', $cachedUpdate)->getTimestamp());
575		}
576
577		$joined = $this->get($prefix . 'joined', $data);
578		if ($joined !== '') {
579		$this->setJoined(DateTime::createFromFormat('Y-m-d H:i:s', $joined)->getTimestamp());
580		}
581
582		if ($this->getInstance() === '') {
583		$this->setInstance($this->get('_params.local', $data));
584		}
585
586		if ($prefix === '') {
587		$this->getManager()->importCircleFromDatabase($this, $data);
588		}
589
590		return $this;
591		}
592
593
594		/**
595		* @param string $levelString
596		*
597		* @return int
598		* @throws MemberLevelException
599		*/
600	View Code Duplication	public static function parseLevelString(string $levelString): int {
		0 ignored issues – show Duplication introduced 2021-02-11 13:42 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...
601		$levelString = ucfirst(strtolower($levelString));
602		$level = array_search($levelString, Member::$DEF_LEVEL);
603
604		if (!$level) {
605		$all = implode(', ', array_values(self::$DEF_LEVEL));
606		throw new MemberLevelException('Available levels: ' . $all);
607		}
608
609		return (int)$level;
610		}
611
612		/**
613		* @param string $typeString
614		*
615		* @return int
616		* @throws UserTypeNotFoundException
617		*/
618	View Code Duplication	public static function parseTypeString(string $typeString): int {
		0 ignored issues – show Duplication introduced 2021-02-11 13:42 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...
619		$typeString = strtolower($typeString);
620		$type = array_search($typeString, Member::$DEF_TYPE);
621
622		if (!$type) {
623		$all = implode(', ', array_values(self::$DEF_TYPE));
624		throw new UserTypeNotFoundException('Available types: ' . $all);
625		}
626
627		return (int)$type;
628		}
629
630		}
631
632

nextcloud / circles