phpDocumentor\DomainModel\Uri

Complexity

Total Complexity

10

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

96%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	__toString()	0	4	1
A	equals()	0	4	1
A	validateString()	0	6	2
A	validateUri()	0	6	2
A	addFileSchemeWhenSchemeIsAbsent()	0	12	3

<?php
declare(strict_types=1);

/**
 * This file is part of phpDocumentor.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author    Mike van Riel <mike.vanriel@naenius.com>
 * @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com)
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\DomainModel;

/**
 * Value object for uri.
 * Uri can be either local or remote.
 */
final class Uri
{
    /**
     * Uri path.
     *
     * @var string
     */
    private $uri;

    /**
     * Initializes the Uri.
     *
     * @param string $uri
     * @throws \InvalidArgumentException
     */
    public function __construct($uri)
    {
        $this->validateString($uri);

        $uri = $this->addFileSchemeWhenSchemeIsAbsent($uri);

        $this->validateUri($uri);

        $this->uri = $uri;
    }

    /**
     * Returns a string representation of the uri.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->uri;
    }

    /**
     * Checks if the provided uri is equal to the current uri.
     *
     * @param Uri $other
     */
    public function equals($other): bool
    {
        return $other == $this;
    }

    /**
     * Checks if $uri is of type string.
     *
     * @param string $uri
     *
     * @throws \InvalidArgumentException if $uri is not a string.
     */
    private function validateString($uri)
    {
        if (!\is_string($uri)) {
            throw new \InvalidArgumentException(sprintf('String required, %s given', \gettype($uri)));
        }
    }

    /**
     * Checks if $uri is valid.
     *
     * @param string $uri
     *
     * @throws \InvalidArgumentException if $uri is not a valid uri.
     */
    private function validateUri($uri)
    {
        if (filter_var($uri, FILTER_VALIDATE_URL) === false) {
            throw new \InvalidArgumentException(sprintf('%s is not a valid uri', $uri));
        }
    }

    /**
     * Checks if a scheme is present.
     * If no scheme is found, it is assumed that a local path is used, and file:// is prepended.
     *
     * @param string $uri
     */
    private function addFileSchemeWhenSchemeIsAbsent($uri): string
    {
        $scheme = parse_url($uri, PHP_URL_SCHEME);

        if (empty($scheme)) {
            $uri = 'file://' . $uri;
        } elseif (preg_match('/^[a-z]$/i', (string) $scheme)) { // windows driver letter
            $uri = 'file:///' . $uri;
        }

        return $uri;
    }
}