AliasGroupList::getByLanguage() - Code Metrics - Inspection of "Release 7.0.0" - wmde/WikibaseDataModel - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — release700 ( 3d89ac...a5293e )

by no

created 2017-03-07 15:35 UTC

AliasGroupList::getByLanguage() A

↳ Parent: AliasGroupList

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	1

<?php

namespace Wikibase\DataModel\Term;

use ArrayIterator;
use Countable;
use InvalidArgumentException;
use IteratorAggregate;
use OutOfBoundsException;
use Traversable;

/**
 * Unordered list of AliasGroup objects.
 * Only one group per language code. If multiple groups with the same language code
 * are provided, only the last one will be retained.
 *
 * Empty groups are not stored.
 *
 * @since 0.7.3
 *
 * @license GPL-2.0+
 * @author Jeroen De Dauw < [email protected] >
 */
class AliasGroupList implements Countable, IteratorAggregate {

	/**
	 * @var AliasGroup[]
	 */
	private $groups = [];

	/**
	 * @param AliasGroup[] $aliasGroups
	 * @throws InvalidArgumentException
	 */
	public function __construct( array $aliasGroups = [] ) {
		foreach ( $aliasGroups as $aliasGroup ) {
			if ( !( $aliasGroup instanceof AliasGroup ) ) {
				throw new InvalidArgumentException( 'Every element in $aliasGroups must be an instance of AliasGroup' );
			}

			$this->setGroup( $aliasGroup );
		}
	}

	/**
	 * @see Countable::count
	 * @return int
	 */
	public function count() {
		return count( $this->groups );
	}

	/**
	 * @see IteratorAggregate::getIterator
	 * @return Traversable|AliasGroup[]
	 */
	public function getIterator() {
		return new ArrayIterator( $this->groups );
	}

	/**
	 * The array keys are the language codes of their associated AliasGroup.
	 *
	 * @since 2.3
	 *
	 * @return AliasGroup[] Array indexed by language code.
	 */
	public function toArray() {
		return $this->groups;
	}

	/**
	 * @param string $languageCode
	 *
	 * @return AliasGroup
	 * @throws OutOfBoundsException
	 */
	public function getByLanguage( $languageCode ) {
		if ( !array_key_exists( $languageCode, $this->groups ) ) {
			throw new OutOfBoundsException( 'AliasGroup with languageCode "' . $languageCode . '" not found' );
		}

		return $this->groups[$languageCode];
	}

	/**
	 * @since 2.5
	 *
	 * @param string[] $languageCodes
	 *
	 * @return self
	 */
	public function getWithLanguages( array $languageCodes ) {
		return new self( array_intersect_key( $this->groups, array_flip( $languageCodes ) ) );
	}

	/**
	 * @param string $languageCode
	 */
	public function removeByLanguage( $languageCode ) {
		unset( $this->groups[$languageCode] );
	}

	/**
	 * If the group is empty, it will not be stored.
	 * In case the language of that group had an associated group, that group will be removed.
	 *
	 * @param AliasGroup $group
	 */
	public function setGroup( AliasGroup $group ) {
		if ( $group->isEmpty() ) {
			unset( $this->groups[$group->getLanguageCode()] );
		}
		else {
			$this->groups[$group->getLanguageCode()] = $group;
		}
	}

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

		if ( !( $target instanceof self )
			|| $this->count() !== $target->count()
		) {
			return false;
		}

		foreach ( $this->groups as $group ) {
			if ( !$target->hasAliasGroup( $group ) ) {
				return false;
			}
		}

		return true;
	}

	/**
	 * @since 2.4.0
	 *
	 * @return bool
	 */
	public function isEmpty() {
		return empty( $this->groups );
	}

	/**
	 * @since 0.7.4
	 *
	 * @param AliasGroup $group
	 *
	 * @return boolean
	 */
	public function hasAliasGroup( AliasGroup $group ) {
		return array_key_exists( $group->getLanguageCode(), $this->groups )
			&& $this->groups[$group->getLanguageCode()]->equals( $group );
	}

	/**
	 * @since 0.8
	 *
	 * @param string $languageCode
	 *
	 * @return boolean
	 */
	public function hasGroupForLanguage( $languageCode ) {
		return array_key_exists( $languageCode, $this->groups );
	}

	/**
	 * @since 0.8
	 *
	 * @param string $languageCode
	 * @param string[] $aliases
	 */
	public function setAliasesForLanguage( $languageCode, array $aliases ) {
		$this->setGroup( new AliasGroup( $languageCode, $aliases ) );
	}

	/**
	 * Returns an array with language codes as keys the aliases as array values.
	 *
	 * @since 2.5
	 *
	 * @return array[]
	 */
	public function toTextArray() {
		$array = [];

		foreach ( $this->groups as $group ) {
			$array[$group->getLanguageCode()] = $group->getAliases();
		}

		return $array;
	}

	/**
	 * Removes all alias groups from this list.
	 *
	 * @since 7.0
	 */
	public function clear() {
		$this->groups = [];
	}

}


1			<?php
2
3			namespace Wikibase\DataModel\Term;
4
5			use ArrayIterator;
6			use Countable;
7			use InvalidArgumentException;
8			use IteratorAggregate;
9			use OutOfBoundsException;
10			use Traversable;
11
12			/**
13			* Unordered list of AliasGroup objects.
14			* Only one group per language code. If multiple groups with the same language code
15			* are provided, only the last one will be retained.
16			*
17			* Empty groups are not stored.
18			*
19			* @since 0.7.3
20			*
21			* @license GPL-2.0+
22			* @author Jeroen De Dauw < [email protected] >
23			*/
24			class AliasGroupList implements Countable, IteratorAggregate {
25
26			/**
27			* @var AliasGroup[]
28			*/
29			private $groups = [];
30
31			/**
32			* @param AliasGroup[] $aliasGroups
33			* @throws InvalidArgumentException
34			*/
35			public function __construct( array $aliasGroups = [] ) {
36			foreach ( $aliasGroups as $aliasGroup ) {
37			if ( !( $aliasGroup instanceof AliasGroup ) ) {
38			throw new InvalidArgumentException( 'Every element in $aliasGroups must be an instance of AliasGroup' );
39			}
40
41			$this->setGroup( $aliasGroup );
42			}
43			}
44
45			/**
46			* @see Countable::count
47			* @return int
48			*/
49			public function count() {
50			return count( $this->groups );
51			}
52
53			/**
54			* @see IteratorAggregate::getIterator
55			* @return Traversable\|AliasGroup[]
56			*/
57			public function getIterator() {
58			return new ArrayIterator( $this->groups );
59			}
60
61			/**
62			* The array keys are the language codes of their associated AliasGroup.
63			*
64			* @since 2.3
65			*
66			* @return AliasGroup[] Array indexed by language code.
67			*/
68			public function toArray() {
69			return $this->groups;
70			}
71
72			/**
73			* @param string $languageCode
74			*
75			* @return AliasGroup
76			* @throws OutOfBoundsException
77			*/
78			public function getByLanguage( $languageCode ) {
79			if ( !array_key_exists( $languageCode, $this->groups ) ) {
80			throw new OutOfBoundsException( 'AliasGroup with languageCode "' . $languageCode . '" not found' );
81			}
82
83			return $this->groups[$languageCode];
84			}
85
86			/**
87			* @since 2.5
88			*
89			* @param string[] $languageCodes
90			*
91			* @return self
92			*/
93			public function getWithLanguages( array $languageCodes ) {
94			return new self( array_intersect_key( $this->groups, array_flip( $languageCodes ) ) );
95			}
96
97			/**
98			* @param string $languageCode
99			*/
100			public function removeByLanguage( $languageCode ) {
101			unset( $this->groups[$languageCode] );
102			}
103
104			/**
105			* If the group is empty, it will not be stored.
106			* In case the language of that group had an associated group, that group will be removed.
107			*
108			* @param AliasGroup $group
109			*/
110			public function setGroup( AliasGroup $group ) {
111			if ( $group->isEmpty() ) {
112			unset( $this->groups[$group->getLanguageCode()] );
113			}
114			else {
115			$this->groups[$group->getLanguageCode()] = $group;
116			}
117			}
118
119			/**
120			* @see Comparable::equals
121			*
122			* @since 0.7.4
123			*
124			* @param mixed $target
125			*
126			* @return bool
127			*/
128			public function equals( $target ) {
129			if ( $this === $target ) {
130			return true;
131			}
132
133			if ( !( $target instanceof self )
134			\|\| $this->count() !== $target->count()
135			) {
136			return false;
137			}
138
139			foreach ( $this->groups as $group ) {
140			if ( !$target->hasAliasGroup( $group ) ) {
141			return false;
142			}
143			}
144
145			return true;
146			}
147
148			/**
149			* @since 2.4.0
150			*
151			* @return bool
152			*/
153			public function isEmpty() {
154			return empty( $this->groups );
155			}
156
157			/**
158			* @since 0.7.4
159			*
160			* @param AliasGroup $group
161			*
162			* @return boolean
163			*/
164			public function hasAliasGroup( AliasGroup $group ) {
165			return array_key_exists( $group->getLanguageCode(), $this->groups )
166			&& $this->groups[$group->getLanguageCode()]->equals( $group );
167			}
168
169			/**
170			* @since 0.8
171			*
172			* @param string $languageCode
173			*
174			* @return boolean
175			*/
176			public function hasGroupForLanguage( $languageCode ) {
177			return array_key_exists( $languageCode, $this->groups );
178			}
179
180			/**
181			* @since 0.8
182			*
183			* @param string $languageCode
184			* @param string[] $aliases
185			*/
186			public function setAliasesForLanguage( $languageCode, array $aliases ) {
187			$this->setGroup( new AliasGroup( $languageCode, $aliases ) );
188			}
189
190			/**
191			* Returns an array with language codes as keys the aliases as array values.
192			*
193			* @since 2.5
194			*
195			* @return array[]
196			*/
197			public function toTextArray() {
198			$array = [];
199
200			foreach ( $this->groups as $group ) {
201			$array[$group->getLanguageCode()] = $group->getAliases();
202			}
203
204			return $array;
205			}
206
207			/**
208			* Removes all alias groups from this list.
209			*
210			* @since 7.0
211			*/
212			public function clear() {
213			$this->groups = [];
214			}
215
216			}
217

wmde / WikibaseDataModel

Push — release700 ( 3d89ac...a5293e )

AliasGroupList::getByLanguage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like