Subreality\Dilmun\Anshar\Http\UriParts\Scheme

Complexity

Total Complexity

6

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	6
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	3
A	toUriString()	0	10	2
A	compileValidPattern()	0	5	1

<?php
namespace Subreality\Dilmun\Anshar\Http\UriParts;

/**
 * Class Scheme
 * @package Subreality\Dilmun\Anshar\Http\UriParts
 */
class Scheme extends AbstractUriPart
{
    protected static $compositions = array();

    /** @noinspection PhpMissingParentConstructorInspection */
    /**
     * Scheme constructor. Accepts a string representing a URI scheme. Construction will throw an exception if the
     * scheme is either not a string or does not conform to the RFC3986 URI scheme specification.
     *
     * Construction also results in the scheme string being converted to lowercase per RFC3986.
     *
     * scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )
     *
     * @see https://tools.ietf.org/html/rfc3986#section-3.1
     * @see https://tools.ietf.org/html/rfc3986#appendix-A
     *
     * @throws \InvalidArgumentException
     *
     * @param string $scheme    A string representing a URI scheme
     */
    public function __construct($scheme)
    {
        $this->compileValidPattern();

        if (!is_string($scheme)) {
            throw new \InvalidArgumentException("Scheme must be a string");
        } elseif (!$this->isValid($scheme)) {
            throw new \InvalidArgumentException("Scheme must conform to RFC3986 specification");
        }

        $this->data = strtolower($scheme);
    }

    /**
     * Returns a string representation of the scheme formatted so that it can be compiled into a complete URI string
     * per the Uri object's string specification.
     *
     * If the scheme is empty, toUriString returns an empty string; if the scheme is not empty, toUriString returns the
     * scheme suffixed with a colon.
     *
     * @see Uri::__toString
     *
     * @return string   A string representation of the scheme formatted for a complete URI string
     */
    public function toUriString()
    {
        $uri_scheme = parent::toUriString(); //returns data string

        if (!empty($this->data)) {
            $uri_scheme .= ":";
        }

        return $uri_scheme;
    }

    /**
     * Compiles a regexp pattern based on predefined patterns that define allowed characters for a scheme.
     */
    protected static function compileValidPattern()
    {
        self::$part_pattern  = '[a-z][\w\+\-\.]*';
        self::$valid_pattern = '/^$|^[a-z][\w\+\-\.]*$/i'; //the beginning '^$|' part allows for empty schemes
    }
}