Item::getLabels() - Code Metrics - Inspection of "Add interfaces to Item and Property" - wmde/WikibaseDataModel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#632)

by Bene

created 2016-02-16 19:34 UTC

Item::getLabels() A

↳ Parent: Item

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

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

<?php

namespace Wikibase\DataModel\Entity;

use InvalidArgumentException;
use OutOfBoundsException;
use Wikibase\DataModel\SiteLink;
use Wikibase\DataModel\SiteLinkList;
use Wikibase\DataModel\Statement\StatementList;
use Wikibase\DataModel\Statement\StatementListHolder;
use Wikibase\DataModel\Term\AliasesProvider;
use Wikibase\DataModel\Term\AliasGroupList;
use Wikibase\DataModel\Term\DescriptionsProvider;
use Wikibase\DataModel\Term\Fingerprint;
use Wikibase\DataModel\Term\FingerprintHolder;
use Wikibase\DataModel\Term\LabelsProvider;
use Wikibase\DataModel\Term\TermList;

/**
 * Represents a single Wikibase item.
 * See https://www.mediawiki.org/wiki/Wikibase/DataModel#Items
 *
 * @since 0.1
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 * @author Bene* < [email protected] >
 */
class Item implements EntityDocument, FingerprintHolder, StatementListHolder,
	LabelsProvider, DescriptionsProvider, AliasesProvider {

	const ENTITY_TYPE = 'item';

	/**
	 * @var ItemId|null
	 */
	private $id;

	/**
	 * @var Fingerprint
	 */
	private $fingerprint;

	/**
	 * @var SiteLinkList
	 */
	private $siteLinks;

	/**
	 * @var StatementList
	 */
	private $statements;

	/**
	 * @since 1.0
	 *
	 * @param ItemId|null $id
	 * @param Fingerprint|null $fingerprint
	 * @param SiteLinkList|null $siteLinks
	 * @param StatementList|null $statements
	 */
	public function __construct(
		ItemId $id = null,
		Fingerprint $fingerprint = null,
		SiteLinkList $siteLinks = null,
		StatementList $statements = null
	) {
		$this->id = $id;
		$this->fingerprint = $fingerprint ?: new Fingerprint();
		$this->siteLinks = $siteLinks ?: new SiteLinkList();
		$this->statements = $statements ?: new StatementList();
	}

	/**
	 * Returns the id of the entity or null if it does not have one.
	 *
	 * @since 0.1 return type changed in 0.3
	 *
	 * @return ItemId|null
	 */
	public function getId() {
		return $this->id;
	}

	/**
	 * Can be integer since 0.1.
	 * Can be ItemId since 0.5.
	 * Can be null since 1.0.
	 *
	 * @param ItemId|int|null $id
	 *
	 * @throws InvalidArgumentException
	 */
	public function setId( $id ) {
		if ( $id === null || $id instanceof ItemId ) {
			$this->id = $id;
		} elseif ( is_int( $id ) ) {
			$this->id = ItemId::newFromNumber( $id );
		} else {
			throw new InvalidArgumentException( '$id must be an instance of ItemId, an integer,'
				. ' or null' );
		}
	}

	/**
	 * @since 0.7.3
	 *
	 * @return Fingerprint
	 */
	public function getFingerprint() {
		return $this->fingerprint;
	}

	/**
	 * @since 0.7.3
	 *
	 * @param Fingerprint $fingerprint
	 */
	public function setFingerprint( Fingerprint $fingerprint ) {
		$this->fingerprint = $fingerprint;
	}

	/**
	 * @see LabelsProvider::getLabels
	 *
	 * @return TermList
	 */
	public function getLabels() {
		return $this->fingerprint->getLabels();
	}

	/**
	 * @see DescriptionsProvider::getDescriptions
	 *
	 * @return TermList
	 */
	public function getDescriptions() {
		return $this->fingerprint->getDescriptions();
	}

	/**
	 * @see AliasesProvider::getAliasGroups
	 *
	 * @return AliasGroupList
	 */
	public function getAliasGroups() {
		return $this->fingerprint->getAliasGroups();
	}

	/**
	 * @param string $languageCode
	 * @param string $value
	 *
	 * @throws InvalidArgumentException
	 */
	public function setLabel( $languageCode, $value ) {
		$this->fingerprint->setLabel( $languageCode, $value );
	}

	/**
	 * @param string $languageCode
	 * @param string $value
	 *
	 * @throws InvalidArgumentException
	 */
	public function setDescription( $languageCode, $value ) {
		$this->fingerprint->setDescription( $languageCode, $value );
	}

	/**
	 * @param string $languageCode
	 * @param string[] $aliases
	 *
	 * @throws InvalidArgumentException
	 */
	public function setAliases( $languageCode, array $aliases ) {
		$this->fingerprint->setAliasGroup( $languageCode, $aliases );
	}

	/**
	 * @since 0.8
	 *
	 * @return SiteLinkList
	 */
	public function getSiteLinkList() {
		return $this->siteLinks;
	}

	/**
	 * @since 0.8
	 *
	 * @param SiteLinkList $siteLinks
	 */
	public function setSiteLinkList( SiteLinkList $siteLinks ) {
		$this->siteLinks = $siteLinks;
	}

	/**
	 * Adds a site link to the list of site links.
	 * If there already is a site link with the site id of the provided site link,
	 * then that one will be overridden by the provided one.
	 *
	 * @deprecated since 0.8, use getSiteLinkList()->addSiteLink() instead.
	 * @since 0.6
	 *
	 * @param SiteLink $siteLink
	 */
	public function addSiteLink( SiteLink $siteLink ) {
		if ( $this->siteLinks->hasLinkWithSiteId( $siteLink->getSiteId() ) ) {
			$this->siteLinks->removeLinkWithSiteId( $siteLink->getSiteId() );
		}

		$this->siteLinks->addSiteLink( $siteLink );
	}

	/**
	 * Removes the sitelink with specified site ID if the Item has such a sitelink.
	 *
	 * @deprecated since 0.8, use getSiteLinkList()->removeLinkWithSiteId() instead.
	 * @since 0.1
	 *
	 * @param string $siteId the target site's id
	 */
	public function removeSiteLink( $siteId ) {
		$this->siteLinks->removeLinkWithSiteId( $siteId );
	}

	/**
	 * @deprecated since 0.8, use getSiteLinkList() instead,
	 * @since 0.6
	 *
	 * @return SiteLink[]
	 */
	public function getSiteLinks() {
		return array_values( iterator_to_array( $this->siteLinks ) );
	}

	/**
	 * @deprecated since 0.8, use getSiteLinkList()->getBySiteId() instead.
	 * @since 0.6
	 *
	 * @param string $siteId
	 *
	 * @return SiteLink
	 * @throws OutOfBoundsException
	 */
	public function getSiteLink( $siteId ) {
		return $this->siteLinks->getBySiteId( $siteId );
	}

	/**
	 * @deprecated since 0.8, use getSiteLinkList()->hasLinkWithSiteId() instead.
	 * @since 0.4
	 *
	 * @param string $siteId
	 *
	 * @return bool
	 */
	public function hasLinkToSite( $siteId ) {
		return $this->siteLinks->hasLinkWithSiteId( $siteId );
	}

	/**
	 * @deprecated since 0.8, use getSiteLinkList()->isEmpty() instead.
	 * @since 0.5
	 *
	 * @return bool
	 */
	public function hasSiteLinks() {
		return !$this->siteLinks->isEmpty();
	}

	/**
	 * @deprecated since 2.5, use new Item() instead.
	 *
	 * @return self
	 */
	public static function newEmpty() {
		return new self();
	}

	/**
	 * @see Entity::getType
	 *
	 * @since 0.1
	 *
	 * @return string Returns the entity type "item".
	 */
	public function getType() {
		return self::ENTITY_TYPE;
	}

	/**
	 * Returns if the Item has no content.
	 * Having an id set does not count as having content.
	 *
	 * @since 0.1
	 *
	 * @return bool
	 */
	public function isEmpty() {
		return $this->fingerprint->isEmpty()
			&& $this->statements->isEmpty()
			&& $this->siteLinks->isEmpty();
	}

	/**
	 * Removes all content from the Item.
	 * The id is not part of the content.
	 *
	 * @since 0.1
	 */
	public function clear() {
		$this->fingerprint = new Fingerprint();
		$this->siteLinks = new SiteLinkList();
		$this->statements = new StatementList();
	}

	/**
	 * @since 1.0
	 *
	 * @return StatementList
	 */
	public function getStatements() {
		return $this->statements;
	}

	/**
	 * @since 1.0
	 *
	 * @param StatementList $statements
	 */
	public function setStatements( StatementList $statements ) {
		$this->statements = $statements;
	}

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

		return $target instanceof self
			&& $this->fingerprint->equals( $target->fingerprint )
			&& $this->siteLinks->equals( $target->siteLinks )
			&& $this->statements->equals( $target->statements );
	}

	/**
	 * @see EntityDocument::copy
	 *
	 * @since 0.1
	 *
	 * @return self
	 */
	public function copy() {
		return unserialize( serialize( $this ) );
	}

}


1		<?php
2
3		namespace Wikibase\DataModel\Entity;
4
5		use InvalidArgumentException;
6		use OutOfBoundsException;
7		use Wikibase\DataModel\SiteLink;
8		use Wikibase\DataModel\SiteLinkList;
9		use Wikibase\DataModel\Statement\StatementList;
10		use Wikibase\DataModel\Statement\StatementListHolder;
11		use Wikibase\DataModel\Term\AliasesProvider;
12		use Wikibase\DataModel\Term\AliasGroupList;
13		use Wikibase\DataModel\Term\DescriptionsProvider;
14		use Wikibase\DataModel\Term\Fingerprint;
15		use Wikibase\DataModel\Term\FingerprintHolder;
16		use Wikibase\DataModel\Term\LabelsProvider;
17		use Wikibase\DataModel\Term\TermList;
18
19		/**
20		* Represents a single Wikibase item.
21		* See https://www.mediawiki.org/wiki/Wikibase/DataModel#Items
22		*
23		* @since 0.1
24		*
25		* @licence GNU GPL v2+
26		* @author Jeroen De Dauw < [email protected] >
27		* @author Bene* < [email protected] >
28		*/
29		class Item implements EntityDocument, FingerprintHolder, StatementListHolder,
30		LabelsProvider, DescriptionsProvider, AliasesProvider {
31
32		const ENTITY_TYPE = 'item';
33
34		/**
35		* @var ItemId\|null
36		*/
37		private $id;
38
39		/**
40		* @var Fingerprint
41		*/
42		private $fingerprint;
43
44		/**
45		* @var SiteLinkList
46		*/
47		private $siteLinks;
48
49		/**
50		* @var StatementList
51		*/
52		private $statements;
53
54		/**
55		* @since 1.0
56	81	*
57		* @param ItemId\|null $id
58		* @param Fingerprint\|null $fingerprint
59		* @param SiteLinkList\|null $siteLinks
60		* @param StatementList\|null $statements
61		*/
62	81	public function __construct(
63	81	ItemId $id = null,
64	81	Fingerprint $fingerprint = null,
65	81	SiteLinkList $siteLinks = null,
66	81	StatementList $statements = null
67		) {
68		$this->id = $id;
69		$this->fingerprint = $fingerprint ?: new Fingerprint();
70		$this->siteLinks = $siteLinks ?: new SiteLinkList();
71		$this->statements = $statements ?: new StatementList();
72		}
73
74		/**
75	12	* Returns the id of the entity or null if it does not have one.
76	12	*
77		* @since 0.1 return type changed in 0.3
78		*
79		* @return ItemId\|null
80		*/
81		public function getId() {
82		return $this->id;
83		}
84
85		/**
86		* Can be integer since 0.1.
87		* Can be ItemId since 0.5.
88	2	* Can be null since 1.0.
89	2	*
90	1	* @param ItemId\|int\|null $id
91	2	*
92	1	* @throws InvalidArgumentException
93	1	*/
94		public function setId( $id ) {
95		if ( $id === null \|\| $id instanceof ItemId ) {
96		$this->id = $id;
97	2	} elseif ( is_int( $id ) ) {
98		$this->id = ItemId::newFromNumber( $id );
99		} else {
100		throw new InvalidArgumentException( '$id must be an instance of ItemId, an integer,'
101		. ' or null' );
102		}
103		}
104	58
105	58	/**
106		* @since 0.7.3
107		*
108		* @return Fingerprint
109		*/
110		public function getFingerprint() {
111		return $this->fingerprint;
112		}
113	3
114	3	/**
115	3	* @since 0.7.3
116		*
117		* @param Fingerprint $fingerprint
118		*/
119		public function setFingerprint( Fingerprint $fingerprint ) {
120		$this->fingerprint = $fingerprint;
121		}
122
123	12	/**
124	12	* @see LabelsProvider::getLabels
125	12	*
126		* @return TermList
127		*/
128		public function getLabels() {
129		return $this->fingerprint->getLabels();
130		}
131
132		/**
133	11	* @see DescriptionsProvider::getDescriptions
134	11	*
135	11	* @return TermList
136		*/
137		public function getDescriptions() {
138		return $this->fingerprint->getDescriptions();
139		}
140
141		/**
142		* @see AliasesProvider::getAliasGroups
143	31	*
144	31	* @return AliasGroupList
145	31	*/
146		public function getAliasGroups() {
147		return $this->fingerprint->getAliasGroups();
148		}
149
150		/**
151		* @param string $languageCode
152	17	* @param string $value
153	17	*
154		* @throws InvalidArgumentException
155		*/
156		public function setLabel( $languageCode, $value ) {
157		$this->fingerprint->setLabel( $languageCode, $value );
158		}
159
160		/**
161		* @param string $languageCode
162		* @param string $value
163		*
164		* @throws InvalidArgumentException
165		*/
166		public function setDescription( $languageCode, $value ) {
167		$this->fingerprint->setDescription( $languageCode, $value );
168		}
169
170		/**
171		* @param string $languageCode
172		* @param string[] $aliases
173		*
174		* @throws InvalidArgumentException
175	1	*/
176	1	public function setAliases( $languageCode, array $aliases ) {
177	1	$this->fingerprint->setAliasGroup( $languageCode, $aliases );
178	1	}
179
180	1	/**
181	1	* @since 0.8
182		*
183		* @return SiteLinkList
184		*/
185		public function getSiteLinkList() {
186		return $this->siteLinks;
187		}
188
189		/**
190		* @since 0.8
191		*
192		* @param SiteLinkList $siteLinks
193		*/
194		public function setSiteLinkList( SiteLinkList $siteLinks ) {
195		$this->siteLinks = $siteLinks;
196		}
197
198		/**
199		* Adds a site link to the list of site links.
200		* If there already is a site link with the site id of the provided site link,
201	4	* then that one will be overridden by the provided one.
202	4	*
203		* @deprecated since 0.8, use getSiteLinkList()->addSiteLink() instead.
204		* @since 0.6
205		*
206		* @param SiteLink $siteLink
207		*/
208		public function addSiteLink( SiteLink $siteLink ) {
209		if ( $this->siteLinks->hasLinkWithSiteId( $siteLink->getSiteId() ) ) {
210		$this->siteLinks->removeLinkWithSiteId( $siteLink->getSiteId() );
211		}
212
213		$this->siteLinks->addSiteLink( $siteLink );
214		}
215
216		/**
217		* Removes the sitelink with specified site ID if the Item has such a sitelink.
218		*
219		* @deprecated since 0.8, use getSiteLinkList()->removeLinkWithSiteId() instead.
220		* @since 0.1
221		*
222		* @param string $siteId the target site's id
223		*/
224		public function removeSiteLink( $siteId ) {
225		$this->siteLinks->removeLinkWithSiteId( $siteId );
226		}
227
228		/**
229		* @deprecated since 0.8, use getSiteLinkList() instead,
230		* @since 0.6
231		*
232		* @return SiteLink[]
233		*/
234		public function getSiteLinks() {
235		return array_values( iterator_to_array( $this->siteLinks ) );
236		}
237
238		/**
239		* @deprecated since 0.8, use getSiteLinkList()->getBySiteId() instead.
240		* @since 0.6
241		*
242		* @param string $siteId
243		*
244		* @return SiteLink
245		* @throws OutOfBoundsException
246		*/
247		public function getSiteLink( $siteId ) {
248		return $this->siteLinks->getBySiteId( $siteId );
249		}
250
251		/**
252		* @deprecated since 0.8, use getSiteLinkList()->hasLinkWithSiteId() instead.
253		* @since 0.4
254		*
255		* @param string $siteId
256		*
257		* @return bool
258		*/
259		public function hasLinkToSite( $siteId ) {
260		return $this->siteLinks->hasLinkWithSiteId( $siteId );
261		}
262
263		/**
264		* @deprecated since 0.8, use getSiteLinkList()->isEmpty() instead.
265		* @since 0.5
266		*
267		* @return bool
268	3	*/
269	3	public function hasSiteLinks() {
270	3	return !$this->siteLinks->isEmpty();
271	3	}
272
273		/**
274		* @deprecated since 2.5, use new Item() instead.
275		*
276		* @return self
277		*/
278		public static function newEmpty() {
279		return new self();
280	2	}
281	2
282	2	/**
283	2	* @see Entity::getType
284	2	*
285		* @since 0.1
286		*
287		* @return string Returns the entity type "item".
288		*/
289		public function getType() {
290		return self::ENTITY_TYPE;
291	7	}
292	7
293		/**
294		* Returns if the Item has no content.
295		* Having an id set does not count as having content.
296		*
297		* @since 0.1
298		*
299		* @return bool
300	1	*/
301	1	public function isEmpty() {
302	1	return $this->fingerprint->isEmpty()
303		&& $this->statements->isEmpty()
304		&& $this->siteLinks->isEmpty();
305		}
306
307		/**
308		* Removes all content from the Item.
309	4	* The id is not part of the content.
310	4	*
311		* @since 0.1
312		*/
313		public function clear() {
314		$this->fingerprint = new Fingerprint();
315		$this->siteLinks = new SiteLinkList();
316		$this->statements = new StatementList();
317		}
318	1
319	1	/**
320	1	* @since 1.0
321		*
322		* @return StatementList
323		*/
324		public function getStatements() {
325		return $this->statements;
326		}
327
328		/**
329		* @since 1.0
330		*
331		* @param StatementList $statements
332		*/
333		public function setStatements( StatementList $statements ) {
334		$this->statements = $statements;
335		}
336	18
337	18	/**
338		* @see EntityDocument::equals
339		*
340		* @since 0.1
341		*
342	18	* @param mixed $target
343	18	*
344	18	* @return bool
345		*/
346		public function equals( $target ) {
347		if ( $this === $target ) {
348		return true;
349		}
350
351		return $target instanceof self
352		&& $this->fingerprint->equals( $target->fingerprint )
353		&& $this->siteLinks->equals( $target->siteLinks )
354		&& $this->statements->equals( $target->statements );
355		}
356
357		/**
358		* @see EntityDocument::copy
359		*
360		* @since 0.1
361		*
362		* @return self
363		*/
364		public function copy() {
365		return unserialize( serialize( $this ) );
366		}
367
368		}
369

wmde / WikibaseDataModel

Pull Request — master (#632)

Item::getLabels() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like