Subreality\Dilmun\Anshar\Http\UriParts\Query

Complexity

Total Complexity

8

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	3
A	isValid()	0	4	1
A	toUriString()	0	10	2
A	compileValidPattern()	0	10	1
A	compileUnencodedCharacters()	0	9	1

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

/**
 * Class Query
 * @package Subreality\Dilmun\Anshar\Http\UriParts
 */
class Query extends AbstractUriPart
{
    protected $unencoded_characters = array("/", "?");

    /**
     * Query constructor. Accepts a string representing a URI query. Construction will throw an exception if the
     * query is not a string.
     *
     * Construction accepts strings that have been percent-encoded as well as string that have not been percent-encoded
     * and will encode invalid characters.
     *
     * Construction with a string that includes both encoded and decoded characters will be assumed to be an encoded
     * string, resulting in double-encoding.
     *
     * query       = *( pchar / "/" / "?" )
     * pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
     * unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
     * pct-encoded = "%" HEXDIG HEXDIG
     * sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
     *
     * @see https://tools.ietf.org/html/rfc3986#appendix-A
     *
     * @throws \InvalidArgumentException
     *
     * @param string $query     A string representing a URI query
     */
    public function __construct($query)
    {
        $this->compileValidPattern();
        $this->compileUnencodedCharacters();

        if (!is_string($query)) {
            throw new \InvalidArgumentException("Query must be a string");
        } elseif (!self::isValid($query)) {
            $query = $this->encode($query);
        }

        $this->data = $query;
    }

    /**
     * Determines whether a given query adheres to the RFC3986 specification:
     *
     * query       = *( pchar / "/" / "?" )
     * pchar       = unreserved / pct-encoded / sub-delims / ":" / "@"
     * unreserved  = ALPHA / DIGIT / "-" / "." / "_" / "~"
     * pct-encoded = "%" HEXDIG HEXDIG
     * sub-delims  = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
     *
     * @see https://tools.ietf.org/html/rfc3986#appendix-A
     * @see Query::$valid_pattern
     *
     * @param string $query     The query to check for validity
     * @return bool             Returns true if the provided query matches the RFC3986 specification
     *                          Returns false otherwise
     */
    public static function isValid($query)
    {
        return parent::isValid($query);
    }

    /**
     * Returns a string representation of the query formatted so that it can be compiled into a complete URI string
     * per the Uri object's string specification.
     *
     * If the query is empty, toUriString returns an empty string; if the query is not empty, toUriString returns the
     * query prefixed with a question mark.
     *
     * @see Uri::__toString
     *
     * @return string   A string representation of the query formatted for a complete URI string
     */
    public function toUriString()
    {
        $uri_query = $this->data;

        if (!empty($uri_query)) {
            $uri_query = "?" . $uri_query;
        }

        return $uri_query;
    }

    /**
     * Compiles a regexp pattern based on predefined patterns that define allowed characters for a query. Note that the
     * pipe indicates that a query can either contain all defined characters or contain percent encoded characters.
     */
    protected function compileValidPattern()
    {
        self::$valid_pattern = '/^([\/\?' .
            $this->unreserved_pattern .
            $this->sub_delims_pattern .
            $this->pchar_pattern .
            ']|' .
            $this->pct_encoded_pattern .
            ')*$/';
    }

    protected function compileUnencodedCharacters()
    {
        $this->unencoded_characters = array_merge(
            $this->unencoded_characters,
            $this->unreserved_characters,
            $this->pchar_characters,
            $this->sub_delims_characters
        );
    }
}