Wikibase\DataModel\SiteLink

Complexity

Total Complexity

25

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

97.78%

Importance

Changes	2
Bugs	0	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	13	5
A	setBadges()	0	13	4
A	getSiteId()	0	3	1
A	getPageName()	0	3	1
A	getBadges()	0	3	1
B	equals()	0	10	5
A	hasFacet()	0	3	2
A	listFacets()	0	3	2
A	getFacet()	0	7	2
A	addFacet()	0	7	2

<?php

namespace Wikibase\DataModel;

use Comparable;
use InvalidArgumentException;
use Wikibase\DataModel\Entity\ItemId;
use Wikibase\DataModel\Entity\ItemIdSet;
use Wikibase\DataModel\Facet\FacetContainer;
use Wikibase\DataModel\Facet\NoSuchFacetException;
use Wikibase\DataModel\Internal\FacetManager;

/**
 * Immutable value object representing a link to a page on another site.
 *
 * A set of badges, represented as ItemId objects, acts as flags
 * describing attributes of the linked to page.
 *
 * @since 0.4
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 * @author Michał Łazowik
 * @author Thiemo Mättig
 * @author Daniel Kinzler
 */
class SiteLink implements Comparable, FacetContainer {

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

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

	/**
	 * @var ItemIdSet
	 */
	private $badges;

	/**
	 * @var FacetManager
	 */
	private $facetManager;

	/**
	 * @param string $siteId
	 * @param string $pageName
	 * @param ItemIdSet|ItemId[]|null $badges
	 *
	 * @throws InvalidArgumentException
	 */
	public function __construct( $siteId, $pageName, $badges = null ) {
		if ( !is_string( $siteId ) || $siteId === '' ) {
			throw new InvalidArgumentException( '$siteId must be a non-empty string' );
		}

		if ( !is_string( $pageName ) || $pageName === '' ) {
			throw new InvalidArgumentException( '$pageName must be a non-empty string' );
		}

		$this->siteId = $siteId;
		$this->pageName = $pageName;
		$this->setBadges( $badges );
	}

	/**
	 * @param ItemIdSet|ItemId[]|null $badges
	 *
	 * @throws InvalidArgumentException
	 */
	private function setBadges( $badges ) {
		if ( $badges === null ) {
			$badges = new ItemIdSet();
		} elseif ( is_array( $badges ) ) {
			$badges = new ItemIdSet( $badges );
		} elseif ( !( $badges instanceof ItemIdSet ) ) {
			throw new InvalidArgumentException(
				'$badges must be an instance of ItemIdSet, an array of instances of ItemId, or null'
			);
		}

		$this->badges = $badges;
	}

	/**
	 * @since 0.4
	 *
	 * @return string
	 */
	public function getSiteId() {
		return $this->siteId;
	}

	/**
	 * @since 0.4
	 *
	 * @return string
	 */
	public function getPageName() {
		return $this->pageName;
	}

	/**
	 * Badges are not order dependent.
	 *
	 * @since 0.5
	 *
	 * @return ItemId[]
	 */
	public function getBadges() {
		return array_values( iterator_to_array( $this->badges ) );
	}

	/**
	 * @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->siteId === $target->siteId
			&& $this->pageName === $target->pageName
			&& $this->badges->equals( $target->badges );
	}

	/**
	 * @param string $name
	 *
	 * @return boolean
	 */
	public function hasFacet( $name ) {
		return $this->facetManager && $this->facetManager->hasFacet( $name );
	}

	/**
	 * @return string[]
	 */
	public function listFacets() {
		return $this->facetManager ? $this->facetManager->listFacets() : array();
	}

	/**
	 * @param string $name
	 * @param string|null $type The desired type
	 *
	 * @return object
	 */
	public function getFacet( $name, $type = null ) {
		if ( !$this->facetManager ) {
			throw new NoSuchFacetException( $name );
		}

		return $this->facetManager->getFacet( $name, $type );
	}

	/**
	 * @param string $name
	 * @param object $facetObject
	 */
	public function addFacet( $name, $facetObject ) {
		if ( !$this->facetManager ) {
			$this->facetManager = new FacetManager();
		}

		$this->facetManager->addFacet( $name, $facetObject );
	}

}