MailService::setQueue() - Code Metrics - Inspection of "Merge pull request #616: Mail Queue" - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( d04c5a...d84490 )

by Mathias
created 2020-12-29 17:37 UTC
MailService::setQueue() A

↳ Parent: MailService
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
ccs	0
cts	0
cp	0
rs	10
cc	1
nc	1
nop	1
crap	2
<?php
/**
 * YAWIK
 *
 * @filesource
 * @copyright (c) 2013 - 2016 Cross Solution (http://cross-solution.de)
 * @license       MIT
 */

/** */
namespace Core\Mail;

use Core\Exception\MissingDependencyException;
use Core\Factory\ContainerAwareInterface;
use Core\Queue\Job\MailJob;
use Core\Queue\MongoQueue;
use Interop\Container\ContainerInterface;
use Laminas\I18n\Translator\TranslatorAwareInterface;
use Laminas\Mail\Address;
use Laminas\Mail\AddressList;
use Laminas\Mail\Message as MailMessage;
use Laminas\Mail\Transport\TransportInterface;
use Laminas\ServiceManager\AbstractPluginManager;
use Laminas\ServiceManager\ConfigInterface;
use Laminas\ServiceManager\ServiceLocatorInterface;

/**
 * Mail Plugin Manager
 *
 * @author Mathias Gelhausen <[email protected]>
 * @author Mathias Weitz <[email protected]>
 * @author Carsten Bleek <[email protected]>
 * @author Anthonius Munthi <[email protected]>
 */
class MailService extends AbstractPluginManager
{
    /**
     * Define transport type to use
     */
    const TRANSPORT_SMTP        = 'smtp';
    const TRANSPORT_FILE        = 'file';
    const TRANSPORT_SENDMAIL    = 'sendmail';

    /**
     * The mail Transport
     *
     * @var TransportInterface
     */
    protected $transport;

    /**
     * Default from address to use if no from address is set in the mail.
     *
     * @var string
     */
    protected $from;

    /**
     * Value for the X-Mailer header.
     *
     * @var string
     */
    protected $mailer;

    /**
     * If set, all mails are send to the addresses in this list
     *
     * This is useful when developing.
     *
     * @var AddressList|null
     */
    protected $overrideRecipient;

    protected $language;

    protected $shareByDefault = false;

    protected $invokableClasses = array(
        'simple'         => '\Laminas\Mail\Message',
        'stringtemplate' => '\Core\Mail\StringTemplateMessage',
    );

    protected $factories = array(
        'htmltemplate'   => [HTMLTemplateMessage::class,'factory'],
    );

    protected $queue;

    /**
     * Creates an instance.
     *
     * Adds two default initializers:
     * - Inject the translator to mails implementing TranslatorAwareInterface
     * - Call init() method on Mails if such method exists.
     *
     * @param ContainerInterface $container
     * @param mixed $configuration
     */
    public function __construct($container, $configuration = [])
    {
        parent::__construct($container, $configuration);

        $this->addInitializer(
            function ($context, $instance) {
                if ($instance instanceof TranslatorAwareInterface) {
                    $translator = $context->get('translator');
                    $instance->setTranslator($translator);
                    if (null === $instance->getTranslatorTextDomain()) {

                        $instance->setTranslatorTextDomain();
                    }
                    $instance->setTranslatorEnabled(true);
                }
                if ($instance instanceof ContainerAwareInterface) {
                    $instance->setContainer($context);
                }
            }
        );

        //@TODO: [ZF3] verify that removing this lines is save
        //$this->addInitializer(
        //   function ($context,$instance) {
        //        if (method_exists($instance, 'setServiceLocator')) {
        //            //$instance->setServiceLocator($this);
        //        }
        //   }
        //);

        $this->addInitializer(
            function ($context, $instance) {
                if (method_exists($instance, 'init')) {
                    $instance->init();
                }
            }
        );
    }

    /**
     * Checks that a plugin is a child of an email message.
     *
     * @throws \InvalidArgumentException
     */
    public function validate($plugin)
    {
        if (!$plugin instanceof MailMessage) {
            throw new \InvalidArgumentException(
                sprintf(
                    'Expected instance of \Laminas\Mail\Message but received %s',
                    get_class($plugin)
                )
            );
        }
    }

    /**
     * Gets the default from address
     *
     * @return null|String|Address|AddressList|array
     */
    public function getFrom()
    {
        return $this->from;
    }

    /**
     * Sets the default from address.
     *
     * @param string|AddressList|Address $email
     * @param String|null                $name
     *
     * @return self
     */
    public function setFrom($email, $name = null)
    {
        if (is_array($email)) {

            $this->from = [$email['email'] => $email['name']];
        } else {
            $this->from = is_object($email) || null === $name
                ? $email
                : array($email => $name);
        }

        return $this;
    }

    /**
     * Sets override recipients.
     *
     * @param AddressList $recipients
     *
     * @return self
     */
    public function setOverrideRecipient(AddressList $recipients)
    {
        $this->overrideRecipient = $recipients;

        return $this;
    }

    /**
     * Sends a mail.
     *
     * Sets default values where needed.
     *
     * @param string|MailMessage $mail
     * @param array          $options
     */
    public function send($mail, array $options = array())
    {
        if (!$mail instanceof MailMessage) {
            $mail = $this->get($mail, $options);
        }

        $headers   = $mail->getHeaders();
        $transport = $this->getTransport();

        if (!$mail->isValid() && $this->from) {
            $mail->setFrom($this->from);
        }

        if ($this->overrideRecipient instanceof AddressList) {
            $originalRecipient = $headers->get('to')->toString();
            $originalRecipient = $headers->get('to')->/** @scrutinizer ignore-call */ toString();
            if ($headers->has('cc')) {
                $originalRecipient .= '; ' . $headers->get('cc')->toString();
                $headers->removeHeader('cc');
            }
            if ($headers->has('bcc')) {
                $originalRecipient .= '; ' . $headers->get('bcc')->toString();
                $headers->removeHeader('bcc');
            }
            $headers->addHeaderLine('X-Original-Recipients', $originalRecipient);
            $mail->setTo($this->overrideRecipient);
        }

        if (!$headers->has('X-Mailer')) {
            $mailerHeader = new \Laminas\Mail\Header\GenericHeader('X-Mailer', $this->getMailer());
            $headers->addHeader($mailerHeader);
            $mailerHeader->setEncoding('ASCII'); // get rid of other encodings for this header!
        }

        /* Allow HTMLTemplateMails to alter subject in the view script.
         * As the Zend Transport class build subject before the getBodyText call,
         * we have to call it here.
         */
        if ($mail instanceof \Core\Mail\HTMLTemplateMessage) {
            $mail->getBodyText();
        }

        $transport->send($mail);
    }

    public function queue($mail, $queueOptions = null)
    {
        $this->queue->push(MailJob::create($mail), $queueOptions);
    }
    /**
     * Gets the transport.
     *
     * @return TransportInterface $transport
     */
    public function getTransport()
    {
        return $this->transport;
    }

    /**
     * Sets the transport
     *
     * @param TransportInterface $transport
     *
     * @return self
     */
    public function setTransport(TransportInterface $transport)
    {
        $this->transport = $transport;

        return $this;
    }

    /**
     * Gest the value of the X-Mailer header.
     *
     * @return string
     */
    public function getMailer()
    {
        return $this->mailer;
    }

    /**
     * Sets the value for the X-Mailer header
     *
     * @param string $mailer
     *
     * @return $this
     */
    public function setMailer($mailer)
    {
        $this->mailer = $mailer;

        return $this;
    }

    /**
     * Get queue
     *
     * @return MongoQueue
     */
    public function getQueue()
    {
        if (!$this->queue) {
            throw new MissingDependencyException(MongoQueue::class, $this);
        }

        return $this->queue;
    }

    /**
     * Set queue
     *
     * @param MongoQueue $queue
     */
    public function setQueue(MongoQueue $queue): void
    {
        $this->queue = $queue;
    }
}

cross-solution / YAWIK

Push — master ( d04c5a...d84490 )

MailService::setQueue() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
