AppUtils\URLInfo\URLInfoTrait

Complexity

Total Complexity

45

Size/Duplication

Total Lines	228
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

35 Methods

Rating	Name	Duplication	Size	Complexity
A	getKey()	0	3	1
A	getInfo()	0	3	1
A	removeKey()	0	4	1
A	setScheme()	0	3	1
A	setTypeURL()	0	3	1
A	getUser()	0	3	1
A	getQuery()	0	3	1
A	hasHost()	0	3	1
A	getHost()	0	3	1
A	isSchemeLess()	0	3	1
A	getPath()	0	3	1
A	hasKey()	0	3	1
A	setIP()	0	6	1
A	setSchemeHTTPS()	0	3	1
A	isPathOnly()	0	11	4
A	isHostOnly()	0	11	4
A	getType()	0	3	1
A	hasAuth()	0	3	1
A	setSchemeMailto()	0	3	1
A	isFragmentOnly()	0	13	5
A	setKey()	0	4	1
A	setHostFromEmail()	0	6	1
A	getScheme()	0	3	1
A	hasQuery()	0	3	1
A	hasPath()	0	3	1
A	setHost()	0	3	1
A	removePath()	0	3	1
A	setType()	0	4	1
A	getPassword()	0	3	1
A	getKeyString()	0	3	1
A	hasFragment()	0	3	1
A	setAuth()	0	6	1
A	hasScheme()	0	3	1
A	setPath()	0	3	1
A	setTypeEmail()	0	3	1

<?php
/**
 * @package Application Utils
 * @subpackage URLInfo
 * @see \AppUtils\URLInfo\URLInfoTrait
 */

declare(strict_types=1);

namespace AppUtils\URLInfo;

use AppUtils\URLInfo;

/**
 * Trait used for classes that access a URL info array,
 * as parsed using the parse_url method.
 *
 * @package Application Utils
 * @subpackage URLInfo
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 */
trait URLInfoTrait
{
    /**
     * @var array<string,mixed>
     */
    protected array $info = array();

    /**
     * @return array<string,mixed>
     */
    public function getInfo() : array
    {
        return $this->info;
    }

    public function getKey(string $name) : ?string
    {
        return $this->info[$name] ?? null;
    }

    public function getKeyString(string $name) : string
    {
        return (string)$this->getKey($name);
    }

    public function getHost() : string
    {
        return $this->getKeyString('host');
    }

    public function getType() : string
    {
        return $this->getKeyString('type');
    }

    public function getUser() : string
    {
        return $this->getKeyString('user');
    }

    public function getPassword() : string
    {
        return $this->getKeyString('pass');
    }

    public function getQuery() : string
    {
        return $this->getKeyString('query');
    }

    public function getPath() : string
    {
        return$this->getKeyString('path');
    }

    public function getScheme() : string
    {
        return $this->getKeyString('scheme');
    }

    public function setHost(string $host) : self
    {
        return $this->setKey('host', $host);
    }

    public function setHostFromEmail(string $email) : self
    {
        $parts = explode('@', $email);
        $this->setHost(array_pop($parts));

        return $this;
    }

    public function setAuth(string $user, string $password) : self
    {
        $this->setKey('user', $user);
        $this->setKey('pass', $password);

        return $this;
    }

    public function setPath(string $path) : self
    {
        return $this->setKey('path', $path);
    }

    public function setKey(string $name, string $value) : self
    {
        $this->info[$name] = $value;
        return $this;
    }

    public function setIP(string $ip) : self
    {
        $this->setHost($ip);
        $this->setKey('ip', $ip);

        return $this;
    }

    public function setSchemeHTTPS() : self
    {
        return $this->setScheme('https');
    }

    public function setSchemeMailto() : self
    {
        return $this->setScheme('mailto');
    }

    public function setScheme(string $scheme) : self
    {
        return $this->setKey('scheme', $scheme);
    }

    public function setTypeURL() : self
    {
        return $this->setType(URLInfo::TYPE_URL);
    }

    public function setTypeEmail() : void
    {
        $this->setType(URLInfo::TYPE_EMAIL);
    }

    /**
     * @param string $type
     * @return $this
     */
    public function setType(string $type) : self
    {
        $this->info['type'] = $type;
        return $this;
    }

    public function removePath() : self
    {
        return $this->removeKey('path');
    }

    public function removeKey(string $name) : self
    {
        unset($this->info[$name]);
        return $this;
    }

    public function hasAuth() : bool
    {
        return isset($this->info['user'], $this->info['pass']);
    }

    public function hasKey(string $name) : bool
    {
        return isset($this->info[$name]);
    }

    public function hasHost() : bool
    {
        return $this->hasKey('host');
    }

    public function hasQuery() : bool
    {
        return $this->hasKey('query');
    }

    public function hasScheme() : bool
    {
        return $this->hasKey('scheme');
    }

    public function hasPath() : bool
    {
        return $this->hasKey('path');
    }

    public function hasFragment() : bool
    {
        return $this->hasKey('fragment');
    }

    public function isFragmentOnly() : bool
    {
        return
            $this->hasFragment()
            &&
            (
                !$this->hasScheme()
                &&
                !$this->hasHost()
                &&
                !$this->hasPath()
                &&
                !$this->hasQuery()
            );
    }

    public function isPathOnly() : bool
    {
        return
            $this->hasPath()
            &&
            (
                !$this->hasScheme()
                &&
                !$this->hasHost()
                &&
                !$this->hasQuery()
            );
    }

    public function isHostOnly() : bool
    {
        return
            $this->hasHost()
            &&
            (
                !$this->hasScheme()
                &&
                !$this->hasPath()
                &&
                !$this->hasQuery()
            );
    }

    public function isSchemeLess() : bool
    {
        return $this->isFragmentOnly();
    }
}