Wikibase\DataModel\Entity\EntityId

Complexity

Total Complexity

13

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
	getEntityType()	0	1	?
A	getSerialization()	0	3	1
A	splitSerialization()	0	8	2
A	joinSerialization()	0	3	1
A	getRepoName()	0	5	1
A	getLocalPart()	0	5	1
A	isForeign()	0	3	1
A	normalizeIdSerialization()	0	9	1
A	__toString()	0	3	1
A	equals()	0	8	3

<?php

namespace Wikibase\DataModel\Entity;

use Comparable;
use Serializable;

/**
 * @since 0.5
 * Constructor non-public since 1.0
 * Abstract since 2.0
 *
 * @license GPL-2.0+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
abstract class EntityId implements Comparable, Serializable {

	protected $serialization;

	/**
	 * @param $serialization
	 */
	protected function __construct( $serialization ) {
		$this->serialization = $serialization;
	}

	/**
	 * @return string
	 */
	public abstract function getEntityType();

	/**
	 * @return string
	 */
	public function getSerialization() {
		return $this->serialization;
	}

	/**
	 * Returns an array with 3 elements: the foreign repository name as the first element, the local ID as the last
	 * element and everything that is in between as the second element.
	 *
	 * @param $serialization
	 * @return array
	 */
	public static function splitSerialization( $serialization ) {
		$parts = explode( ':', $serialization );
		$localPart = array_pop( $parts );
		$repoName = array_shift( $parts ) ?: '';
		$prefixRemainder = implode( ':', $parts );

		return array( $repoName, $prefixRemainder, $localPart );
	}

	/**
	 * Concatenates parts of an EntityId serialization with ':'.
	 *
	 * @param array $parts
	 * @return string
	 */
	public static function joinSerialization( $parts ) {
		return implode( ':', array_filter( $parts ) );
	}

	/**
	 * Returns the foreign repository name or empty string for local entities.
	 * @return string
	 */
	public function getRepoName() {
		$parts = self::splitSerialization( $this->serialization );

		return $parts[0];
	}

	/**
	 * @return string
	 */
	public function getLocalPart() {
		$parts = self::splitSerialization( $this->serialization );

		return self::joinSerialization( array( '', $parts[1], $parts[2] ) );
	}

	/**
	 * @return bool
	 */
	public function isForeign() {
		return strpos( $this->serialization, ':' ) > 0;
	}

	protected static function normalizeIdSerialization( $id ) {
		$parts = self::splitSerialization( ltrim( $id, ':' ) );

		return self::joinSerialization( array(
			$parts[0],
			$parts[1],
			strtoupper( $parts[2] )
		) );
	}

	/**
	 * This is a human readable representation of the EntityId.
	 * This format is allowed to change and should therefore not
	 * be relied upon to be stable.
	 *
	 * @return string
	 */
	public function __toString() {
		return $this->serialization;
	}

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

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

}