Apparat\Object\Domain\Model\Uri\ObjectUrl

Complexity

Total Complexity

31

Size/Duplication

Total Lines	280
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	1	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	32	6
A	setCreationDate()	0	5	1
A	setType()	0	5	1
A	setId()	0	5	1
A	setRevision()	0	5	1
C	matches()	0	32	7
A	getCreationDate()	0	4	1
A	getId()	0	4	1
A	getType()	0	4	1
A	getRevision()	0	4	1
A	getLocator()	0	4	1
A	isDraft()	0	4	1
A	setDraft()	0	5	1
A	getRepositoryUrl()	0	20	3
A	isHidden()	0	4	1
A	setHidden()	0	5	1
A	getUrlInternal()	0	10	2

<?php

/**
 * apparat-object
 *
 * @category    Apparat
 * @package     Apparat\Object\Domain
 * @author      Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Apparat\Object\Domain\Model\Uri;

use Apparat\Kernel\Ports\Kernel;
use Apparat\Object\Domain\Model\Object\Id;
use Apparat\Object\Domain\Model\Object\Revision;
use Apparat\Object\Domain\Model\Object\Type;

/**
 * Object URL
 *
 * @package Apparat\Object\Domain\Model
 */
class ObjectUrl extends Url implements LocatorInterface
{
    /**
     * Object locator
     *
     * @var Locator
     */
    protected $locator = null;

    /*******************************************************************************
     * PUBLIC METHODS
     *******************************************************************************/

    /**
     * Object URL constructor
     *
     * @param string $url Object URL
     * @param boolean $remote Accept remote URL (less strict date component checking)
     * @throws InvalidArgumentException If remote URLs are not allowed and a remote URL is given
     * @throws InvalidArgumentException If the locator component is empty
     */
    public function __construct($url, $remote = false)
    {
        parent::__construct($url);

        // If it's an invalid remote object URL
        if ($this->isAbsolute() && !$remote) {
            throw new InvalidArgumentException(
                sprintf('Unallowed remote object URL "%s"', $url),
                InvalidArgumentException::UNALLOWED_REMOTE_OBJECT_URL
            );
        }

        // If the locator component is empty
        if (empty($this->urlParts['path'])) {
            throw new InvalidArgumentException(
                'Invalid object URL path (empty)',
                InvalidArgumentException::INVALID_OBJECT_URL_LOCATOR
            );
        }

        // Instantiate the local locator component
        $this->locator = new Locator(
            $this->urlParts['path'],
            $remote ? true : null,
            $this->urlParts['path']
        );

        // Normalize the locator prefix
        if (!strlen($this->urlParts['path'])) {
            $this->urlParts['path'] = null;
        }
    }

    /**
     * Set the object's creation date
     *
     * @param \DateTimeInterface $creationDate
     * @return LocatorInterface|ObjectUrl New object locator
     */
    public function setCreationDate(\DateTimeInterface $creationDate)
    {
        $this->locator = $this->locator->setCreationDate($creationDate);
        return $this;
    }

    /**
     * Set the object type
     *
     * @param Type $type Object type
     * @return LocatorInterface|ObjectUrl New object URL
     */
    public function setType(Type $type)
    {
        $this->locator = $this->locator->setType($type);
        return $this;
    }

    /**
     * Set the object ID
     *
     * @param Id $uid Object ID
     * @return LocatorInterface|ObjectUrl New object URL
     */
    public function setId(Id $uid)
    {
        $this->locator = $this->locator->setId($uid);
        return $this;
    }

    /**
     * Set the object revision
     *
     * @param Revision $revision Object revision
     * @return LocatorInterface|ObjectUrl New object URL
     */
    public function setRevision(Revision $revision)
    {
        $this->locator = $this->locator->setRevision($revision);
        return $this;
    }

    /**
     * Test if this URL matches all available parts of a given URL
     *
     * @param Url $url Comparison URL
     * @return bool This URL matches all available parts of the given URL
     */
    public function matches(Url $url)
    {
        // If the standard URL components don't match
        if (!parent::matches($url)) {
            return false;
        }

        // Extended tests if it's an object URL
        if ($url instanceof self) {
            // Test the object creation date
            if ($this->getCreationDate() != $url->getCreationDate()) {
                return false;
            }

            // Test the object ID
            if ($this->getId()->serialize() !== $url->getId()->serialize()) {
                return false;
            }

            // Test the object type
            if ($this->getType()->serialize() !== $url->getType()->serialize()) {
                return false;
            }

            // Test the object revision
            if ($this->getRevision()->serialize() !== $url->getRevision()->serialize()) {
                return false;
            }
        }

        return true;
    }

    /**
     * Return the object's creation date
     *
     * @return \DateTimeInterface Object creation date
     */
    public function getCreationDate()
    {
        return $this->locator->getCreationDate();
    }

    /**
     * Return the object ID
     *
     * @return Id Object ID
     */
    public function getId()
    {
        return $this->locator->getId();
    }

    /**
     * Return the object type
     *
     * @return Type Object type
     */
    public function getType()
    {
        return $this->locator->getType();
    }

    /**
     * Return the object revision
     *
     * @return Revision Object revision
     */
    public function getRevision()
    {
        return $this->locator->getRevision();
    }

    /**
     * Return the local object locator
     *
     * @return LocatorInterface|Locator Local object locator
     */
    public function getLocator()
    {
        return $this->locator;
    }

    /**
     * Return the object draft mode
     *
     * @return boolean Object draft mode
     */
    public function isDraft()
    {
        return $this->locator->getRevision()->isDraft();
    }

    /**
     * Set the object draft mode
     *
     * @param boolean $draft Object draft mode
     * @return LocatorInterface|ObjectUrl New object locator
     */
    public function setDraft($draft)
    {
        $this->locator = $this->locator->setRevision($this->locator->getRevision()->setDraft($draft));
        return $this;
    }

    /**
     * Return the repository URL part of this object URL
     *
     * @return string Repository URL
     * @see https://github.com/apparat/apparat/blob/master/doc/URL-DESIGN.md#repository-url
     */
    public function getRepositoryUrl()
    {
        // If the object URL is absolute and local: Extract the repository URL
        if ($this->isAbsoluteLocal()) {
            $baseUrl = Kernel::create(Url::class, [getenv('APPARAT_BASE_URL')]);
            return substr($this->getPath(), strlen($baseUrl->getPath()));

            // Else: If it's a relative URL: Extract the repository URL
        } elseif (!$this->isAbsolute()) {
            return $this->getPath();
        }

        // Else: It must be a remote repository
        $override = [
            'object' => '',
            'query' => '',
            'fragment' => '',
        ];
        return $this->getUrlInternal($override);
    }


    /**
     * Return the object hidden state
     *
     * @return boolean Object hidden state
     */
    public function isHidden()
    {
        return $this->locator->isHidden();
    }

    /**
     * Set the object hidden state
     *
     * @param boolean $hidden Object hidden state
     * @return LocatorInterface|Locator New object locator
     */
    public function setHidden($hidden)
    {
        $this->locator = $this->locator->setHidden($hidden);
        return $this;
    }

    /**
     * Return the a complete serialized object URL
     *
     * @param array $override Override components
     * @return string Serialized URL
     */
    protected function getUrlInternal(array &$override = [])
    {
        parent::getUrlInternal($override);

        // Prepare the local object locator
        $override['object'] = isset($override['object']) ? $override['object'] : strval($this->locator);

        return "{$override['scheme']}{$override['user']}{$override['pass']}{$override['host']}{$override['port']}".
        "{$override['path']}{$override['object']}{$override['query']}{$override['fragment']}";
    }
}