Frame::setCircleId() - Code Metrics - Inspection of "initiating the payload delivery" - nextcloud/circles - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — federated-circles ( 92a91f...545292 )

by Maxence

created 2017-05-19 22:27 UTC

Frame::setCircleId() A

↳ Parent: Frame

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
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\Model;

class Frame implements \JsonSerializable {

	private $source;
	private $type;

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

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

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

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

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

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

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

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


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

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

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

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


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

	/**
	 * @return mixed

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


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

		if ($this->getSharer() === null) {
			$this->setSharer($author);
		}
	}

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


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

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


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

		return $this;
	}

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

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

		return $this;
	}

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

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

		return $this->payload;
	}


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

		$this->creation = $creation;
	}

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


	public function jsonSerialize() {
		return array(
			'circle_id'   => $this->getCircleId(),
			'circle_name' => $this->getCircleName(),
			'source'      => $this->getSource(),
			'type'        => $this->getType(),
			'author'      => $this->getAuthor(),
			'sharer'      => $this->getSharer(),
			'payload'     => $this->getPayload(),
			'creation'    => $this->getCreation(),
		);
	}

	public static function fromJSON($json) {

		$arr = json_decode($json, true);

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

		$share->setAuthor($arr['author']);
		$share->setSharer($arr['sharer']);
		$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			class Frame implements \JsonSerializable {
30
31			private $source;
32			private $type;
33
34			/** @var int */
35			private $circleId;
36
37			/** @var string */
38			private $circleName;
39
40			/** @var string */
41			private $author;
42
43			/** @var string */
44			private $sharer;
45
46			/** @var array */
47			private $payload;
48
49			/** @var int */
50			private $creation;
51
52			/** @var string */
53			private $uniqueId;
54
55			public function __construct(string $source, string $type) {
56			$this->source = $source;
57			$this->type = $type;
58			}
59
60
61			/**
62			* @return string
63			*/
64			public function getSource() {
65			return $this->source;
66			}
67
68			/**
69			* @return string
70			*/
71			public function getType() {
72			return $this->type;
73			}
74
75			/**
76			* @param int $circleId
77			*/
78			public function setCircleId(int $circleId) {
79			$this->circleId = $circleId;
80			}
81
82			/**
83			* @return int
84			*/
85			public function getCircleId() {
86			return $this->circleId;
87			}
88
89
90			/**
91			* @param string $circleName
92			*/
93			public function setCircleName(string $circleName) {
94			$this->circleName = $circleName;
95			}
96
97			/**
98			* @return mixed
			0 ignored issues – show Documentation introduced 2017-05-05 19:36 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `string`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
99			*/
100			public function getCircleName() {
101			return $this->circleName;
102			}
103
104
105			/**
106			* @param string $author
107			*/
108			public function setAuthor(string $author) {
109			$this->author = $author;
110
111			if ($this->getSharer() === null) {
112			$this->setSharer($author);
113			}
114			}
115
116			/**
117			* @return string
118			*/
119			public function getAuthor() {
120			return $this->author;
121			}
122
123
124			/**
125			* @param string $sharer
126			*/
127			public function setSharer(string $sharer) {
128			$this->sharer = $sharer;
129			}
130
131			/**
132			* @return string
133			*/
134			public function getSharer() {
135			return $this->sharer;
136			}
137
138
139			/**
140			* @param string $uniqueId
141			*
142			* @return Frame
143			*/
144			public function setUniqueId(string $uniqueId) {
145			$this->uniqueId = $uniqueId;
146
147			return $this;
148			}
149
150			/**
151			* @return string
152			*/
153			public function getUniqueId() {
154			return $this->uniqueId;
155			}
156
157			/**
158			* @return Frame
159			*/
160			public function generateUniqueId() {
161			$uniqueId = bin2hex(openssl_random_pseudo_bytes(16));
162			$this->setUniqueId($uniqueId);
163
164			return $this;
165			}
166
167			/**
168			* @param array $payload
169			*/
170			public function setPayload(array $payload) {
171			$this->payload = $payload;
172			}
173
174			/**
175			* @param bool $asJson
176			*
177			* @return array\|string
178			*/
179			public function getPayload(bool $asJson = false) {
180			if ($asJson) {
181			return json_encode($this->payload);
182			}
183
184			return $this->payload;
185			}
186
187
188			/**
189			* @param int $creation
190			*/
191			public function setCreation($creation) {
192			if ($creation === null) {
193			return;
194			}
195
196			$this->creation = $creation;
197			}
198
199			/**
200			* @return int
201			*/
202			public function getCreation() {
203			return $this->creation;
204			}
205
206
207			public function jsonSerialize() {
208			return array(
209			'circle_id' => $this->getCircleId(),
210			'circle_name' => $this->getCircleName(),
211			'source' => $this->getSource(),
212			'type' => $this->getType(),
213			'author' => $this->getAuthor(),
214			'sharer' => $this->getSharer(),
215			'payload' => $this->getPayload(),
216			'creation' => $this->getCreation(),
217			);
218			}
219
220			public static function fromJSON($json) {
221
222			$arr = json_decode($json, true);
223
224			$share = new Frame($arr['source'], $arr['type']);
225			$share->setCircleId($arr['circle_id']);
226			if (key_exists('circle_name', $arr)) {
227			$share->setCircleName($arr['circle_name']);
228			}
229
230			$share->setAuthor($arr['author']);
231			$share->setSharer($arr['sharer']);
232			$share->setPayload($arr['payload']);
233			$share->setCreation($arr['creation']);
234
235			return $share;
236			}
237
238			}

nextcloud / circles

Push — federated-circles ( 92a91f...545292 )

Frame::setCircleId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like