hiqdev\yii2\monitoring\logic\FeedbackSender

Complexity

Total Complexity

5

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	checkOptions()	0	8	3
A	send()	0	11	1

<?php
/**
 * Health monitoring for Yii2 applications
 *
 * @link      https://github.com/hiqdev/yii2-monitoring
 * @package   yii2-monitoring
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\yii2\monitoring\logic;

use hiqdev\yii2\monitoring\models\FeedbackForm;
use hiqdev\yii2\monitoring\Module;
use yii\base\BaseObject;
use yii\base\InvalidConfigException;
use yii\mail\MailerInterface;

/**
 * Class FeedbackSender provides API to send send user feedback to the system administrators.
 */
class FeedbackSender extends BaseObject
{
    /**
     * @var FeedbackForm
     */
    private $feedbackForm;
    /**
     * @var MailerInterface
     */
    private $mailer;
    /**
     * @var string
     */
    public $from;
    /**
     * @var string
     */
    public $to;
    /**
     * @var string
     */
    public $subject;
    /**
     * @var string
     */
    public $view;

    /**
     * FeedbackSender constructor.
     * @param FeedbackForm $feedbackForm
     * @param MailerInterface $mailer
     * @param array $options
     */
    public function __construct($feedbackForm, MailerInterface $mailer, $options = [])
    {
        parent::__construct($options);

        $this->feedbackForm = $feedbackForm;
        $this->mailer = $mailer;

        $this->checkOptions();
    }

    /**
     * @throws InvalidConfigException when one of required configuration fields is not filled properly
     */
    private function checkOptions()
    {
        foreach (['from', 'to', 'subject', 'view'] as $option) {
            if (!isset($this->{$option})) {
                throw new InvalidConfigException("Property \"$option\" property must be set");
            }
        }
    }

    /**
     * @return bool whether email was sent successfully
     */
    public function send()
    {
        $module = Module::getInstance();

        return $this->mailer
            ->compose($this->view, ['form' => $this->feedbackForm])
            ->setTo($this->to)
            ->setFrom($module->flagEmail($this->from))
            ->setSubject($module->flagText($this->subject))
            ->send();
    }
}