Statement::getHash() - Code Metrics - Inspection of "Merge pull request #671 from wmde/entityIdJson2" - wmde/WikibaseDataModel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 403c11...effa40 )

by Daniel

created 2016-05-31 15:57 UTC

Statement::getHash() A

↳ Parent: Statement

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	1
cts	1
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	7
nc	1
nop	0
crap	1

<?php

namespace Wikibase\DataModel\Statement;

use Comparable;
use Hashable;
use InvalidArgumentException;
use Wikibase\DataModel\Entity\PropertyId;
use Wikibase\DataModel\PropertyIdProvider;
use Wikibase\DataModel\Reference;
use Wikibase\DataModel\ReferenceList;
use Wikibase\DataModel\Snak\Snak;
use Wikibase\DataModel\Snak\SnakList;

/**
 * Class representing a Wikibase statement.
 * See https://www.mediawiki.org/wiki/Wikibase/DataModel#Statements
 *
 * @since 0.1
 *
 * @license GPL-2.0+
 * @author Jeroen De Dauw < [email protected] >
 * @author Bene* < [email protected] >
 */
class Statement implements Hashable, Comparable, PropertyIdProvider {

	/**
	 * Rank enum. Higher values are more preferred.
	 *
	 * @since 2.0
	 */
	const RANK_PREFERRED = 2;
	const RANK_NORMAL = 1;
	const RANK_DEPRECATED = 0;

	/**
	 * @var string|null
	 */
	private $guid = null;

	/**
	 * @var Snak
	 */
	private $mainSnak;

	/**
	 * The property value snaks making up the qualifiers for this statement.
	 *
	 * @var SnakList
	 */
	private $qualifiers;

	/**
	 * @var ReferenceList
	 */
	private $references;

	/**
	 * @var integer, element of the Statement::RANK_ enum
	 */
	private $rank = self::RANK_NORMAL;

	/**
	 * @since 2.0
	 *
	 * @param Snak $mainSnak
	 * @param SnakList|null $qualifiers
	 * @param ReferenceList|null $references
	 * @param string|null $guid
	 */
	public function __construct(
		Snak $mainSnak,
		SnakList $qualifiers = null,
		ReferenceList $references = null,
		$guid = null
	) {
		$this->mainSnak = $mainSnak;
		$this->qualifiers = $qualifiers ?: new SnakList();
		$this->references = $references ?: new ReferenceList();
		$this->setGuid( $guid );
	}

	/**
	 * Returns the GUID of this statement.
	 *
	 * @since 0.2
	 *
	 * @return string|null
	 */
	public function getGuid() {
		return $this->guid;
	}

	/**
	 * Sets the GUID of this statement.
	 *
	 * @since 0.2
	 *
	 * @param string|null $guid
	 *
	 * @throws InvalidArgumentException
	 */
	public function setGuid( $guid ) {
		if ( !is_string( $guid ) && $guid !== null ) {
			throw new InvalidArgumentException( '$guid must be a string or null' );
		}

		$this->guid = $guid;
	}

	/**
	 * Returns the main value snak of this statement.
	 *
	 * @since 0.1
	 *
	 * @return Snak
	 */
	public function getMainSnak() {
		return $this->mainSnak;
	}

	/**
	 * Sets the main value snak of this statement.
	 *
	 * @since 0.1
	 *
	 * @param Snak $mainSnak
	 */
	public function setMainSnak( Snak $mainSnak ) {
		$this->mainSnak = $mainSnak;
	}

	/**
	 * Returns the property value snaks making up the qualifiers for this statement.
	 *
	 * @since 0.1
	 *
	 * @return SnakList
	 */
	public function getQualifiers() {
		return $this->qualifiers;
	}

	/**
	 * Sets the property value snaks making up the qualifiers for this statement.
	 *
	 * @since 0.1
	 *
	 * @param SnakList $propertySnaks
	 */
	public function setQualifiers( SnakList $propertySnaks ) {
		$this->qualifiers = $propertySnaks;
	}

	/**
	 * Returns the references attached to this statement.
	 *
	 * @since 0.1
	 *
	 * @return ReferenceList
	 */
	public function getReferences() {
		return $this->references;
	}

	/**
	 * Sets the references attached to this statement.
	 *
	 * @since 0.1
	 *
	 * @param ReferenceList $references
	 */
	public function setReferences( ReferenceList $references ) {
		$this->references = $references;
	}

	/**
	 * @since 2.0
	 *
	 * @param Snak[]|Snak $snaks
	 * @param Snak [$snak2,...]
	 *
	 * @throws InvalidArgumentException
	 */
	public function addNewReference( $snaks = array() /*...*/ ) {
		if ( $snaks instanceof Snak ) {
			$snaks = func_get_args();
		}

		$this->references->addNewReference( $snaks );
	}

	/**
	 * Sets the rank of the statement.
	 * The rank is an element of the Statement::RANK_ enum.
	 *
	 * @since 0.1
	 *
	 * @param integer $rank
	 * @throws InvalidArgumentException
	 */
	public function setRank( $rank ) {
		$ranks = array( self::RANK_DEPRECATED, self::RANK_NORMAL, self::RANK_PREFERRED );

		if ( !in_array( $rank, $ranks, true ) ) {
			throw new InvalidArgumentException( 'Invalid rank specified for statement: ' . var_export( $rank, true ) );
		}

		$this->rank = $rank;
	}

	/**
	 * @since 0.1
	 *
	 * @return integer
	 */
	public function getRank() {
		return $this->rank;
	}

	/**
	 * @see Hashable::getHash
	 *
	 * @since 0.1
	 *
	 * @return string
	 */
	public function getHash() {
		return sha1( implode(
			'|',
			array(
				sha1( $this->mainSnak->getHash() . $this->qualifiers->getHash() ),
				$this->rank,
				$this->references->getValueHash(),
			)
		) );
	}

	/**
	 * Returns the id of the property of the main snak.
	 * Short for ->getMainSnak()->getPropertyId()
	 *
	 * @see PropertyIdProvider::getPropertyId
	 *
	 * @since 0.2
	 *
	 * @return PropertyId
	 */
	public function getPropertyId() {
		return $this->getMainSnak()->getPropertyId();
	}

	/**
	 * Returns a list of all Snaks on this statement. This includes the main snak and all snaks
	 * from qualifiers and references.
	 *
	 * This is a convenience method for use in code that needs to operate on all snaks, e.g.
	 * to find all referenced Entities.
	 *
	 * @return Snak[]
	 */
	public function getAllSnaks() {
		$snaks = array( $this->mainSnak );

		foreach ( $this->qualifiers as $qualifier ) {
			$snaks[] = $qualifier;
		}

		/* @var Reference $reference */
		foreach ( $this->getReferences() as $reference ) {
			foreach ( $reference->getSnaks() as $referenceSnak ) {
				$snaks[] = $referenceSnak;
			}
		}

		return $snaks;
	}

	/**
	 * @see Comparable::equals
	 *
	 * @since 0.7.4
	 *
	 * @param mixed $target
	 *
	 * @return bool
	 */
	public function equals( $target ) {
		if ( $this === $target ) {
			return true;
		}

		return $target instanceof self
			&& $this->guid === $target->guid
			&& $this->rank === $target->rank
			&& $this->mainSnak->equals( $target->mainSnak )
			&& $this->qualifiers->equals( $target->qualifiers )
			&& $this->references->equals( $target->references );
	}

	/**
	 * @see http://php.net/manual/en/language.oop5.cloning.php
	 *
	 * @since 5.1
	 */
	public function __clone() {
		$this->qualifiers = clone $this->qualifiers;
		$this->references = clone $this->references;
	}

}


1		<?php
2
3		namespace Wikibase\DataModel\Statement;
4
5		use Comparable;
6		use Hashable;
7		use InvalidArgumentException;
8		use Wikibase\DataModel\Entity\PropertyId;
9		use Wikibase\DataModel\PropertyIdProvider;
10		use Wikibase\DataModel\Reference;
11		use Wikibase\DataModel\ReferenceList;
12		use Wikibase\DataModel\Snak\Snak;
13		use Wikibase\DataModel\Snak\SnakList;
14
15		/**
16		* Class representing a Wikibase statement.
17		* See https://www.mediawiki.org/wiki/Wikibase/DataModel#Statements
18		*
19		* @since 0.1
20		*
21		* @license GPL-2.0+
22		* @author Jeroen De Dauw < [email protected] >
23		* @author Bene* < [email protected] >
24		*/
25		class Statement implements Hashable, Comparable, PropertyIdProvider {
26
27		/**
28		* Rank enum. Higher values are more preferred.
29		*
30		* @since 2.0
31		*/
32		const RANK_PREFERRED = 2;
33		const RANK_NORMAL = 1;
34		const RANK_DEPRECATED = 0;
35
36		/**
37		* @var string\|null
38		*/
39		private $guid = null;
40
41		/**
42		* @var Snak
43		*/
44		private $mainSnak;
45
46		/**
47		* The property value snaks making up the qualifiers for this statement.
48		*
49		* @var SnakList
50		*/
51		private $qualifiers;
52
53		/**
54		* @var ReferenceList
55		*/
56		private $references;
57
58		/**
59		* @var integer, element of the Statement::RANK_ enum
60		*/
61		private $rank = self::RANK_NORMAL;
62
63		/**
64		* @since 2.0
65		*
66		* @param Snak $mainSnak
67		* @param SnakList\|null $qualifiers
68		* @param ReferenceList\|null $references
69		* @param string\|null $guid
70		*/
71		public function __construct(
72		Snak $mainSnak,
73		SnakList $qualifiers = null,
74		ReferenceList $references = null,
75		$guid = null
76		) {
77		$this->mainSnak = $mainSnak;
78		$this->qualifiers = $qualifiers ?: new SnakList();
79		$this->references = $references ?: new ReferenceList();
80	23	$this->setGuid( $guid );
81		}
82
83		/**
84		* Returns the GUID of this statement.
85		*
86	23	* @since 0.2
87	23	*
88	23	* @return string\|null
89	23	*/
90	19	public function getGuid() {
91		return $this->guid;
92		}
93
94		/**
95		* Sets the GUID of this statement.
96		*
97		* @since 0.2
98		*
99	11	* @param string\|null $guid
100	11	*
101		* @throws InvalidArgumentException
102		*/
103		public function setGuid( $guid ) {
104		if ( !is_string( $guid ) && $guid !== null ) {
105		throw new InvalidArgumentException( '$guid must be a string or null' );
106		}
107
108		$this->guid = $guid;
109		}
110
111		/**
112	31	* Returns the main value snak of this statement.
113	31	*
114	8	* @since 0.1
115		*
116		* @return Snak
117	27	*/
118	27	public function getMainSnak() {
119		return $this->mainSnak;
120		}
121
122		/**
123		* Sets the main value snak of this statement.
124		*
125		* @since 0.1
126		*
127	9	* @param Snak $mainSnak
128	9	*/
129		public function setMainSnak( Snak $mainSnak ) {
130		$this->mainSnak = $mainSnak;
131		}
132
133		/**
134		* Returns the property value snaks making up the qualifiers for this statement.
135		*
136		* @since 0.1
137		*
138		* @return SnakList
139		*/
140		public function getQualifiers() {
141		return $this->qualifiers;
142		}
143
144		/**
145		* Sets the property value snaks making up the qualifiers for this statement.
146		*
147		* @since 0.1
148		*
149	8	* @param SnakList $propertySnaks
150	8	*/
151		public function setQualifiers( SnakList $propertySnaks ) {
152		$this->qualifiers = $propertySnaks;
153		}
154
155		/**
156		* Returns the references attached to this statement.
157		*
158		* @since 0.1
159		*
160		* @return ReferenceList
161		*/
162		public function getReferences() {
163		return $this->references;
164		}
165
166		/**
167		* Sets the references attached to this statement.
168		*
169		* @since 0.1
170		*
171	23	* @param ReferenceList $references
172	23	*/
173		public function setReferences( ReferenceList $references ) {
174		$this->references = $references;
175		}
176
177		/**
178		* @since 2.0
179		*
180		* @param Snak[]\|Snak $snaks
181		* @param Snak [$snak2,...]
182	4	*
183	4	* @throws InvalidArgumentException
184	4	*/
185		public function addNewReference( $snaks = array() /.../ ) {
186		if ( $snaks instanceof Snak ) {
187		$snaks = func_get_args();
188		}
189
190		$this->references->addNewReference( $snaks );
191		}
192
193		/**
194	8	* Sets the rank of the statement.
195	8	* The rank is an element of the Statement::RANK_ enum.
196	4	*
197	4	* @since 0.1
198		*
199	8	* @param integer $rank
200	8	* @throws InvalidArgumentException
201		*/
202		public function setRank( $rank ) {
203		$ranks = array( self::RANK_DEPRECATED, self::RANK_NORMAL, self::RANK_PREFERRED );
204
205		if ( !in_array( $rank, $ranks, true ) ) {
206		throw new InvalidArgumentException( 'Invalid rank specified for statement: ' . var_export( $rank, true ) );
207		}
208
209		$this->rank = $rank;
210		}
211	9
212	9	/**
213		* @since 0.1
214	9	*
215	4	* @return integer
216		*/
217		public function getRank() {
218	5	return $this->rank;
219	5	}
220
221		/**
222		* @see Hashable::getHash
223		*
224		* @since 0.1
225		*
226	8	* @return string
227	8	*/
228		public function getHash() {
229		return sha1( implode(
230		'\|',
231		array(
232		sha1( $this->mainSnak->getHash() . $this->qualifiers->getHash() ),
233		$this->rank,
234		$this->references->getValueHash(),
235		)
236		) );
237	5	}
238	5
239	5	/**
240		* Returns the id of the property of the main snak.
241	5	* Short for ->getMainSnak()->getPropertyId()
242	5	*
243	5	* @see PropertyIdProvider::getPropertyId
244		*
245	5	* @since 0.2
246		*
247		* @return PropertyId
248		*/
249		public function getPropertyId() {
250		return $this->getMainSnak()->getPropertyId();
251		}
252
253		/**
254		* Returns a list of all Snaks on this statement. This includes the main snak and all snaks
255		* from qualifiers and references.
256		*
257		* This is a convenience method for use in code that needs to operate on all snaks, e.g.
258	4	* to find all referenced Entities.
259	4	*
260		* @return Snak[]
261		*/
262		public function getAllSnaks() {
263		$snaks = array( $this->mainSnak );
264
265		foreach ( $this->qualifiers as $qualifier ) {
266		$snaks[] = $qualifier;
267		}
268
269		/* @var Reference $reference */
270		foreach ( $this->getReferences() as $reference ) {
271	4	foreach ( $reference->getSnaks() as $referenceSnak ) {
272	4	$snaks[] = $referenceSnak;
273		}
274	4	}
275
276	4	return $snaks;
277		}
278
279	4	/**
280	1	* @see Comparable::equals
281	1	*
282	1	* @since 0.7.4
283	4	*
284		* @param mixed $target
285	4	*
286		* @return bool
287		*/
288		public function equals( $target ) {
289		if ( $this === $target ) {
290		return true;
291		}
292
293		return $target instanceof self
294		&& $this->guid === $target->guid
295		&& $this->rank === $target->rank
296		&& $this->mainSnak->equals( $target->mainSnak )
297	12	&& $this->qualifiers->equals( $target->qualifiers )
298	12	&& $this->references->equals( $target->references );
299	1	}
300
301		/**
302		* @see http://php.net/manual/en/language.oop5.cloning.php
303	12	*
304	12	* @since 5.1
305	12	*/
306	12	public function __clone() {
307	12	$this->qualifiers = clone $this->qualifiers;
308		$this->references = clone $this->references;
309		}
310
311		}
312

wmde / WikibaseDataModel

Push — master ( 403c11...effa40 )

Statement::getHash() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like