SharingFrame - Code Metrics - Inspection of "renaming circles" - nextcloud/circles - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#106)

by Maxence

created 2017-08-01 16:36 UTC

SharingFrame B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	314
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
wmc	40
c	2
b	0
f	1
lcom	1
cbo	1
dl	0
loc	314
rs	8.2608

28 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	getSource()	3	1
A	getType()	3	1
A	setCircleId()	3	1
A	getCircleId()	3	1
A	setCircleName()	3	1
A	getCircleName()	3	1
A	setCircleType()	3	1
A	getCircleType()	3	1
A	setAuthor()	3	1
A	getAuthor()	3	1
A	setCloudId()	3	1
A	getCloudId()	3	1
A	setUniqueId()	5	1
A	getUniqueId()	3	1
A	generateUniqueId()	6	1
A	setPayload()	3	1
A	getPayload()	7	2
A	setHeaders()	3	1
A	getHeaders()	7	2
A	getHeader()	12	3
A	setHeader()	3	1
A	setCreation()	7	2
A	getCreation()	3	1
A	isLocal()	3	1
A	cannotBeFromCircles()	5	2
A	jsonSerialize()	15	1
C	fromJSON()	32	7

How to fix Complexity

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

use OCA\Circles\Exceptions\SharingFrameSourceCannotBeAppCirclesException;

class SharingFrame implements \JsonSerializable {

	/** @var string */
	private $source;

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

	/** @var int */
	private $circleUniqueId;

	/** @var string */
	private $circleName;

	/** @var int */
	private $circleType;

	/** @var string */
	private $author;

	/** @var string */
	private $cloudId;

	/** @var array */
	private $payload;

	/** @var array */
	private $headers;

	/** @var int */
	private $creation;

	/** @var string */
	private $uniqueId;

	public function __construct($source, $type) {
		$this->source = (string)$source;
		$this->type = (string)$type;
	}


	/**
	 * @return string
	 */
	public function getSource() {
		return $this->source;
	}

	/**
	 * @return string
	 */
	public function getType() {
		return $this->type;
	}

	/**
	 * @param string $circleUniqueId
	 */
	public function setCircleId($circleUniqueId) {
		$this->circleUniqueId = $circleUniqueId;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
	}

	/**
	 * @return string

	 */
	public function getCircleId() {
		return $this->circleUniqueId;
	}


	/**
	 * @param string $circleName
	 */
	public function setCircleName($circleName) {
		$this->circleName = $circleName;
	}

	/**
	 * @return string
	 */
	public function getCircleName() {
		return $this->circleName;
	}


	/**
	 * @param int $circleType
	 */
	public function setCircleType($circleType) {
		$this->circleType = $circleType;
	}

	/**
	 * @return int
	 */
	public function getCircleType() {
		return $this->circleType;
	}


	/**
	 * @param string $author
	 */
	public function setAuthor($author) {
		$this->author = (string)$author;
	}

	/**
	 * @return string
	 */
	public function getAuthor() {
		return $this->author;
	}


	/**
	 * @param string $cloudId
	 */
	public function setCloudId($cloudId) {
		$this->cloudId = $cloudId;
	}

	/**
	 * @return string
	 */
	public function getCloudId() {
		return $this->cloudId;
	}


	/**
	 * @param string $uniqueId
	 *
	 * @return SharingFrame
	 */
	public function setUniqueId($uniqueId) {
		$this->uniqueId = (string)$uniqueId;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getUniqueId() {
		return $this->uniqueId;
	}

	/**
	 * @return SharingFrame
	 */
	public function generateUniqueId() {
		$uniqueId = bin2hex(openssl_random_pseudo_bytes(16));
		$this->setUniqueId($uniqueId);

		return $this;
	}

	/**
	 * @param array $payload
	 */
	public function setPayload($payload) {
		$this->payload = $payload;
	}

	/**
	 * @param bool $asJson
	 *
	 * @return array|string
	 */
	public function getPayload($asJson = false) {
		if ($asJson) {
			return json_encode($this->payload);
		}

		return $this->payload;
	}


	/**
	 * @param array $headers
	 */
	public function setHeaders($headers) {
		$this->headers = $headers;
	}

	/**
	 * @param bool $asJson
	 *
	 * @return array|string
	 */
	public function getHeaders($asJson = false) {
		if ($asJson) {
			return json_encode($this->headers);
		}

		return $this->headers;
	}


	/**
	 * @param string $k
	 *
	 * @return string
	 */
	public function getHeader($k) {
		if ($this->headers === null) {
			return null;
		}

		$k = (string)$k;
		if (!key_exists($k, $this->headers)) {
			return null;
		}

		return $this->headers[$k];
	}

	/**
	 * @param string $k
	 * @param string $v
	 */
	public function setHeader($k, $v) {
		$this->headers[(string)$k] = $v;
	}


	/**
	 * @param int $creation
	 */
	public function setCreation($creation) {
		if ($creation === null) {
			return;
		}

		$this->creation = $creation;
	}

	/**
	 * @return int
	 */
	public function getCreation() {
		return $this->creation;
	}


	/**
	 * @return bool
	 */
	public function isLocal() {
		return ($this->getCloudId() === null);
	}


	/**
	 * @throws SharingFrameSourceCannotBeAppCirclesException
	 */
	public function cannotBeFromCircles() {
		if (strtolower($this->getSource()) === 'circles') {
			throw new SharingFrameSourceCannotBeAppCirclesException();
		}
	}


	public function jsonSerialize() {
		return array(
			'circle_id'   => $this->getCircleId(),
			'circle_name' => $this->getCircleName(),
			'circle_type' => $this->getCircleType(),
			'unique_id'   => $this->getUniqueId(),
			'source'      => $this->getSource(),
			'type'        => $this->getType(),
			'author'      => $this->getAuthor(),
			'cloud_id'    => $this->getCloudId(),
			'headers'     => $this->getHeaders(),
			'payload'     => $this->getPayload(),
			'creation'    => $this->getCreation(),
		);
	}

	public static function fromJSON($json) {

		$arr = json_decode($json, true);
		if (!is_array($arr) || !key_exists('source', $arr)) {
			return null;
		}

		$share = new SharingFrame($arr['source'], $arr['type']);
		$share->setCircleId($arr['circle_id']);
		if (key_exists('circle_name', $arr)) {
			$share->setCircleName($arr['circle_name']);
		}
		if (key_exists('circle_type', $arr)) {
			$share->setCircleType($arr['circle_type']);
		}


		if (key_exists('headers', $arr)) {
			$share->setHeaders($arr['headers']);
		}

		if (key_exists('cloud_id', $arr)) {
			$share->setCloudID($arr['cloud_id']);
		}

		$share->setUniqueId($arr['unique_id']);
		$share->setAuthor($arr['author']);
		$share->setPayload($arr['payload']);
		$share->setCreation($arr['creation']);

		return $share;
	}

}



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\Model;
28
29			use OCA\Circles\Exceptions\SharingFrameSourceCannotBeAppCirclesException;
30
31			class SharingFrame implements \JsonSerializable {
32
33			/** @var string */
34			private $source;
35
36			/** @var string */
37			private $type;
38
39			/** @var int */
40			private $circleUniqueId;
41
42			/** @var string */
43			private $circleName;
44
45			/** @var int */
46			private $circleType;
47
48			/** @var string */
49			private $author;
50
51			/** @var string */
52			private $cloudId;
53
54			/** @var array */
55			private $payload;
56
57			/** @var array */
58			private $headers;
59
60			/** @var int */
61			private $creation;
62
63			/** @var string */
64			private $uniqueId;
65
66			public function __construct($source, $type) {
67			$this->source = (string)$source;
68			$this->type = (string)$type;
69			}
70
71
72			/**
73			* @return string
74			*/
75			public function getSource() {
76			return $this->source;
77			}
78
79			/**
80			* @return string
81			*/
82			public function getType() {
83			return $this->type;
84			}
85
86			/**
87			* @param string $circleUniqueId
88			*/
89			public function setCircleId($circleUniqueId) {
90			$this->circleUniqueId = $circleUniqueId;
			0 ignored issues – show Documentation Bug introduced 2017-07-28 02:28 UTC by Report Bug Copy Issue Report The property `$circleUniqueId` was declared of type `integer`, but `$circleUniqueId` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
91			}
92
93			/**
94			* @return string
			0 ignored issues – show Documentation introduced 2017-07-28 02:28 UTC by Report Bug Copy Issue Report Should the return type not be `integer`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
95			*/
96			public function getCircleId() {
97			return $this->circleUniqueId;
98			}
99
100
101			/**
102			* @param string $circleName
103			*/
104			public function setCircleName($circleName) {
105			$this->circleName = $circleName;
106			}
107
108			/**
109			* @return string
110			*/
111			public function getCircleName() {
112			return $this->circleName;
113			}
114
115
116			/**
117			* @param int $circleType
118			*/
119			public function setCircleType($circleType) {
120			$this->circleType = $circleType;
121			}
122
123			/**
124			* @return int
125			*/
126			public function getCircleType() {
127			return $this->circleType;
128			}
129
130
131			/**
132			* @param string $author
133			*/
134			public function setAuthor($author) {
135			$this->author = (string)$author;
136			}
137
138			/**
139			* @return string
140			*/
141			public function getAuthor() {
142			return $this->author;
143			}
144
145
146			/**
147			* @param string $cloudId
148			*/
149			public function setCloudId($cloudId) {
150			$this->cloudId = $cloudId;
151			}
152
153			/**
154			* @return string
155			*/
156			public function getCloudId() {
157			return $this->cloudId;
158			}
159
160
161			/**
162			* @param string $uniqueId
163			*
164			* @return SharingFrame
165			*/
166			public function setUniqueId($uniqueId) {
167			$this->uniqueId = (string)$uniqueId;
168
169			return $this;
170			}
171
172			/**
173			* @return string
174			*/
175			public function getUniqueId() {
176			return $this->uniqueId;
177			}
178
179			/**
180			* @return SharingFrame
181			*/
182			public function generateUniqueId() {
183			$uniqueId = bin2hex(openssl_random_pseudo_bytes(16));
184			$this->setUniqueId($uniqueId);
185
186			return $this;
187			}
188
189			/**
190			* @param array $payload
191			*/
192			public function setPayload($payload) {
193			$this->payload = $payload;
194			}
195
196			/**
197			* @param bool $asJson
198			*
199			* @return array\|string
200			*/
201			public function getPayload($asJson = false) {
202			if ($asJson) {
203			return json_encode($this->payload);
204			}
205
206			return $this->payload;
207			}
208
209
210			/**
211			* @param array $headers
212			*/
213			public function setHeaders($headers) {
214			$this->headers = $headers;
215			}
216
217			/**
218			* @param bool $asJson
219			*
220			* @return array\|string
221			*/
222			public function getHeaders($asJson = false) {
223			if ($asJson) {
224			return json_encode($this->headers);
225			}
226
227			return $this->headers;
228			}
229
230
231			/**
232			* @param string $k
233			*
234			* @return string
235			*/
236			public function getHeader($k) {
237			if ($this->headers === null) {
238			return null;
239			}
240
241			$k = (string)$k;
242			if (!key_exists($k, $this->headers)) {
243			return null;
244			}
245
246			return $this->headers[$k];
247			}
248
249			/**
250			* @param string $k
251			* @param string $v
252			*/
253			public function setHeader($k, $v) {
254			$this->headers[(string)$k] = $v;
255			}
256
257
258			/**
259			* @param int $creation
260			*/
261			public function setCreation($creation) {
262			if ($creation === null) {
263			return;
264			}
265
266			$this->creation = $creation;
267			}
268
269			/**
270			* @return int
271			*/
272			public function getCreation() {
273			return $this->creation;
274			}
275
276
277			/**
278			* @return bool
279			*/
280			public function isLocal() {
281			return ($this->getCloudId() === null);
282			}
283
284
285			/**
286			* @throws SharingFrameSourceCannotBeAppCirclesException
287			*/
288			public function cannotBeFromCircles() {
289			if (strtolower($this->getSource()) === 'circles') {
290			throw new SharingFrameSourceCannotBeAppCirclesException();
291			}
292			}
293
294
295			public function jsonSerialize() {
296			return array(
297			'circle_id' => $this->getCircleId(),
298			'circle_name' => $this->getCircleName(),
299			'circle_type' => $this->getCircleType(),
300			'unique_id' => $this->getUniqueId(),
301			'source' => $this->getSource(),
302			'type' => $this->getType(),
303			'author' => $this->getAuthor(),
304			'cloud_id' => $this->getCloudId(),
305			'headers' => $this->getHeaders(),
306			'payload' => $this->getPayload(),
307			'creation' => $this->getCreation(),
308			);
309			}
310
311			public static function fromJSON($json) {
312
313			$arr = json_decode($json, true);
314			if (!is_array($arr) \|\| !key_exists('source', $arr)) {
315			return null;
316			}
317
318			$share = new SharingFrame($arr['source'], $arr['type']);
319			$share->setCircleId($arr['circle_id']);
320			if (key_exists('circle_name', $arr)) {
321			$share->setCircleName($arr['circle_name']);
322			}
323			if (key_exists('circle_type', $arr)) {
324			$share->setCircleType($arr['circle_type']);
325			}
326
327
328			if (key_exists('headers', $arr)) {
329			$share->setHeaders($arr['headers']);
330			}
331
332			if (key_exists('cloud_id', $arr)) {
333			$share->setCloudID($arr['cloud_id']);
334			}
335
336			$share->setUniqueId($arr['unique_id']);
337			$share->setAuthor($arr['author']);
338			$share->setPayload($arr['payload']);
339			$share->setCreation($arr['creation']);
340
341			return $share;
342			}
343
344			}
345
346

nextcloud / circles

Pull Request — master (#106)

SharingFrame B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

28 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like