UserMailer::sendPasswordChangedEmail() - Code Metrics - Inspection of "Change user email address" - components-web-app/api-components-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — v2 ( 227daa...82a867 )

by Daniel
created 2020-04-02 08:25 UTC
UserMailer::sendPasswordChangedEmail() A

↳ Parent: UserMailer
Complexity

Conditions	2
Paths	2
Size

Total Lines	15
Code Lines	11
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	6
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	11
c	1
b	0
f	0
dl	0
loc	15
ccs	0
cts	12
cp	0
rs	9.9
cc	2
nc	2
nop	1
crap	6
<?php

/*
 * This file is part of the Silverback API Component Bundle Project
 *
 * (c) Daniel West <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Silverback\ApiComponentBundle\Mailer;

use Silverback\ApiComponentBundle\Entity\User\AbstractUser;
use Silverback\ApiComponentBundle\Exception\InvalidParameterException;
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\Mime\Address;

/**
 * @author Daniel West <[email protected]>
 */
class UserMailer
{
    private MailerInterface $mailer;
    private RequestStack $requestStack;
    private string $websiteName;
    private string $defaultPasswordResetPath;
    private string $defaultChangeEmailVerifyPath;
    private bool $sendUserWelcomeEmailEnabled;
    private bool $sendUserEnabledEmailEnabled;
    private bool $sendUserUsernameChangedEmailEnabled;
    private bool $sendUserPasswordChangedEmailEnabled;

    public function __construct(
        MailerInterface $mailer,
        RequestStack $requestStack,
        string $websiteName,
        string $defaultPasswordResetPath,
        string $defaultChangeEmailVerifyPath,
        bool $sendUserWelcomeEmailEnabled = true,
        bool $sendUserEnabledEmailEnabled = true,
        bool $sendUserUsernameChangedEmailEnabled = true,
        bool $sendUserPasswordChangedEmailEnabled = true)
    {
        $this->mailer = $mailer;
        $this->requestStack = $requestStack;
        $this->defaultPasswordResetPath = $defaultPasswordResetPath;
        $this->defaultChangeEmailVerifyPath = $defaultChangeEmailVerifyPath;
        $this->websiteName = $websiteName;
        $this->sendUserWelcomeEmailEnabled = $sendUserWelcomeEmailEnabled;
        $this->sendUserEnabledEmailEnabled = $sendUserEnabledEmailEnabled;
        $this->sendUserUsernameChangedEmailEnabled = $sendUserUsernameChangedEmailEnabled;
        $this->sendUserPasswordChangedEmailEnabled = $sendUserPasswordChangedEmailEnabled;
    }

    public function sendPasswordResetEmail(AbstractUser $user): void
    {
        $userEmail = $this->getUserEmail($user);
        $resetUrl = $this->pathToReferrerUrl(
            $user->getNewPasswordConfirmationToken(),
            /** @scrutinizer ignore-type */ $user->getNewPasswordConfirmationToken(),
            $user->getUsername(),
            /** @scrutinizer ignore-type */ $user->getUsername(),
            'resetPath',
            $this->defaultPasswordResetPath
        );
        $email = (new TemplatedEmail())
            ->to(Address::fromString($userEmail))
            ->subject('Your password reset request')
            ->htmlTemplate('@SilverbackApiComponent/emails/user_forgot_password.html.twig')
            ->context([
                'user' => $user,
                'reset_url' => $resetUrl,
                'website_name' => $this->websiteName,
            ]);
        $this->mailer->send($email);
    }

    public function sendChangeEmailConfirmationEmail(AbstractUser $user): void
    {
        $userEmail = $this->getUserEmail($user);
        $verifyUrl = $this->pathToReferrerUrl(
            $user->getNewEmailConfirmationToken(),
            /** @scrutinizer ignore-type */ $user->getNewEmailConfirmationToken(),
            $user->getUsername(),
            /** @scrutinizer ignore-type */ $user->getUsername(),
            'verifyPath',
            $this->defaultChangeEmailVerifyPath
        );
        $email = (new TemplatedEmail())
            ->to(Address::fromString($userEmail))
            ->subject('Your password reset request')
            ->htmlTemplate('@SilverbackApiComponent/emails/user_verify_email.html.twig')
            ->context([
                'user' => $user,
                'verify_url' => $verifyUrl,
                'website_name' => $this->websiteName,
            ]);
        $this->mailer->send($email);
    }

    public function sendUserWelcomeEmail(AbstractUser $user): void
    {
        if (!$this->sendUserWelcomeEmailEnabled) {
            return;
        }
        $userEmail = $this->getUserEmail($user);
        $email = (new TemplatedEmail())
            ->to(Address::fromString($userEmail))
            ->subject(sprintf('Welcome to %s', $this->websiteName))
            ->htmlTemplate('@SilverbackApiComponent/emails/user_welcome.html.twig')
            ->context([
                'user' => $user,
                'website_name' => $this->websiteName,
            ]);
        $this->mailer->send($email);
    }

    public function sendUserEnabledEmail(AbstractUser $user): void
    {
        if (!$this->sendUserEnabledEmailEnabled) {
            return;
        }
        $userEmail = $this->getUserEmail($user);
        $email = (new TemplatedEmail())
            ->to(Address::fromString($userEmail))
            ->subject('Your account has been enabled')
            ->htmlTemplate('@SilverbackApiComponent/emails/user_enabled.html.twig')
            ->context([
                'user' => $user,
                'website_name' => $this->websiteName,
            ]);
        $this->mailer->send($email);
    }

    public function sendUsernameChangedEmail(AbstractUser $user): void
    {
        if (!$this->sendUserUsernameChangedEmailEnabled) {
            return;
        }
        $userEmail = $this->getUserEmail($user);
        $email = (new TemplatedEmail())
            ->to(Address::fromString($userEmail))
            ->subject('Your username has been changed')
            ->htmlTemplate('@SilverbackApiComponent/emails/username_changed.html.twig')
            ->context([
                'user' => $user,
                'website_name' => $this->websiteName,
            ]);
        $this->mailer->send($email);
    }

    public function sendPasswordChangedEmail(AbstractUser $user): void
    {
        if (!$this->sendUserPasswordChangedEmailEnabled) {
            return;
        }
        $userEmail = $this->getUserEmail($user);
        $email = (new TemplatedEmail())
            ->to(Address::fromString($userEmail))
            ->subject('Your password has been changed')
            ->htmlTemplate('@SilverbackApiComponent/emails/user_password_changed.html.twig')
            ->context([
                'user' => $user,
                'website_name' => $this->websiteName,
            ]);
        $this->mailer->send($email);
    }

    private function getUserEmail(AbstractUser $user): string
    {
        if (!($userEmail = $user->getEmailAddress())) {
            throw new InvalidParameterException('The user must have an email address to send a password reset email');
        }

        return $userEmail;
    }

    private function pathToReferrerUrl(string $token, string $email, string $queryKey, string $defaultPath): string
    {
        $request = $this->requestStack->getCurrentRequest();
        $path = $request ? $request->query->get($queryKey, $defaultPath) : $defaultPath;
        $urlParts = $request ? parse_url($request->headers->get('referer')) : ['scheme' => 'https', 'host' => 'no-referrer'];
        $path = str_replace(['{{ token }}', '{{ email }}'], [$token, $email], $path);

        return sprintf(
            '%s://%s/%s',
            $urlParts['scheme'],
            $urlParts['host'],
            ltrim($path, '/')
        );
    }
}

components-web-app / api-components-bundle

Push — v2 ( 227daa...82a867 )

UserMailer::sendPasswordChangedEmail() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
