GFG\DTOUrl\Url

Complexity

Total Complexity

15

Size/Duplication

Total Lines	198
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	2	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getFullUrl()	0	14	3
A	addHost()	0	5	1
A	addPort()	0	5	1
A	addScheme()	0	5	1
A	addUser()	0	9	3
A	addPath()	0	5	1
A	addQuery()	0	11	2
A	addFragment()	0	5	1
A	replacePath()	0	4	1
A	replaceQuery()	0	4	1

<?php

namespace GFG\DTOUrl;

use GFG\DTOContext\DataWrapper;

/**
 * @SuppressWarnings(PHPMD.UnusedPrivateField)
 * @method string getScheme()
 * @method string getHost()
 * @method string getPort()
 * @method string getUser()
 * @method string getPass()
 * @method array getPath()
 * @method array getQuery()
 * @method string getFragment()
 * @method Url setScheme(string $scheme)
 * @method Url setHost(string $host)
 * @method Url setPort(string $port)
 * @method Url setUser(string $user)
 * @method Url setPass(string $pass)
 * @method Url setPath(array $path)
 * @method Url setQuery(array $query)
 * @method Url setFragment(string $fragment)
 */
class Url extends Datawrapper\Base
{
    /**
     * All the parts from the url are stored separetely even after treated,
     * this will allow to change specific bits without the need to rebuild the
     * entire url
     *
     * @var associative array
     */
    private $fullUrl = [
        'scheme'      => '',
        'credentials' => '',
        'host'        => '',
        'port'        => '',
        'path'        => '',
        'query'       => '',
        'fragment'    => ''
    ];

    /**
     * @var string
     */
    private $scheme;

    /**
     * @var string
     */
    private $host;

    /**
     * @var string
     */
    private $port;

    /**
     * @var string
     */
    private $user;

    /**
     * @var string
     */
    private $pass;

    /**
     * @var array
     */
    private $path  = [];

    /**
     * Associative array to build query string
     *
     * @var array
     */
    private $query = [];

    /**
     * @var string
     */
    private $fragment;

    /**
     * Build the final url based on the structure defined
     *
     * @return string
     */
    public function getFullUrl()
    {
        $parts = $this->toArray();
        unset($parts['full_url'], $parts['pass']);

        foreach ($parts as $method => $param) {
            if ($param) {
                $method = 'add' . ucfirst($method);
                $this->$method($param);
            }
        }

        return ltrim(implode($this->fullUrl), '/');
    }

    /**
     * Add host to the final url
     *
     * @param string $host
     * @return Url
     */
    public function addHost($host)
    {
        $this->fullUrl['host'] = $host;
        return $this;
    }

    /**
     * Add port to the final url
     *
     * @param string $port
     * @return Url
     */
    public function addPort($port)
    {
        $this->fullUrl['port'] = ":{$port}";
        return $this;
    }

    /**
     * Add scheme to the final url
     *
     * @param string $scheme
     * @return Url
     */
    public function addScheme($scheme)
    {
        $this->fullUrl['scheme'] = $scheme . '://';
        return $this;
    }

    /**
     * Add the credentials to the final url, both username and password are
     * added in this stage
     *
     * @param string $user
     * @return Url
     */
    public function addUser($user)
    {
        //only add the information if there are username and password
        if ($user && $this->getPass()) {
            $this->fullUrl['credentials'] = $user . ':' . $this->getPass() . '@';
        }

        return $this;
    }

    /**
     * Add paths to the final url
     *
     * @param string $path
     * @return Url
     */
    public function addPath($path)
    {
        $this->fullUrl['path'] = '/' . implode('/', (array) $path);
        return $this;
    }

    /**
     * Add query string to the final url
     *
     * @param array $query
     * @return Url
     */
    public function addQuery(array $query)
    {
        $queryParts = [];
        foreach ($query as $key => $value) {
            $queryParts[] = "{$key}={$value}";
        }

        $this->fullUrl['query'] = '?' . implode('&', $queryParts);

        return $this;
    }

    /**
     * Add fragment to the final url
     *
     * @param string $fragment
     * @return Url
     */
    public function addFragment($fragment)
    {
        $this->fullUrl['fragment'] = "#{$fragment}";
        return $this;
    }

    /**
     * Replace path values
     *
     * @param associative array $replace
     * @return Url
     */
    public function replacePath(array $replace)
    {
        return $this->setPath(array_merge($this->getPath(), $replace));
    }

    /**
     * Replace query string values
     *
     * @param associative array $replace
     * @return Url
     */
    public function replaceQuery(array $replace)
    {
        return $this->setQuery(array_merge($this->getQuery(), $replace));
    }
}