Zbox\UnifiedPush\Notification\NotificationBuilder

Complexity

Total Complexity

16

Size/Duplication

Total Lines	171
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	6
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	addPayloadHandler()	0	10	2
A	getPayloadHandlers()	0	4	1
A	getNotificationCollection()	0	4	1
B	buildNotifications()	0	27	5
B	createNotification()	0	29	3
A	handlePayload()	0	11	1
A	validatePayload()	0	17	2

<?php

/*
 * (c) Alexander Zhukov <zbox82@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zbox\UnifiedPush\Notification;

use Zbox\UnifiedPush\Message\MessageInterface;
use Zbox\UnifiedPush\Exception\MalformedNotificationException;
use Zbox\UnifiedPush\Exception\DomainException;

/**
 * Class NotificationBuilder
 * @package Zbox\UnifiedPush\Notification
 */
class NotificationBuilder
{
    /**
     * @var PayloadHandlerInterface[]
     */
    private $payloadHandlers;

    /**
     * @var MessageInterface
     */
    private $message;

    /**
     * @var \ArrayIterator
     */
    private $notificationCollection;

    /**
     * NotificationBuilder constructor.
     */
    public function __construct()
    {
        $this->notificationCollection = new \ArrayIterator();
    }

    /**
     * @param PayloadHandlerInterface $handler
     * @return $this
     */
    public function addPayloadHandler(PayloadHandlerInterface $handler)
    {
        $hash = spl_object_hash($handler);

        if (!isset($this->payloadHandlers[$hash])) {
            $this->payloadHandlers[$hash] = $handler;
        }

        return $this;
    }

    /**
     * @return PayloadHandlerInterface[]
     */
    public function getPayloadHandlers()
    {
        return $this->payloadHandlers;
    }

    /**
     * @return \ArrayIterator
     */
    public function getNotificationCollection()
    {
        return $this->notificationCollection;
    }

    /**
     * Generates number of notifications by message recipient count
     * and notification service limitations
     *
     * @param MessageInterface $message
     * @return $this
     */
    public function buildNotifications(MessageInterface $message)
    {
        $this->message  = $message;

        $recipientQueue = new \SplQueue();
        $recipientChunk = new \ArrayIterator();

        foreach ($message->getRecipientDeviceCollection() as $recipient) {
            $recipientChunk->append($recipient);

            if ($recipientChunk->count() >= $message->getMaxRecipientsPerMessage()) {
                $recipientQueue->enqueue($recipientChunk);
                $recipientChunk = new \ArrayIterator();
            }
        }

        if ($recipientChunk->count()) {
            $recipientQueue->enqueue($recipientChunk);
        }

        while (!$recipientQueue->isEmpty()) {
            $notification = $this->createNotification($recipientQueue->dequeue());
            $this->notificationCollection->append($notification);
        }

        return $this;
    }

    /**
     * Returns created notification
     *
     * @param \ArrayIterator $recipients
     * @return Notification
     * @throws MalformedNotificationException
     */
    private function createNotification(\ArrayIterator $recipients)
    {
        $message = clone $this->message;
        $message->setRecipientDeviceCollection($recipients);

        $handlers = $this->getPayloadHandlers();

        foreach ($handlers as $handler) {
            if ($handler->isSupported($message)) {
                $packedPayload  = $this->handlePayload($handler, $message);
                $customData     = $handler->getCustomNotificationData();

                return
                    (new Notification())
                        ->setType($message->getMessageType())
                        ->setRecipients($recipients)
                        ->setPayload($packedPayload)
                        ->setCustomNotificationData($customData)
                    ;
            }
        }

        throw new DomainException(
            sprintf(
                'Unhandled message type %s',
                $message->getMessageType()
            )
        );
    }

    /**
     * @param PayloadHandlerInterface $handler
     * @param MessageInterface $message
     * @return string
     * @throws MalformedNotificationException
     */
    private function handlePayload(PayloadHandlerInterface $handler, MessageInterface $message)
    {
        $handler->setMessage($message);

        $payload = $handler->createPayload();
        $packedPayload = $handler->packPayload($payload);

        $this->validatePayload($handler, $packedPayload);

        return $packedPayload;
    }

    /**
     * Check if maximum size allowed for a notification payload exceeded
     *
     * @param PayloadHandlerInterface $handler
     * @param string $payload
     * @throws MalformedNotificationException
     */
    private function validatePayload(PayloadHandlerInterface $handler, $payload)
    {
        $message     = $this->message;
        $messageType = $message->getMessageType();

        $maxLength   = $handler->getPayloadMaxLength();

        if (strlen($payload) > $maxLength) {
            throw new MalformedNotificationException(
                sprintf(
                    "The maximum size allowed for '%s' notification payload is %d bytes",
                    $messageType,
                    $maxLength
                )
            );
        }
    }
}