UserGroupClass::getId() - Code Metrics - nextcloud/polls - Measure and Improve Code Quality continuously with Scrutinizer

UserGroupClass::getId() A
last analyzed 2021-05-08 21:01 UTC

↳ Parent: UserGroupClass

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

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

use OCA\Polls\Exceptions\InvalidShareTypeException;

use OCP\IL10N;
use OCP\Collaboration\Collaborators\ISearch;
use OCP\Share\IShare;
use OCA\Polls\AppInfo\Application;

class UserGroupClass implements \JsonSerializable {
	public const TYPE = 'generic';
	public const TYPE_PUBLIC = 'public';
	public const TYPE_EXTERNAL = 'external';
	public const TYPE_CIRCLE = Circle::TYPE;
	public const TYPE_CONTACT = Contact::TYPE;
	public const TYPE_CONTACTGROUP = ContactGroup::TYPE;
	public const TYPE_EMAIL = Email::TYPE;
	public const TYPE_GROUP = Group::TYPE;
	public const TYPE_USER = User::TYPE;

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

	/** @var string */
	protected $id;

	/** @var string */
	protected $type;

	/** @var string */
	protected $displayName = '';

	/** @var string */
	protected $description = '';

	/** @var string */
	protected $emailAddress = '';

	/** @var string */
	protected $language = '';

	/** @var string */
	protected $organisation = '';

	/** @var string */
	protected $icon = '';

	/** @var bool */
	protected $isNoUser = true;

	/** @var string[] */
	protected $categories = [];

	public function __construct(
		string $id,
		string $type,
		string $displayName = '',
		string $emailAddress = '',
		string $language = ''
	) {
		$this->id = $id;
		$this->type = $type;
		$this->displayName = $displayName;
		$this->emailAddress = $emailAddress;
		$this->language = $language;
		$this->icon = 'icon-share';
		$this->l10n = \OC::$server->getL10N('polls');
	}

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

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

	public function getUser(): string {
		return $this->id;
	}

	public function getType(): string {
		return $this->type;
	}

	public function getLanguage(): string {
		return $this->language;
	}

	public function getDisplayName(): string {
		return $this->displayName;
	}

	public function getDescription(): string {
		return $this->description;
	}

	public function getIcon(): string {
		return $this->icon;
	}

	public function getEmailAddress(): string {
		return $this->emailAddress;
	}

	public function getOrganisation(): string {
		return $this->organisation;
	}

	/**
	 * @return string[]
	 *
	 * @psalm-return array<array-key, string>
	 */
	public function getCategories(): array {
		return $this->categories;
	}

	public function getIsNoUser(): bool {
		return $this->isNoUser;
	}

	public function setType(string $type): string {
		$this->type = $type;
		return $this->type;
	}

	public function setDisplayName(string $displayName): string {
		$this->displayName = $displayName;
		return $this->displayName;
	}

	public function setDescription(string $description): string {
		$this->description = $description;
		return $this->description;
	}

	public function setEmailAddress(string $emailAddress) : string {
		$this->emailAddress = $emailAddress;
		return $this->emailAddress;
	}

	public function setLanguage(string $language): string {
		$this->language = $language;
		return $this->language;
	}

	public function setOrganisation(string $organisation): string {
		$this->organisation = $organisation;
		return $this->organisation;
	}

	/**
	 * search all possible sharees - use ISearch to respect autocomplete restrictions
	 */
	public static function search(string $query = ''): array {
		$items = [];
		$types = [
			IShare::TYPE_USER,
			IShare::TYPE_GROUP
		];
		if (Circle::isEnabled() && class_exists('\OCA\Circles\ShareByCircleProvider')) {
			$types[] = IShare::TYPE_CIRCLE;
		}

		[$result, $more] = self::getContainer()->query(ISearch::class)->search($query, $types, false, 200, 0);

		foreach ($result['users'] as $item) {
			$items[] = new User($item['value']['shareWith']);
		}

		foreach ($result['exact']['users'] as $item) {
			$items[] = new User($item['value']['shareWith']);
		}

		foreach ($result['groups'] as $item) {
			$items[] = new Group($item['value']['shareWith']);
		}

		foreach ($result['exact']['groups'] as $item) {
			$items[] = new Group($item['value']['shareWith']);
		}

		$items = array_merge($items, Contact::search($query));
		$items = array_merge($items, ContactGroup::search($query));

		if (Circle::isEnabled()) {
			foreach ($result['circles'] as $item) {
				$items[] = new Circle($item['value']['shareWith']);
			}
			foreach ($result['exact']['circles'] as $item) {
				$items[] = new Circle($item['value']['shareWith']);
			}
		}


		return $items;
	}

	/**
	 * @return array
	 */
	public function getMembers(): array {
		return [];
	}

	protected static function getContainer() {
		$app = \OC::$server->query(Application::class);

		return $app->getContainer();
	}

	/**
	 * @return Circle|Contact|ContactGroup|Email|GenericUser|Group|User
	 */
	public static function getUserGroupChild(string $type, string $id, string $displayName = '', string $emailAddress = '') {
		switch ($type) {
			case Group::TYPE:
				return new Group($id);
			case Circle::TYPE:
				return new Circle($id);
			case Contact::TYPE:
				return new Contact($id);
			case ContactGroup::TYPE:
				return new ContactGroup($id);
			case User::TYPE:
				return new User($id);
			case Email::TYPE:
				return new Email($id);
			case self::TYPE_PUBLIC:
				return new GenericUser($id, self::TYPE_PUBLIC);
			case self::TYPE_EXTERNAL:
				return new GenericUser($id, self::TYPE_EXTERNAL, $displayName, $emailAddress);
			default:
				throw new InvalidShareTypeException('Invalid share type (' . $type . ')');
			}
	}

	public function jsonSerialize(): array {
		return	[
			'id' => $this->getId(),
			'user' => $this->getId(),
			'userId' => $this->getId(),
			'type' => $this->getType(),
			'displayName' => $this->getDisplayName(),
			'organisation' => $this->getOrganisation(),
			'emailAddress' => $this->getEmailAddress(),
			'language' => $this->getLanguage(),
			'desc' => $this->getDescription(),
			'subtitle' => $this->getDescription(),
			'icon' => $this->getIcon(),
			'categories' => $this->getCategories(),
			'isNoUser' => $this->getIsNoUser(),
		];
	}
}


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\Model;
25
26			use OCA\Polls\Exceptions\InvalidShareTypeException;
27
28			use OCP\IL10N;
29			use OCP\Collaboration\Collaborators\ISearch;
30			use OCP\Share\IShare;
31			use OCA\Polls\AppInfo\Application;
32
33			class UserGroupClass implements \JsonSerializable {
34			public const TYPE = 'generic';
35			public const TYPE_PUBLIC = 'public';
36			public const TYPE_EXTERNAL = 'external';
37			public const TYPE_CIRCLE = Circle::TYPE;
38			public const TYPE_CONTACT = Contact::TYPE;
39			public const TYPE_CONTACTGROUP = ContactGroup::TYPE;
40			public const TYPE_EMAIL = Email::TYPE;
41			public const TYPE_GROUP = Group::TYPE;
42			public const TYPE_USER = User::TYPE;
43
44			/** @var IL10N */
45			private $l10n;
46
47			/** @var string */
48			protected $id;
49
50			/** @var string */
51			protected $type;
52
53			/** @var string */
54			protected $displayName = '';
55
56			/** @var string */
57			protected $description = '';
58
59			/** @var string */
60			protected $emailAddress = '';
61
62			/** @var string */
63			protected $language = '';
64
65			/** @var string */
66			protected $organisation = '';
67
68			/** @var string */
69			protected $icon = '';
70
71			/** @var bool */
72			protected $isNoUser = true;
73
74			/** @var string[] */
75			protected $categories = [];
76
77			public function __construct(
78			string $id,
79			string $type,
80			string $displayName = '',
81			string $emailAddress = '',
82			string $language = ''
83			) {
84			$this->id = $id;
85			$this->type = $type;
86			$this->displayName = $displayName;
87			$this->emailAddress = $emailAddress;
88			$this->language = $language;
89			$this->icon = 'icon-share';
90			$this->l10n = \OC::$server->getL10N('polls');
91			}
92
93			public function getId(): string {
94			return $this->id;
95			}
96
97			/**
98			* @return string
99			*/
100			public function getPublicId(): string {
101			return $this->id;
102			}
103
104			public function getUser(): string {
105			return $this->id;
106			}
107
108			public function getType(): string {
109			return $this->type;
110			}
111
112			public function getLanguage(): string {
113			return $this->language;
114			}
115
116			public function getDisplayName(): string {
117			return $this->displayName;
118			}
119
120			public function getDescription(): string {
121			return $this->description;
122			}
123
124			public function getIcon(): string {
125			return $this->icon;
126			}
127
128			public function getEmailAddress(): string {
129			return $this->emailAddress;
130			}
131
132			public function getOrganisation(): string {
133			return $this->organisation;
134			}
135
136			/**
137			* @return string[]
138			*
139			* @psalm-return array<array-key, string>
140			*/
141			public function getCategories(): array {
142			return $this->categories;
143			}
144
145			public function getIsNoUser(): bool {
146			return $this->isNoUser;
147			}
148
149			public function setType(string $type): string {
150			$this->type = $type;
151			return $this->type;
152			}
153
154			public function setDisplayName(string $displayName): string {
155			$this->displayName = $displayName;
156			return $this->displayName;
157			}
158
159			public function setDescription(string $description): string {
160			$this->description = $description;
161			return $this->description;
162			}
163
164			public function setEmailAddress(string $emailAddress) : string {
165			$this->emailAddress = $emailAddress;
166			return $this->emailAddress;
167			}
168
169			public function setLanguage(string $language): string {
170			$this->language = $language;
171			return $this->language;
172			}
173
174			public function setOrganisation(string $organisation): string {
175			$this->organisation = $organisation;
176			return $this->organisation;
177			}
178
179			/**
180			* search all possible sharees - use ISearch to respect autocomplete restrictions
181			*/
182			public static function search(string $query = ''): array {
183			$items = [];
184			$types = [
185			IShare::TYPE_USER,
186			IShare::TYPE_GROUP
187			];
188			if (Circle::isEnabled() && class_exists('\OCA\Circles\ShareByCircleProvider')) {
189			$types[] = IShare::TYPE_CIRCLE;
190			}
191
192			[$result, $more] = self::getContainer()->query(ISearch::class)->search($query, $types, false, 200, 0);
193
194			foreach ($result['users'] as $item) {
195			$items[] = new User($item['value']['shareWith']);
196			}
197
198			foreach ($result['exact']['users'] as $item) {
199			$items[] = new User($item['value']['shareWith']);
200			}
201
202			foreach ($result['groups'] as $item) {
203			$items[] = new Group($item['value']['shareWith']);
204			}
205
206			foreach ($result['exact']['groups'] as $item) {
207			$items[] = new Group($item['value']['shareWith']);
208			}
209
210			$items = array_merge($items, Contact::search($query));
211			$items = array_merge($items, ContactGroup::search($query));
212
213			if (Circle::isEnabled()) {
214			foreach ($result['circles'] as $item) {
215			$items[] = new Circle($item['value']['shareWith']);
216			}
217			foreach ($result['exact']['circles'] as $item) {
218			$items[] = new Circle($item['value']['shareWith']);
219			}
220			}
221
222
223			return $items;
224			}
225
226			/**
227			* @return array
228			*/
229			public function getMembers(): array {
230			return [];
231			}
232
233			protected static function getContainer() {
234			$app = \OC::$server->query(Application::class);
235
236			return $app->getContainer();
237			}
238
239			/**
240			* @return Circle\|Contact\|ContactGroup\|Email\|GenericUser\|Group\|User
241			*/
242			public static function getUserGroupChild(string $type, string $id, string $displayName = '', string $emailAddress = '') {
243			switch ($type) {
244			case Group::TYPE:
245			return new Group($id);
246			case Circle::TYPE:
247			return new Circle($id);
248			case Contact::TYPE:
249			return new Contact($id);
250			case ContactGroup::TYPE:
251			return new ContactGroup($id);
252			case User::TYPE:
253			return new User($id);
254			case Email::TYPE:
255			return new Email($id);
256			case self::TYPE_PUBLIC:
257			return new GenericUser($id, self::TYPE_PUBLIC);
258			case self::TYPE_EXTERNAL:
259			return new GenericUser($id, self::TYPE_EXTERNAL, $displayName, $emailAddress);
260			default:
261			throw new InvalidShareTypeException('Invalid share type (' . $type . ')');
262			}
263			}
264
265			public function jsonSerialize(): array {
266			return [
267			'id' => $this->getId(),
268			'user' => $this->getId(),
269			'userId' => $this->getId(),
270			'type' => $this->getType(),
271			'displayName' => $this->getDisplayName(),
272			'organisation' => $this->getOrganisation(),
273			'emailAddress' => $this->getEmailAddress(),
274			'language' => $this->getLanguage(),
275			'desc' => $this->getDescription(),
276			'subtitle' => $this->getDescription(),
277			'icon' => $this->getIcon(),
278			'categories' => $this->getCategories(),
279			'isNoUser' => $this->getIsNoUser(),
280			];
281			}
282			}
283

nextcloud / polls

UserGroupClass::getId() A last analyzed 2021-05-08 21:01 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

UserGroupClass::getId() A
last analyzed 2021-05-08 21:01 UTC