edde-framework/edde-framework

<?php
    declare(strict_types=1);

    namespace Edde\Common\Url;

    use Edde\Api\Url\IUrl;
    use Edde\Api\Url\UrlException;
    use Edde\Common\Object;
    use Edde\Common\Strings\StringUtils;

    class Url extends Object implements IUrl {
        /**
         * @var string
         */
        protected $scheme = '';
        /**
         * @var string
         */
        protected $user = '';
        /**
         * @var string
         */
        protected $password = '';
        /**
         * @var string
         */
        protected $host = '';
        /**
         * @var int
         */
        protected $port;
        /**
         * @var string
         */
        protected $path = '';
        /**
         * @var string
         */
        protected $query;
        protected $parameterList = [];
        /**
         * @var string
         */
        protected $fragment = '';

        public function __construct($url = null) {
            $url ? $this->parse((string)$url) : null;
        }

        /**
         * @inheritdoc
         */
        public function parse(string $url) {
            if (($parsed = parse_url($url)) === false) {
                throw new UrlException(sprintf('Malformed URL [%s].', $url));
            }
            if (isset($parsed['query'])) {
                parse_str($parsed['query'], $parsed['parameter-list']);
            }
            static $copy = [
                'scheme'         => 'setScheme',
                'user'           => 'setUser',
                'pass'           => 'setPassword',
                'host'           => 'setHost',
                'port'           => 'setPort',
                'path'           => 'setPath',
                'query'          => 'setQuery',
                'parameter-list' => 'setParameterList',
                'fragment'       => 'setFragment',
            ];
            foreach ($copy as $item => $func) {
                if (isset($parsed[$item])) {
                    $this->{$func}($parsed[$item]);
                }
            }
            return $this;
        }

        /**
         * @inheritdoc
         */
        public function getResourceName() {
            $pathList = $this->getPathList();
            return end($pathList);
        }

        /**
         * @inheritdoc
         */
        public function getPathList() {
            return explode('/', ltrim($this->path, '/'));
        }

        /**
         * @inheritdoc
         */
        public function getBasePath(): string {
            $pathList = $this->getPathList();
            array_pop($pathList);
            return implode('/', $pathList);
        }

        /**
         * @inheritdoc
         */
        public function getExtension() {
            $path = $this->getPath();
            $subpath = substr($path, strrpos($path, '/'));
            if (($index = strrpos($subpath, '.')) === false) {
                return null;
            }
            return substr($subpath, $index + 1);
        }

        /**
         * @inheritdoc
         */
        public function getPath(bool $query = true) {
            return $this->path . ($query && empty($this->parameterList) === false ? '?' . http_build_query($this->parameterList) : '');
        }

        /**
         * @inheritdoc
         */
        public function setPath(string $path): IUrl {
            $this->path = $path;
            return $this;
        }

        /**
         * @inheritdoc
         */
        public function getAbsoluteUrl(): string {
            $scheme = $this->getScheme();
            $url = '';
            if ($scheme !== '') {
                $url = $scheme . '://';
            }
            if (($user = $this->getUser()) !== '') {
                $url .= $user;
                if (($password = $this->getPassword()) !== '') {
                    $url .= ':' . $password;
                }
                $url .= '@';
            }
            $url .= ($host = $this->getHost());
            if ($host !== '' && ($port = $this->getPort()) !== null) {
                $url .= ':' . $port;
            }
            $url .= '/' . ltrim($this->getPath(false), '/');
            $query = $this->getParameterList();
            if (empty($query) === false) {
                $url .= '?' . http_build_query($query);
            }
            if (($fragment = $this->getFragment()) !== '') {
                $url .= '#' . $fragment;
            }
            return $url;
        }

        /**
         * @inheritdoc
         */
        public function getScheme() {
            return $this->scheme;
        }

        public function setScheme($scheme) {
            $this->scheme = $scheme;
            return $this;
        }

        /**
         * @inheritdoc
         */
        public function getUser() {
            return $this->user;
        }

        public function setUser($user) {
            $this->user = $user;
            return $this;
        }

        /**
         * @inheritdoc
         */
        public function getPassword() {
            return $this->password;
        }

        public function setPassword($password) {
            $this->password = $password;
            return $this;
        }

        /**
         * @inheritdoc
         */
        public function getHost() {
            return $this->host;
        }

        public function setHost($host) {
            $this->host = $host;
            return $this;
        }

        /**
         * @inheritdoc
         */
        public function getPort() {
            return $this->port;
        }

        public function setPort($port) {
            $this->port = $port;
            return $this;
        }

        /**
         * @inheritdoc
         */
        public function getQuery() {
            return $this->query;
        }

        /**
         * @inheritdoc
         */
        public function setQuery(string $query): IUrl {
            $this->query = $query;
            return $this;
        }

        /**
         * @inheritdoc
         */
        public function setParameterList(array $parameterList): IUrl {
            $this->parameterList = $parameterList;
            return $this;
        }

        /**
         * @inheritdoc
         */
        public function addParameterList(array $parameterList): IUrl {
            $this->parameterList = array_merge($this->parameterList, $parameterList);
            return $this;
        }

        /**
         * @inheritdoc
         */
        public function getParameterList(): array {
            return $this->parameterList;
        }

        /**
         * @inheritdoc
         */
        public function setParameter(string $name, $value): IUrl {
            $this->parameterList[$name] = $value;
            return $this;
        }

        /**
         * @inheritdoc
         */
        public function getFragment() {
            return $this->fragment;
        }

        public function setFragment($fragment) {
            $this->fragment = $fragment;
            return $this;
        }

        /**
         * @inheritdoc
         */
        public function getParameter(string $name, $default = null) {
            if (isset($this->parameterList[$name]) === false) {
                return $default;
            }
            return $this->parameterList[$name];
        }

        /**
         * @inheritdoc
         */
        public function match(string $match, bool $path = true) {
            return StringUtils::match($path ? $this->getPath(false) : $this->getAbsoluteUrl(), $match);
        }

        /**
         * @inheritdoc
         */
        public function __toString() {
            return $this->getAbsoluteUrl();
        }

        /**
         * @param null $url
         *
         * @return IUrl|$this
         * @throws UrlException
         */
        static public function create($url = null) {
            if ($url instanceof IUrl) {
                return $url;
            }
            $self = new static();
            if ($url !== null) {
                $self->parse((string)$url);
            }
            return $self;
        }
    }