CuyZ\Notiz\Core\Notification\Container\NotificationContainer

Complexity

Total Complexity

7

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	loop()	0	14	4
A	fetchAll()	0	6	1
A	fetchFromEventDefinition()	0	6	1

<?php

/*
 * Copyright (C) 2018
 * Nathan Boiron <nathan.boiron@gmail.com>
 * Romain Canon <romain.hydrocanon@gmail.com>
 *
 * This file is part of the TYPO3 NotiZ project.
 * It is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, either
 * version 3 of the License, or any later version.
 *
 * For the full copyright and license information, see:
 * http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace CuyZ\Notiz\Core\Notification\Container;

use CuyZ\Notiz\Core\Definition\Tree\EventGroup\Event\EventDefinition;
use CuyZ\Notiz\Core\Definition\Tree\Notification\NotificationDefinition;
use CuyZ\Notiz\Core\Exception\InvalidTypeException;
use Generator;

/**
 * This container is used as a proxy for the notification fetching: it will
 * check itself that the notification entries returned by a notification
 * processor are correct, without having to do it in the public API.
 */
class NotificationContainer
{
    /**
     * @var NotificationDefinition
     */
    protected $notificationDefinition;

    /**
     * @param NotificationDefinition $notificationDefinition
     */
    public function __construct(NotificationDefinition $notificationDefinition)
    {
        $this->notificationDefinition = $notificationDefinition;
    }

    /**
     * Fetches all notifications that are bound to the given event definition.
     *
     * @param EventDefinition $eventDefinition
     * @return Generator
     */
    public function fetchFromEventDefinition(EventDefinition $eventDefinition)
    {
        $processor = $this->notificationDefinition->getProcessor();
        $notifications = $processor->getNotificationsFromEventDefinition($eventDefinition);

        return $this->loop($notifications);
    }

    /**
     * Fetches the totality of notifications for the definition of this
     * container.
     *
     * @return Generator
     */
    public function fetchAll()
    {
        $processor = $this->notificationDefinition->getProcessor();
        $notifications = $processor->getAllNotifications();

        return $this->loop($notifications);
    }

    /**
     * Checks that the notifications that were fetched are all correct
     * instances.
     *
     * @param array $notifications
     * @return Generator
     *
     * @throws InvalidTypeException
     */
    protected function loop($notifications)
    {
        if (!is_array($notifications)) {

The condition ! is_array($notifications) can never be true.

            throw InvalidTypeException::notificationContainerArrayInvalidType($notifications);
        }

        $notificationClassName = $this->notificationDefinition->getClassName();

        foreach ($notifications as $key => $notification) {
            if (!$notification instanceof $notificationClassName) {
                throw InvalidTypeException::notificationContainerEntryInvalidType($key, $notification, $this->notificationDefinition);
            }

            yield $notification;
        }
    }
}