MailerTrait::getFrom() - Code Metrics - Inspection of "Big refactoring" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#190)

by Arman
created 2025-01-26 14:40 UTC
MailerTrait::getFrom() A

↳ Parent: MailerTrait
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10
<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <[email protected]>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.9.5
 */

namespace Quantum\Libraries\Mailer\Traits;

use Quantum\Libraries\Mailer\Contracts\MailerInterface;
use Quantum\Di\Exceptions\DiException;
use Quantum\Libraries\Mailer\MailTrap;
use Quantum\Debugger\Debugger;
use ReflectionException;
use Exception;

/**
 * trait MailerTrait
 * @package Quantum\Libraries\Mailer
 */
trait MailerTrait
{

    /**
     * From address and name
     * @var array
     */
    private $from = [];

    /**
     * To addresses
     * @var array
     */
    private $addresses = [];

    /**
     * Email subject
     * @var string
     */
    private $subject = null;

    /**
     * Email body
     * @var string|array
     */
    private $message = null;

    /**
     * @var string
     */
    private static $messageId = null;

    /**
     * Template path
     * @var string
     */
    private $templatePath = null;

    /**
     * Sets the 'From' email and the name
     * @param string $email
     * @param string|null $name
     * @return MailerInterface
     */
    public function setFrom(string $email, ?string $name = null): MailerInterface
    {
        $this->from['email'] = $email;
        $this->from['name'] = $name;
        return $this;

    }

    /**
     * Gets 'From' email and the "name"
     * @return array
     */
    public function getFrom(): array
    {
        return $this->from;
    }

    /**
     * Sets 'To' addresses
     * @param string $email
     * @param string|null $name
     * @return MailerInterface
     */
    public function setAddress(string $email, ?string $name = null): MailerInterface
    {
        $this->addresses[] = [
            'email' => $email,
            'name' => $name
        ];

        return $this;

    }

    /**
     * Gets 'To' addresses
     * @return array
     */
    public function getAddresses(): array
    {
        return $this->addresses;
    }

    /**
     * Sets the subject
     * @param string|null $subject
     * @return MailerInterface
     */
    public function setSubject(?string $subject): MailerInterface
    {
        $this->subject = $subject;
        return $this;

    }

    /**
     * Gets the subject
     * @return string
     */
    public function getSubject(): ?string
    {
        return $this->subject;
    }

    /**
     * Sets the template
     * @param string $templatePath
     * @return MailerInterface
     */
    public function setTemplate(string $templatePath): MailerInterface
    {
        $this->templatePath = $templatePath;
        return $this;

    }

    /**
     * Gets the template
     * @return string|null
     */
    public function getTemplate(): ?string
    {
        return $this->templatePath;
    }

    /**
     * Sets the body
     * @param string|array $message
     * @return MailerInterface
     */
    public function setBody($message): MailerInterface
    {
        $this->message = $message;
        return $this;

    }

    /**
     * Gets the body
     * @return array|string|null
     */
    public function getBody()
    {
        return $this->message;
    }

    /**
     * @inheritDoc
     * @throws DiException
     * @throws ReflectionException
     * @throws Exception
     */
    public function send(): bool
    {
        $this->prepare();
               prepare();

        if (config()->get('mailer.mail_trap')) {
            $sent = $this->saveEmail();
        } else {
            $sent = $this->sendEmail();
            $sent = $this->sendEmail();
        }

        $this->resetFields();

        if (__CLASS__ != __NAMESPACE__ . '\\SmtpAdapter') {

            if (!$sent) {
                warning($this->httpClient->getErrors(), ['tab' => Debugger::MAILS]);
            }
        }

        return $sent;
    }

    /**
     * Gets the message ID
     * @return string
     * @throws Exception
     */
    public function getMessageId(): string
    {
        if (self::$messageId) {
            return self::$messageId;
        }

        if (__CLASS__ == __NAMESPACE__ . '\\SmtpAdapter') {

            preg_match('/<(.*?)@/', preg_quote($this->mailer->getLastMessageID()), $matches);
            self::$messageId = $matches[1];
        } else {
            self::$messageId = bin2hex(random_bytes(16));
        }

        return self::$messageId;
    }

    /**
     * @return bool
     * @throws \PHPMailer\PHPMailer\Exception
     * @throws Exception
     */
    private function saveEmail(): bool
    {
        if (__CLASS__ == __NAMESPACE__ . '\\SmtpAdapter') {

            $this->mailer->preSend();
        }

        return MailTrap::getInstance()->saveMessage($this->getMessageId(), $this->getMessageContent());
    }

    /**
     * Create message body from email template
     * @return string
     */
    private function createFromTemplate(): string
    {
        ob_start();
        ob_implicit_flush(0);

        if (is_array($this->message)) {
            extract($this->message, EXTR_OVERWRITE);
        }

        require $this->templatePath . '.php';

        return ob_get_clean();
    }

    /**
     * Gets the complete message
     * @return string
     * @throws Exception
     */
    private function getMessageContent(): string
    {
        if (__CLASS__ == __NAMESPACE__ . '\\SmtpAdapter') {

            return $this->mailer->getSentMIMEMessage();
        }

        return $this->generateMessage();
    }

    /**
     * Generates the message content
     * @return string
     * @throws Exception
     */
    private function generateMessage(): string
    {
        $message = 'Date: ' . date('D, j M Y H:i:s O') . PHP_EOL;

        $message .= 'To: ';

        foreach ($this->addresses as $address) {
            $message .= $address['name'] . ' <' . $address['email'] . '>' . PHP_EOL;
        }

        $message .= 'From: ' . $this->from['name'] . ' <' . $this->from['email'] . '>' . PHP_EOL;

        $message .= 'Subject: ' . $this->subject . PHP_EOL;

        $message .= 'Message-ID: <' . $this->getMessageId() . '@' . base_url() . '>' . PHP_EOL;

        $message .= 'X-Mailer: ' . $this->name . PHP_EOL;

        $message .= 'MIME-Version: 1.0' . PHP_EOL;

        $message .= 'Content-Type: text/html; charset=UTF-8' . PHP_EOL . PHP_EOL;

        $message .= $this->message . PHP_EOL;
        $message .= /** @scrutinizer ignore-type */ $this->message . PHP_EOL;

        return $message;
    }

    /**
     * Resets the fields
     */
    private function resetFields()
    {
        $this->from = [];
        $this->addresses = [];
        $this->subject = null;
        $this->message = null;
        $this->templatePath = null;

        if (__CLASS__ == __NAMESPACE__ . '\\SmtpAdapter') {

            $this->replyToAddresses = [];
            $this->ccAddresses = [];
            $this->bccAddresses = [];
            $this->attachments = [];
            $this->stringAttachments = [];

            $this->mailer->clearAddresses();
            $this->mailer->clearCCs();
            $this->mailer->clearBCCs();
            $this->mailer->clearReplyTos();
            $this->mailer->clearAllRecipients();
            $this->mailer->clearAttachments();
            $this->mailer->clearCustomHeaders();
        }
    }
}
softberg / quantum-php-core

Pull Request — master (#190)

MailerTrait::getFrom() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
