ByTIC\Notifier\Models\Recipients\RecipientTrait

Complexity

Total Complexity

11

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Test Coverage

Coverage

33.33%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getRecipient()	0	3	1
A	getRecipientModelFromEvent()	0	8	2
A	generateNotifiablesForEvent()	0	10	2
A	generateRecipientGetterMethod()	0	3	1
A	getRecipientManager()	0	6	2
A	isActive()	0	3	1
A	generateRecipientManager()	0	3	1
A	getNotificationMessage()	0	8	1

<?php

namespace ByTIC\Notifier\Models\Recipients;

use ByTIC\Common\Records\Traits\HasTypes\RecordTrait;
use ByTIC\Notifier\Exceptions\NotificationModelNotFoundException;
use ByTIC\Notifier\Exceptions\NotificationRecipientModelNotFoundException;
use ByTIC\Notifier\Models\Events\EventTrait as Event;
use ByTIC\Notifier\Models\Messages\MessagesTrait;
use ByTIC\Notifier\Models\Recipients\Types\AbstractType;
use ByTIC\Notifier\Models\Topics\TopicTrait as Topic;
use ByTIC\Notifier\Models\Messages\MessageTrait as Message;
use ByTIC\Notifier\Models\Messages\MessagesTrait as Messages;
use Nip\Records\Locator\ModelLocator;
use Nip\Records\Record;
use Nip\Records\RecordManager as Records;

/**
 * Class RecipientTrait
 * @package ByTIC\Notifier\Models\Recipients
 *
 * @property int $id_topic
 * @property string $recipient
 * @property string $type
 * @property string $active
 *
 * @method AbstractType getType
 * @method Topic getTopic
 * @method RecipientsTrait getManager()
 */
trait RecipientTrait
{
    use RecordTrait;

The trait ByTIC\Common\Records\Traits\HasTypes\RecordTrait has been deprecated: Use ByTIC\Models\SmartProperties\RecordsTraits\HasTypes\RecordTrait

    protected $recipientManager = null;

    /**
     * @return string
     */
    public function getRecipient()
    {
        return $this->recipient;
    }

    /**
     * @return bool
     */
    public function isActive()
    {
        return $this->active == 'yes';
    }

    /**
     * @param $event
     * @return \ByTIC\Notifications\Notifiable[]
     * @throws NotificationRecipientModelNotFoundException
     * @throws NotificationModelNotFoundException
     */
    public function generateNotifiablesForEvent($event)
    {
        $notifiableModels = $this->getRecipientModelFromEvent($event);
        if ($notifiableModels) {
            /** @var IsRecipientTrait $notifiableModels */
            return $notifiableModels->generateNotifiables();
        }

        throw new NotificationRecipientModelNotFoundException(
            "No model found in recipient" . $this->getRecipient() . " from notification event [" . $event->id . "]"
        );
    }

    /**
     * @param Event $event
     * @return RecipientTrait
     * @throws NotificationModelNotFoundException
     */
    public function getRecipientModelFromEvent($event)
    {
        $method = $this->generateRecipientGetterMethod();
        $model = $event->getModel();
        if ($model instanceof Record) {
            return $model->$method();
        }
        return null;
    }

    /**
     * Return the Message from the database with the text to include
     * in the notification
     *
     * @param string $channel
     * @return Message
     */
    public function getNotificationMessage($channel = 'email')
    {
        /** @var MessagesTrait $messagesTable */
        $messagesTable = ModelLocator::get('Notifications\Messages');
        return $messagesTable::getGlobal(
            $this->id_topic,
            $this->getRecipient(),
            $channel
        );
    }

    /**
     * @return Records
     */
    public function getRecipientManager()
    {
        if ($this->recipientManager === null) {
            $this->recipientManager = $this->generateRecipientManager();
        }
        return $this->recipientManager;
    }

    /**
     * @return Records
     */
    public function generateRecipientManager()
    {
        return $this->getManager()::getRecipientManager($this->getRecipient());
    }

    /**
     * @return string
     */
    public function generateRecipientGetterMethod()
    {
        return $this->getManager()::generateRecipientGetterMethod($this->getRecipient());
    }
}