yrc\jobs\notifications\email\AbstractEmailNotification

Complexity

Total Complexity

3

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	perform()	0	9	2
A	compose()	0	20	1

<?php declare(strict_types=1);

namespace yrc\jobs\notifications\email;

use RPQ\Server\AbstractJob;
use yii\mail\MessageInterface;
use Yii;

/**
 * @abstract AbstractEmailNotification
 * All email notifications should extend this abstract class to inherit basic queue based email sending capabilities
 * @property array $origin
 * @property string $subject
 * @property string $viewFile
 */
abstract class AbstractEmailNotification extends AbstractJob
{
    /**
     * The sender email address and name as an array.
     * @var array
     */
    protected $origin = [
        'noreply@example.com' => 'No Reply'
    ];

    /**
     * The email subject. This should be explicitly declared in extensions
     * @var string
     */
    protected $subject;

    /**
     * The name of the viewfile to use within @app/views/email/(html|text)
     * @var string
     */
    protected $viewFile;

    abstract protected function getSubject();

    /**
     * Generates a message composition and returns a MessageInterface
     * @param string|array $to
     * @param array $args
     * @return yii\mail\MessageInterface
     */
    protected function compose($to, array $args = []) : MessageInterface
    {
        // Grab the \yii\console\Controller instance, and setup the view paths
        // Yii::$app->mailer->compose() can't handle .twig extension, so the render/renderPartial methods need to be called manually
        $controller = Yii::$app->controller;

It seems like Yii::app->controller can also be of type yii\web\Controller. However, the property $controller is declared as type yii\console\Controller. Maybe add an additional type check?

        $controller->setViewPath(Yii::$app->mailer->viewPath);

Accessing viewPath on the interface yii\mail\MailerInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

        // Compose a message, and return a MessageInterface if the consumer needs to modify the message interface in any way.
        $composition = Yii::$app->mailer->compose()
            ->setFrom($args['origin'] ?? $this->origin)
            ->setSubject(Yii::t('app', $this->getSubject())) // The subject should be translated, if possible
            ->setTo($to);
        
        $controller->layout = Yii::$app->mailer->htmlLayout;

Accessing htmlLayout on the interface yii\mail\MailerInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

        $composition->setHtmlBody($controller->render("html/{$this->viewFile}", $args));

        $controller->layout = Yii::$app->mailer->textLayout;

Accessing textLayout on the interface yii\mail\MailerInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

        $composition->setTextBody($controller->render("text/{$this->viewFile}", $args));

        return $composition;
    }

    /**
     * Implementation of RPQ\AbstractJob\Perform to send the actual email
     * @param array $args
     * @return int
     */
    public function perform(array $args = []) : int
    {
        $message = $this->compose($args['email'], $args);
        
        if ($message->send()) {
            return 0;
        }

        return 1;
    }
}