Mailer::setAttachment() - Code Metrics - Inspection of "Ability to use 3rd party email service" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#128)

unknown
created 2023-01-30 13:38 UTC
Mailer::setAttachment() A

↳ Parent: Mailer
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	2
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
nc	1
nop	1
<?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.0
 */

namespace Quantum\Libraries\Mailer;

use SendinBlue\Client\Api\TransactionalEmailsApi;
use SendinBlue\Client\Model\SendSmtpEmail;
use Quantum\Libraries\Storage\FileSystem;
use SendinBlue\Client\Configuration;
use PHPMailer\PHPMailer\PHPMailer;
use Quantum\Debugger\Debugger;
use Quantum\Logger\FileLogger;
use PHPMailer\PHPMailer\SMTP;
use Quantum\Loader\Setup;
use GuzzleHttp\Client;
use Psr\Log\LogLevel;
use Quantum\Di\Di;

/**
 * Mailer class
 * @package Quantum\Libraries\Mailer
 * @uses \PHPMailer\PHPMailer\PHPMailer
 */
class Mailer
{

    /**
     * PHP Mailer instance
     * @var \PHPMailer\PHPMailer\PHPMailer
     */
    private $mailer;

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

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

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

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

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

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

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

    /**
     * Email attachments
     * @var array
     */
    private $attachments = [];

    /**
     * Email attachments created from string
     * @var array
     */
    private $stringAttachments = [];

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

    /**
     * Sendinblue api key
     * @var string | null
     */
    private $api_key = null;

    /**
     * Html message content
     * @var string | null
     */
    private $htmlContent = null;

    /**
     * Mailer constructor.
     */
    public function __construct()
    {
        if (!config()->has('mailer') || !config()->has('mailer.current')) {
            config()->import(new Setup('config', 'mailer'));
        }

        if (config()->get('mailer')['current'] === 'default') {
            $this->mailer = new PHPMailer(true);
            $this->mailer->CharSet = 'UTF-8';
            if (config()->has('mailer.default.mail_host')) {
                $this->setupSmtp();
                $this->setupDebugging();
            } else {
                $this->mailer->isMail();
            }
            $this->mailer->AllowEmpty = true;
            $this->mailer->isHTML(true);
        } elseif (config()->get('mailer')['current'] == 'sendinblue') {
            $this->api_key = config()->get('mailer')['sendinblue']['api_key'];
        }
    }

    /**
     * Sets the from email and the name
     * @param string $email
     * @param string|null $name
     * @return $this
     */
    public function setFrom(string $email, ?string $name = null): Mailer
    {
        $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 $this
     */
    public function setAddress(string $email, ?string $name = null): Mailer
    {
        array_push($this->addresses, [
            'email' => $email,
            'name' => $name
        ]);

        return $this;
    }

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

    /**
     * Sets "Reply-To" addresses
     * @param string $email
     * @param string|null $name
     * @return $this
     */
    public function setReplay(string $email, ?string $name = null): Mailer
    {
        array_push($this->replyToAddresses, [
            'email' => $email,
            'name' => $name
        ]);

        return $this;
    }

    /**
     * Gets "Reply-To" addresses
     * @return array
     */
    public function getReplays(): array
    {
        return $this->replyToAddresses;
    }

    /**
     * Sets "CC" addresses
     * @param string $email
     * @param string|null $name
     * @return $this
     */
    public function setCC(string $email, ?string $name = null): Mailer
    {
        array_push($this->ccAddresses, [
            'email' => $email,
            'name' => $name
        ]);

        return $this;
    }

    /**
     * Gets "CC" addresses
     * @return array
     */
    public function getCCs(): array
    {
        return $this->ccAddresses;
    }

    /**
     * Sets "BCC" addresses
     * @param string $email
     * @param string|null $name
     * @return $this
     */
    public function setBCC(string $email, ?string $name = null): Mailer
    {
        array_push($this->bccAddresses, [
            'email' => $email,
            'name' => $name
        ]);

        return $this;
    }

    /**
     * Get "BCC" addresses
     * @return array
     */
    public function getBCCs(): array
    {
        return $this->bccAddresses;
    }

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

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

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

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

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

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

    /**
     * Sets attachments from the path on the filesystem
     * @param string $attachments
     * @return $this
     */
    public function setAttachment(string $attachments): Mailer
    {
        array_push($this->attachments, $attachments);
        return $this;
    }

    /**
     * Gets the attachments
     * @return array
     */
    public function getAttachments(): array
    {
        return $this->attachments;
    }

    /**
     * Sets attachment from the string
     * @param string $content
     * @param string $filename
     * @return $this
     */
    public function setStringAttachment(string $content, string $filename): Mailer
    {
        array_push($this->stringAttachments, [
            'content' => $content,
            'filename' => $filename
        ]);

        return $this;
    }

    /**
     * Gets the string attachments
     * @return array
     */
    public function getStringAttachments(): array
    {
        return $this->stringAttachments;
    }

    /**
     * Sends the email
     * @param array|null $from
     * @param array|null $address
     * @param string|null $message
     * @param array|null $options
     * @return bool
     * @throws \PHPMailer\PHPMailer\Exception
     * @throws \Quantum\Exceptions\DiException
     * @throws \ReflectionException
     */
    public function send(?array $from = null, ?array $address = null, ?string $message = null, ?array $options = []): bool
    {
        if ($from) {
            $this->setFrom(...$from);
            $this->setFrom(/** @scrutinizer ignore-type */ ...$from);
        }

        if ($address) {
            $this->setAddress(...$address);
            $this->setAddress(/** @scrutinizer ignore-type */ ...$address);
        }

        if ($message) {
            $this->setBody($message);
        }

        $this->setOptions($options);
        if (config()->get('mailer')['current'] == 'default') {
            $this->prepare();

            if (config()->get('mailer')['default']['mail_trap']) {
                $sent = $this->mailer->preSend();
                $this->saveMessage($this->mailer->getLastMessageID(), $this->mailer->getSentMIMEMessage());
                return $sent;
            } else {
                return $this->mailer->send();
            }
        } else if (config()->get('mailer')['current'] == 'sendinblue') {
            $config = Configuration::getDefaultConfiguration()->setApiKey('api-key', $this->api_key);
            $client = new TransactionalEmailsApi(
                new Client(),
                $config
            );

            if ($this->message) {
                if ($this->templatePath) {
                    $body = $this->createFromTemplate();
                } else {
                    $body = is_array($this->message) ? implode($this->message) : $this->message;
                }

                $this->htmlContent = $body;
            }

            $sendSmtpEmail = new SendSmtpEmail();
            $sendSmtpEmail['subject'] = $this->subject;
            $sendSmtpEmail['htmlContent'] = $this->htmlContent;
            $sendSmtpEmail['sender'] = $this->from;
            $sendSmtpEmail['to'] = $this->addresses;

            try {
                $response = $client->sendTransacEmail($sendSmtpEmail);
                return 'Email sent successfully with ID: ' . $response->getMessageId();

            } catch (\Exception $e) {
                return 'Error sending email: ' . $e->getMessage();

            }
        }
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
    }

    /**
     * Save the message on local file
     * @param string $id
     * @param string $content
     * @throws \Quantum\Exceptions\DiException
     * @throws \ReflectionException
     */
    private function saveMessage(string $id, string $content)
    {
        $fs = Di::get(FileSystem::class);

        $emailsDirectory = base_dir() . DS . 'shared' . DS . 'emails';

        if ($fs->isDirectory($emailsDirectory)) {
            $fs->put($emailsDirectory . DS . $this->getFilename($id), $content);
        }
    }

    /**
     * Sets the options
     * @param array $options
     */
    private function setOptions(array $options)
    {
        foreach ($options as $name => $params) {
            if (method_exists(__CLASS__, $method = 'set' . ucfirst($name))) {
                if (is_array($params)) {
                    $this->$method(...$params);
                } else {
                    $this->$method($params);
                }
            }
        }
    }

    /**
     * Fetches message ID
     * @param string $lastMessageId
     * @return string
     */
    private function getFilename(string $lastMessageId): string
    {
        preg_match('/<(.*?)@/', $lastMessageId, $matches);
        return $matches[1] . '.eml';
    }

    /**
     * Prepares the data
     * @throws \PHPMailer\PHPMailer\Exception
     */
    private function prepare()
    {
        $this->mailer->setFrom($this->from['email'], $this->from['name']);

        if ($this->subject) {
            $this->mailer->Subject = $this->subject;
        }

        if ($this->message) {
            if ($this->templatePath) {
                $body = $this->createFromTemplate();
            } else {
                $body = is_array($this->message) ? implode($this->message) : $this->message;
            }

            $this->mailer->Body = $body;
        }

        $this->fillProperties('addAddress', $this->addresses);

        $this->fillProperties('addReplyTo', $this->replyToAddresses);

        $this->fillProperties('addCC', $this->ccAddresses);

        $this->fillProperties('addBCC', $this->bccAddresses);

        $this->fillProperties('addAttachment', $this->attachments);

        $this->fillProperties('addStringAttachment', $this->stringAttachments);
    }

    /**
     * Files the php mailer properties
     * @param string $method
     * @param array $fields
     */
    private function fillProperties(string $method, array $fields = [])
    {
        if (!empty($fields)) {
            foreach ($fields as $field) {
                if (is_string($field)) {
                    $this->mailer->$method($field);
                } else {
                    $valOne = current($field);
                    next($field);
                    $valTwo = current($field);
                    $this->mailer->$method($valOne, $valTwo);
                    reset($field);
                }
            }
        }
    }

    /**
     * Setups SMTP
     */
    private function setupSmtp()
    {
        $this->mailer->isSMTP();
        $this->mailer->SMTPAuth = true;
        $this->mailer->Host = config()->get('mailer')['default']['mail_host'];
        $this->mailer->SMTPSecure = config()->get('mailer')['default']['mail_secure'];
        $this->mailer->Port = config()->get('mailer')['default']['mail_port'];
        $this->mailer->Username = config()->get('mailer')['default']['mail_username'];
        $this->mailer->Password = config()->get('mailer')['default']['mail_password'];
    }

    /**
     * Setups the debugging
     */
    private function setupDebugging()
    {
        if (config()->get('debug')) {
            $this->mailer->SMTPDebug = SMTP::DEBUG_SERVER;

            $this->mailer->Debugoutput = function ($message) {
                Debugger::addToStore(Debugger::MAILS, LogLevel::WARNING, $message);

                $logFile = logs_dir() . DS . date('Y-m-d') . '.log';
                $logMessage = '[' . date('Y-m-d H:i:s') . '] ' . LogLevel::WARNING . ': ' . $message . PHP_EOL;

                warning($logMessage, new FileLogger($logFile));
            };
        } else {
            $this->mailer->SMTPDebug = SMTP::DEBUG_OFF;
        }
    }

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

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

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

        return ob_get_clean();
    }
}

softberg / quantum-php-core

Pull Request — master (#128)

Mailer::setAttachment() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
