Openpp\NotificationHubsRest\Registration\AbstractRegistration

Complexity

Total Complexity

31

Size/Duplication

Total Lines	330
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	1
A	setToken()	0	6	1
A	setTags()	0	6	1
A	setTemplate()	0	6	1
A	setRegistrationId()	0	6	1
A	getRegistrationId()	0	4	1
A	setETag()	0	6	1
A	getETag()	0	4	1
A	buildUri()	0	10	2
A	getContentType()	0	4	1
A	getHeaders()	0	13	2
A	getPayload()	0	16	2
B	scrapeResponse()	0	25	5
A	appendDescriptionNode()	0	14	2
A	appendTagNode()	0	8	2
A	appendTokenNode()	0	4	1
A	appendTemplateNode()	0	9	2
A	appendAdditionalNode()	0	3	1
A	getTags()	0	8	2
A	getToken()	0	4	1

<?php

namespace Openpp\NotificationHubsRest\Registration;

abstract class AbstractRegistration implements RegistrationInterface
{
    /**
     * @var \DomDocument
     */
    protected $dom;

    /**
     * @var \DOMNode
     */
    protected $content;

    /**
     * @var string
     */
    protected $token;

    /**
     * @var string|string[]
     */
    protected $tags;

    /**
     * @var string
     */
    protected $template;

    /**
     * @var string
     */
    protected $registrationId;

    /**
     * @var string
     */
    protected $eTag;

    /**
     * Initializes a new Registration.
     */
    public function __construct()
    {
        $this->dom = new \DomDocument('1.0', 'utf-8');

        $entryElement = $this->dom->createElement('entry');
        $entryElement->setAttribute('xmlns', 'http://www.w3.org/2005/Atom');

        $contentElement = $this->dom->createElement('content');
        $contentElement->setAttribute('type', 'application/xml');

        $this->content = $this->dom
            ->appendChild($entryElement)
            ->appendChild($contentElement)
        ;
    }

    /**
     * Sets Gcm Registration ID or APNs Device token.
     *
     * @param string $token
     *
     * @return RegistrationInterface this object
     */
    public function setToken($token)
    {
        $this->token = $token;

        return $this;
    }

    /**
     * Sets the tags.
     *
     * @param mixed $tags
     *
     * @return RegistrationInterface this object
     */
    public function setTags($tags)
    {
        $this->tags = $tags;

        return $this;
    }

    /**
     * Sets the template for the body.
     *
     * @param string $template
     *
     * @return RegistrationInterface this object
     */
    public function setTemplate($template)
    {
        $this->template = $template;

        return $this;
    }

    /**
     * Sets the registration ID for update or delete registration API.
     *
     * @param string $registrationId
     *
     * @return RegistrationInterface this object
     */
    public function setRegistrationId($registrationId)
    {
        $this->registrationId = $registrationId;

        return $this;
    }

    /**
     * Returns the token.
     *
     * @return string
     */
    public function getToken()
    {
        return $this->token;
    }

    /**
     * Returns the registration ID.
     *
     * @return string
     */
    public function getRegistrationId()
    {
        return $this->registrationId;
    }

    /**
     * Sets the ETag for update or delete registration API.
     *
     * @param string $eTag
     *
     * @return RegistrationInterface this object
     */
    public function setETag($eTag)
    {
        $this->eTag = $eTag;

        return $this;
    }

    /**
     * Returns the ETag.
     *
     * @return string
     */
    public function getETag()
    {
        return $this->eTag;
    }

    /**
     * {@inheritdoc}
     */
    public function buildUri($endpoint, $hubPath)
    {
        $uri = $endpoint.$hubPath.'/registrations/';

        if ($this->registrationId) {
            $uri .= $this->registrationId;
        }

        return $uri;
    }

    /**
     * {@inheritdoc}
     */
    public function getContentType()
    {
        return 'application/atom+xml;type=entry;charset=utf-8';
    }

    /**
     * {@inheritdoc}
     */
    public function getHeaders()
    {
        $headers = [
            'Content-Type: '.$this->getContentType(),
            'x-ms-version: '.'2013-08',
        ];

        if ($this->eTag) {
            $headers[] = 'If-Match: '.$this->eTag;
        }

        return $headers;
    }

    /**
     * Returns the atom payload for the registration request.
     *
     * @throws \RuntimeException
     *
     * @return string
     */
    public function getPayload()
    {
        if (!$this->token) {
            throw new \RuntimeException('Token is mandatory.');
        }

        $descriptionNode = $this->appendDescriptionNode();
        $this->appendTagNode($descriptionNode);
        $this->appendTokenNode($descriptionNode);
        $this->appendTemplateNode($descriptionNode);
        $this->appendAdditionalNode($descriptionNode);

        $this->dom->formatOutput = true;

        return $this->dom->saveXML();
    }

    /**
     * {@inheritdoc}
     */
    public function scrapeResponse($response)
    {
        $dom = new \DOMDocument();
        $dom->loadXML($response);

        if ($this->template) {
            $descriptionTag = $this->getTemplateRegistrationDescriptionTag();
        } else {
            $descriptionTag = $this->getRegistrationDescriptionTag();
        }

        $description = $dom->getElementsByTagName($descriptionTag)->item(0);
        if (!$description) {
            throw new \RuntimeException("Could not find '".$descriptionTag."' tag in the response: ".$response);
        }

        $result = [];
        foreach ($description->childNodes as $child) {
            if ('#text' != $child->nodeName) {
                $result[$child->nodeName] = $child->nodeValue;
            }
        }

        return $result;
    }

    /**
     * Appends the registration description DOMNode.
     *
     * @return \DOMNode
     */
    protected function appendDescriptionNode()
    {
        if ($this->template) {
            $descriptionTag = $this->getTemplateRegistrationDescriptionTag();
        } else {
            $descriptionTag = $this->getRegistrationDescriptionTag();
        }

        $descriptionElement = $this->dom->createElement($descriptionTag);
        $descriptionElement->setAttribute('xmlns:i', 'http://www.w3.org/2001/XMLSchema-instance');
        $descriptionElement->setAttribute('xmlns', 'http://schemas.microsoft.com/netservices/2010/10/servicebus/connect');

        return $this->content->appendChild($descriptionElement);
    }

    /**
     * Appends the 'Tags' DOMNode.
     *
     * @param \DOMNode $descriptionNode
     */
    protected function appendTagNode($descriptionNode)
    {
        if ($this->tags) {
            $descriptionNode->appendChild(
                $this->dom->createElement('Tags', $this->getTags())
            );
        }
    }

    /**
     * Appends the token DOMNode.
     *
     * @param \DOMNode $descriptionNode
     */
    protected function appendTokenNode($descriptionNode)
    {
        $descriptionNode->appendChild($this->dom->createElement($this->getTokenTag(), $this->token));
    }

    /**
     * Appends the 'BodyTemplate' DOMNode.
     *
     * @param \DOMNode $descriptionNode
     */
    protected function appendTemplateNode($descriptionNode)
    {
        if ($this->template) {
            $cdata = $this->dom->createCDATASection($this->template);
            $bodyTemplateElement = $this->dom->createElement('BodyTemplate');
            $bodyTemplateElement->appendChild($cdata);
            $descriptionNode->appendChild($bodyTemplateElement);
        }
    }

    /**
     * Appends the additional DOMNode.
     *
     * @param \DOMNode $descriptionNode
     */
    protected function appendAdditionalNode($descriptionNode)
    {
    }

    /**
     * Returns the tags.
     *
     * @return string
     */
    private function getTags()
    {
        if (is_array($this->tags)) {
            return implode(',', $this->tags);
        }

        return $this->tags;
    }
}