DataValues\IriValue

Complexity

Total Complexity

25

Size/Duplication

Total Lines	249
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	20	6
A	serialize()	0	3	1
A	unserialize()	0	4	1
A	getType()	0	3	1
A	getSortKey()	0	3	1
A	getValue()	0	8	3
A	getScheme()	0	3	1
A	getHierarchicalPart()	0	3	1
A	getQuery()	0	3	1
A	getFragment()	0	3	1
B	getIriParts()	0	28	6
A	getArrayValue()	0	3	1
A	newFromArray()	0	4	1

<?php

namespace DataValues;

/**
 * Class representing a IRI value.
 *
 * This code is based on the SMWDIUri class
 * from Semantic MediaWiki, written by Markus Krötzsch.
 *
 * For info on IRI syntax, see https://en.wikipedia.org/wiki/URI_scheme#Generic_syntax
 *
 * @since 0.1
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class IriValue extends DataValueObject {

	/**
	 * The URI scheme of the IRI.
	 * For instance "http", "ssh" or "mailto".
	 *
	 * @since 0.1
	 *
	 * @var string
	 */
	protected $scheme;

	/**
	 * The hierarchical part of the IRI.
	 * Consists out of an authority and a path.
	 * For instance
	 * - //username:password@example.com:8042/over/there/index.dtb
	 * - //www.wikidata.org
	 *
	 * @since 0.1
	 *
	 * @var string
	 */
	protected $hierarchicalPart;

	/**
	 * The query of the IRI.
	 * For instance type=animal&name=narwhal
	 *
	 * @since 0.1
	 *
	 * @var string
	 */
	protected $query;

	/**
	 * The fragment of the IRI.
	 * For instance headerSection
	 *
	 * @since 0.1
	 *
	 * @var string
	 */
	protected $fragment;

	/**
	 * @since 0.1
	 *
	 * @param string $scheme
	 * @param string $hierarchicalPart
	 * @param string $query
	 * @param string $fragment
	 *
	 * @throws IllegalValueException
	 */
	public function __construct( $scheme, $hierarchicalPart, $query = '', $fragment = '' ) {
		foreach ( func_get_args() as $value ) {
			if ( !is_string( $value ) ) {
				throw new IllegalValueException( 'Can only construct IriValue from strings' );
			}
		}

		if ( $scheme === '' || preg_match( '/[^a-zA-Z]/u', $scheme ) ) {
			throw new IllegalValueException( "Illegal URI scheme '$scheme'." );
		}

		if ( $hierarchicalPart === '' ) {
			throw new IllegalValueException( "Illegal URI hierarchical part '$hierarchicalPart'." );
		}

		$this->scheme = $scheme;
		$this->hierarchicalPart = $hierarchicalPart;
		$this->query = $query;
		$this->fragment = $fragment;
	}

	/**
	 * @see Serializable::serialize
	 *
	 * @since 0.1
	 *
	 * @return string
	 */
	public function serialize() {
		return $this->getValue();
	}

	/**
	 * @see Serializable::unserialize
	 *
	 * @since 0.1
	 *
	 * @param string $value
	 *
	 * @return StringValue
	 */
	public function unserialize( $value ) {
		list( $scheme, $hierarchicalPart, $query, $fragment ) = self::getIriParts( $value );
		$this->__construct( $scheme, $hierarchicalPart, $query, $fragment );
	}

	/**
	 * @see DataValue::getType
	 *
	 * @since 0.1
	 *
	 * @return string
	 */
	public static function getType() {
		return 'iri';
	}

	/**
	 * @see DataValue::getSortKey
	 *
	 * @since 0.1
	 *
	 * @return string|float|int
	 */
	public function getSortKey() {
		return $this->getValue();
	}

	/**
	 * Returns the string.
	 * @see DataValue::getValue
	 *
	 * @since 0.1
	 *
	 * @return string
	 */
	public function getValue() {
		$uri = $this->scheme . ':'
			. $this->hierarchicalPart
			. ( $this->query ? '?' . $this->query : '' )
			. ( $this->fragment ? '#' . $this->fragment : '' );

		return $uri;
	}

	/**
	 * Returns the scheme or the IRI.
	 *
	 * @since 0.1
	 *
	 * @return string
	 */
	public function getScheme() {
		return $this->scheme;
	}

	/**
	 * Returns the hierarchical part of the IRI.
	 *
	 * @since 0.1
	 *
	 * @return string
	 */
	public function getHierarchicalPart() {
		return $this->hierarchicalPart;
	}

	/**
	 * Returns the query part of the IRI.
	 *
	 * @since 0.1
	 *
	 * @return string
	 */
	public function getQuery() {
		return $this->query;
	}

	/**
	 * Returns the fragment part of the IRI.
	 *
	 * @since 0.1
	 *
	 * @return string
	 */
	public function getFragment() {
		return $this->fragment;
	}

	/**
	 * @since 0.1
	 *
	 * @param string $serialization
	 *
	 * @return array
	 * @throws IllegalValueException
	 */
	public static function getIriParts( $serialization ) {
		if ( !is_string( $serialization ) ) {
			throw new IllegalValueException( 'IriValue::getIriParts expects a string value' );
		}

		$parts = explode( ':', $serialization, 2 ); // try to split "schema:rest"

		if ( count( $parts ) === 1 ) {
			throw new IllegalValueException( "Unserialization failed: the string \"$serialization\" is no valid URI." );
		}

		$scheme = $parts[0];
		$parts = explode( '?', $parts[1], 2 ); // try to split "hier-part?queryfrag"

		if ( count( $parts ) == 2 ) {
			$hierpart = $parts[0];
			$parts = explode( '#', $parts[1], 2 ); // try to split "query#frag"
			$query = $parts[0];
			$fragment = count( $parts ) == 2 ? $parts[1] : '';
		} else {
			$query = '';
			$parts = explode( '#', $parts[0], 2 ); // try to split "hier-part#frag"
			$hierpart = $parts[0];
			$fragment = count( $parts ) == 2 ? $parts[1] : '';
		}

		return array( $scheme, $hierpart, $query, $fragment );
	}

	/**
	 * @see DataValue::getArrayValue
	 *
	 * @since 0.1
	 *
	 * @return mixed
	 */
	public function getArrayValue() {
		return $this->getValue();
	}

	/**
	 * Constructs a new instance of the DataValue from the provided data.
	 * This can round-trip with @see getArrayValue
	 *
	 * @since 0.1
	 *
	 * @param mixed $data
	 *
	 * @return IriValue
	 * @throws IllegalValueException
	 */
	public static function newFromArray( $data ) {
		list( $scheme, $hierarchicalPart, $query, $fragment ) = self::getIriParts( $data );
		return new self( $scheme, $hierarchicalPart, $query, $fragment );
	}

}