Mailer::sendGeneratedPassword() - Code Metrics - Inspection of "Fix mock tests codecept" - terabytesoftw/helper-mailer - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 7218c4...cef58c )

by Wilmer
created 2019-07-09 14:15 UTC
Mailer::sendGeneratedPassword() A

↳ Parent: Mailer
Complexity

Conditions	1
Paths	1
Size

Total Lines	7
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	6
CRAP Score	1
Importance

Changes
Metric	Value
cc	1
eloc	5
nc	1
nop	2
dl	0
loc	7
ccs	6
cts	6
cp	1
crap	1
rs	10
c	0
b	0
f	0
<?php

namespace terabytesoft\mailer\user;

use yii\base\Component;
use yii\db\ActiveRecord;

/**
 * Class Mailer
 *
 **/
class Mailer extends Component
{
    public $mailerComponent;
    public $sender;
    public $viewPath = '@terabytesoft/mailer/user/views';

    protected $confirmationSubject;
    protected $newPasswordSubject;
    protected $reconfirmationSubject;
    protected $recoverySubject;
    protected $welcomeSubject;


    /**
     * getWelcomeSubject
     **/
    public function getWelcomeSubject(): string
    {
        if ($this->welcomeSubject == null) {
            $this->setWelcomeSubject(\Yii::t(
                'mailer.user',
                'Welcome to {0}',
                [\Yii::$app->name]
            ));
        }

        return $this->welcomeSubject;
    }

    /**
     * setWelcomeSubject
     **/
    public function setWelcomeSubject(string $welcomeSubject): string
    {
        return $this->welcomeSubject = $welcomeSubject;
    }

    /**
     * getNewPasswordSubject
     **/
    public function getNewPasswordSubject(): string
    {
        if ($this->newPasswordSubject == null) {
            $this->setNewPasswordSubject(\Yii::t(
                'mailer.user',
                'Your password on {0} has been changed',
                [\Yii::$app->name]
            ));
        }

        return $this->newPasswordSubject;
    }

    /**
     * setNewPasswordSubject
     **/
    public function setNewPasswordSubject(string $newPasswordSubject): string
    {
        return $this->newPasswordSubject = $newPasswordSubject;
    }

    /**
     * getConfirmationSubject
     **/
    public function getConfirmationSubject(): string
    {
        if ($this->confirmationSubject == null) {
            $this->setConfirmationSubject(\Yii::t(
                'mailer.user',
                'Confirm account on {0}',
                [\Yii::$app->name]
            ));
        }

        return $this->confirmationSubject;
    }

    /**
     * setConfirmationSubject
     **/
    public function setConfirmationSubject(string $confirmationSubject): string
    {
        return $this->confirmationSubject = $confirmationSubject;
    }

    /**
     * getReconfirmationSubject
     **/
    public function getReconfirmationSubject(): string
    {
        if ($this->reconfirmationSubject == null) {
            $this->setReconfirmationSubject(\Yii::t(
                'mailer.user',
                'Confirm email change on {0}',
                [\Yii::$app->name]
            ));
        }

        return $this->reconfirmationSubject;
    }

    /**
     * setReconfirmationSubject
     **/
    public function setReconfirmationSubject($reconfirmationSubject): string
    {
        return $this->reconfirmationSubject = $reconfirmationSubject;
    }

    /**
     * getRecoverySubject
     **/
    public function getRecoverySubject(): string
    {
        if ($this->recoverySubject == null) {
            $this->setRecoverySubject(\Yii::t(
                'mailer.user',
                'Complete password reset on {0}',
                [\Yii::$app->name]
            ));
        }

        return $this->recoverySubject;
    }

    /**
     * setRecoverySubject
     **/
    public function setRecoverySubject(string $recoverySubject): string
    {
        return $this->recoverySubject = $recoverySubject;
    }

    /**
     * sendWelcomeMessage
     *
     * sends an email to a user after registration
     **/
    public function sendWelcomeMessage(
        ActiveRecord $user,
        ActiveRecord $token = null,
        object $module,
        $showPassword = false
    ): bool {
        return $this->sendMessage(
            $user->email,
            /** @scrutinizer ignore-type */ $user->email,
            $this->getWelcomeSubject(),
            'welcome',
            ['user' => $user, 'token' => $token, 'showPassword' => $showPassword, 'module' => $module]
        );
    }

    /**
     * sendGeneratedPassword
     *
     * sends a new generated password to a user
     **/
    public function sendGeneratedPassword(ActiveRecord $user, string $password): bool
    {
        return $this->sendMessage(
            $user->email,
            /** @scrutinizer ignore-type */ $user->email,
            $this->getNewPasswordSubject(),
            'new_password',
            ['user' => $user, 'password' => $password]
        );
    }

    /**
     * sendConfirmationMessage
     *
     * sends an email to a user with confirmation link
     **/
    public function sendConfirmationMessage(ActiveRecord $user, ActiveRecord $token): bool
    {
        return $this->sendMessage(
            $user->email,
            /** @scrutinizer ignore-type */ $user->email,
            $this->getConfirmationSubject(),
            'confirmation',
            ['user' => $user, 'token' => $token]
        );
    }

    /**
     * sendReconfirmationMessage.
     *
     * sends an email to a user with reconfirmation link
     **/
    public function sendReconfirmationMessage(ActiveRecord $user, ActiveRecord $token): bool
    {
        if ($token->type == $token::TYPE_CONFIRM_NEW_EMAIL) {

            $email = $user->unconfirmed_email;
        } else {
            $email = $user->email;
        }

        return $this->sendMessage(
            $email,
            /** @scrutinizer ignore-type */ $email,
            $this->getReconfirmationSubject(),
            'reconfirmation',
            ['user' => $user, 'token' => $token]
        );
    }

    /**
     * sendRecoveryMessage
     *
     * sends an email to a user with recovery link
     **/
    public function sendRecoveryMessage(ActiveRecord $user, ActiveRecord $token): bool
    {
        \Yii::$app->session->set('sendRecoveryMessage', true);
                             set('sendRecoveryMessage', true);
        return $this->sendMessage(
            $user->email,
            /** @scrutinizer ignore-type */ $user->email,
            $this->getRecoverySubject(),
            'recovery',
            ['user' => $user, 'token' => $token]
        );
    }

    /**
     * sendMessage
     **/
    protected function sendMessage(string $to, string $subject, string $view, array $params = []): bool
    {
        $mailer = $this->mailerComponent === null ? \Yii::$app->mailer : \Yii::$app->get($this->mailerComponent);

        $mailer->viewPath = $this->viewPath;

        return $mailer->compose(['html' => $view, 'text' => 'text/' . $view], $params)
        return $mailer->/** @scrutinizer ignore-call */ compose(['html' => $view, 'text' => 'text/' . $view], $params)
            ->setTo($to)
            ->setFrom(
                [\Yii::$app->params['mailer.user.email.sender'] => \Yii::$app->params['mailer.user.email.sender.name']]
            )
            ->setSubject($subject)
            ->send();
    }
}

terabytesoftw / helper-mailer

Push — master ( 7218c4...cef58c )

Mailer::sendGeneratedPassword() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
