Dash\Route\AssemblyResult

Complexity

Total Complexity

21

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	2
Bugs	0	Features	1

1 Method

Rating	Name	Duplication	Size	Complexity
F	generateUri()	0	39	21

<?php
/**
 * Dash
 *
 * @link      http://github.com/DASPRiD/Dash For the canonical source repository
 * @copyright 2013-2015 Ben Scholzen 'DASPRiD'
 * @license   http://opensource.org/licenses/BSD-2-Clause Simplified BSD License
 */

namespace Dash\Route;

/**
 * A generic assembly result which is returned by assemble methods.
 *
 * {@internal We are not using Zend\Uri for performance reasons. All the
 * normalization going on in Zend\Uri have a huge performance impact and are not
 * required for simple assembling.
 *
 * There is no validation done in this class, as it is assumed that someone who
 * writes custom route classes actually knows what one is doing. We only take
 * care of required encoding here.
 *
 * Seriously, consider twice before tweaking this class, as it is quite
 * performance-critical to assembling. Any changes should be backed by proper
 * benchmarks.}}
 */
class AssemblyResult
{
    /**
     * These characters are allowed within a path and should not be encoded.
     *
     * @var array
     */
    protected static $allowedPathChars = [
        '%2F' => '/',
        '%40' => '@',
        '%3A' => ':',
        '%3B' => ';',
        '%2C' => ',',
        '%3D' => '=',
        '%2B' => '+',
        '%21' => '!',
        '%2A' => '*',
        '%7C' => '|',
    ];

    /**
     * @var null|string
     */
    public $scheme;

    /**
     * @var null|string
     */
    public $host;

    /**
     * @var null|int
     */
    public $port;

    /**
     * @var null|string
     */
    public $path;

    /**
     * @var null|array
     */
    public $query;

    /**
     * @var null|string
     */
    public $fragment;

    /**
     * Converts the assembly result to a string.
     *
     * If $forceCanonical is set to false, a scheme or host is only prepended
     * to the result if they differ from the references. In case $forceCanonical
     * is set to true, either the set scheme and host will be used, or if not
     * set, the reference values.
     *
     * @param  string $referenceScheme
     * @param  string $referenceHost
     * @param  int    $referencePort
     * @param  bool   $forceCanonical
     * @return string
     */
    public function generateUri($referenceScheme, $referenceHost, $referencePort, $forceCanonical)
    {
        $url    = '';
        $scheme = $referenceScheme;
        $port   = $this->port;

        if ($forceCanonical || $this->scheme !== null && $referenceScheme !== $this->scheme) {
            $url .= ($scheme = $this->scheme ?: $referenceScheme) . ':';
            $forceCanonical = true;
        }

        if (null === $this->port) {
            if ($scheme === $referenceScheme && (null === $this->host || $this->host === $referenceHost)) {
                $port = $referencePort;
            } else {
                $port = 'http' === $scheme ? 80 : 443;
            }
        }

        if ($forceCanonical || $this->host !== null && $referenceHost !== $this->host || $port !== $referencePort) {
            $url .= '//' . ($this->host ?: $referenceHost);

            if ('http' === $scheme && 80 !== $port || 'https' === $scheme && 443 !== $port) {
                $url .= ':' . $port;
            }
        }

        $url .= strtr(rawurlencode($this->path), static::$allowedPathChars);

        if ($this->query !== null) {
            $url .= '?' . http_build_query($this->query, '', '&');
        }

        if ($this->fragment !== null) {
            $url .= '#' . $this->fragment;
        }

        return $url;
    }
}