common\components\maintenance\models\SubscribeForm

Complexity

Total Complexity

16

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getFileStatePath()	0	3	1
A	save()	0	3	1
A	getFileSubscribePath()	0	3	1
A	getTimestamp()	0	3	1
A	init()	0	4	1
A	isTimer()	0	3	1
A	isEmail()	0	3	1
A	getEmails()	0	3	1
A	attributeLabels()	0	4	1
A	send()	0	16	3
A	isSubscribe()	0	3	1
A	rules()	0	7	1
A	subscribe()	0	6	2

<?php

namespace common\components\maintenance\models;

use Yii;
use yii\base\Model;
use common\components\maintenance\interfaces\StateInterface;
use yii\helpers\ArrayHelper;
use Exception;
use yii\helpers\VarDumper;

/**
 * Class SubscribeForm
 * @package common\components\maintenance\models
 *
 * @property string $fileStatePath
 * @property array $emails
 * @property string $datetime
 * @property int $timestamp
 * @property string $dateFormat
 * @property string $fileSubscribePath
 * @property string $email
 */
class SubscribeForm extends Model
{
    /**
     * @var string
     */
    public $email;
    /**
     * @var StateInterface
     */
    protected $state;

    /**
     * @inheritDoc
     */
    public function init()
    {
        parent::init();
        $this->state = Yii::$container->get(StateInterface::class);
    }

    /**
     * @inheritDoc
     * @return array
     */
    public function rules()
    {
        return [
            ['email', 'trim'],
            ['email', 'required'],
            ['email', 'email'],
            ['email', 'string', 'max' => 255],
        ];
    }

    /**
     * @inheritDoc
     * @return array
     */
    public function attributeLabels()
    {
        return [
            'email' => Yii::t('app', 'Your email'),
        ];
    }

    /**
     * Sending notifications to followers
     *
     * @param array $emails
     * @return int
     */
    public function send($emails = [])
    {
        $emails = $emails ?: $this->emails;
        $messages = [];
        $mailer = Yii::$app->mailer;
        foreach ($emails as $email) {
            $messages[] = $mailer->compose([
                'html' => '@common/components/maintenance/mail/emailNotice-html',
                'text' => '@common/components/maintenance/mail/emailNotice-text'
            ], [])
                ->setFrom([Yii::$app->params['supportEmail'] => Yii::$app->name])
                ->setTo($email)
                ->setSubject(Yii::t('app', 'Notification of completion of technical work'));

        }
        return $mailer->sendMultiple($messages);
    }

    /**
     * Save follower
     * @return bool
     */
    public function subscribe()
    {
        if ($this->isEmail()) {
            return false;
        }
        return $this->save();
    }

    /**
     * Timestamp
     * @return int
     * @throws Exception
     */
    public function getTimestamp()
    {
        return $this->state->timestamp();

The method timestamp() does not exist on common\components\maintenance\interfaces\StateInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to common\components\maintenance\interfaces\StateInterface.

    }

    /**
     * Emails subscribe
     * @return array
     */
    public function getEmails()
    {
        return $this->state->emails();

The method emails() does not exist on common\components\maintenance\interfaces\StateInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to common\components\maintenance\interfaces\StateInterface.

    }

    /**
     * Check email is subscribe
     * @return bool
     */
    public function isEmail()
    {
        return ArrayHelper::isIn($this->email, $this->emails);
    }

    /**
     * Timer show/hide
     * @return bool
     */
    public function isTimer()
    {
        return $this->state->isTimer();

The method isTimer() does not exist on common\components\maintenance\interfaces\StateInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to common\components\maintenance\interfaces\StateInterface.

    }

    /**
     * Subscribe form on/off
     * @return bool will return true if on subscribe
     */
    public function isSubscribe()
    {
        return $this->state->isSubscribe();

The method isSubscribe() does not exist on common\components\maintenance\interfaces\StateInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to common\components\maintenance\interfaces\StateInterface.

    }

    /**
     * Save email in file
     * @return bool
     */
    protected function save()
    {
        return $this->state->save($this->email, $this->getFileSubscribePath());

The method save() does not exist on common\components\maintenance\interfaces\StateInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to common\components\maintenance\interfaces\StateInterface.

    }

    /**
     * Maintenance file path
     * @return string
     */
    protected function getFileStatePath()
    {
        return $this->state->path;

Accessing path on the interface common\components\maintenance\interfaces\StateInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

    }

    /**
     * Subscribe file path
     * @return string
     */
    protected function getFileSubscribePath()
    {
        return $this->state->subscribePath;

Accessing subscribePath on the interface common\components\maintenance\interfaces\StateInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

    }
}