Wikibase\DataModel\Entity\ItemIdSet

Complexity

Total Complexity

10

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

96.15%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	3
A	count()	0	3	1
A	getIterator()	0	3	1
A	getSerializations()	0	10	1
A	has()	0	3	1
A	equals()	0	8	3

<?php

namespace Wikibase\DataModel\Entity;

use ArrayIterator;
use Countable;
use InvalidArgumentException;
use IteratorAggregate;

/**
 * Immutable set of ItemId objects. Unordered and unique.
 * The constructor filters out duplicates.
 *
 * @since 0.7.4
 *
 * @license GPL-2.0-or-later
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class ItemIdSet implements IteratorAggregate, Countable {

	/**
	 * @var ItemId[]
	 */
	private $ids = [];

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

			$this->ids[$id->getNumericId()] = $id;
		}
	}

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

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

	/**
	 * @since 2.5
	 *
	 * @return string[]
	 */
	public function getSerializations() {
		return array_values(
			array_map(
				function( ItemId $id ) {
					return $id->getSerialization();
				},
				$this->ids
			)
		);
	}

	/**
	 * @param ItemId $id
	 *
	 * @return bool
	 */
	public function has( ItemId $id ) {
		return array_key_exists( $id->getNumericId(), $this->ids );
	}

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

		return $target instanceof self
			&& $this->ids == $target->ids;
	}

}