AcMailer\Service\Factory\MailServiceAbstractFactory

Complexity

Total Complexity

46

Size/Duplication

Total Lines	260
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	17

Test Coverage

Coverage

98.32%

Importance

Changes	3
Bugs	0	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	createHelperPluginManager()	0	9	1
A	getSpecificConfig()	0	5	3
C	createServiceWithName()	0	59	11
B	createMessage()	0	28	6
C	createTransport()	0	32	8
A	setupTransportConfig()	0	10	3
B	createRenderer()	0	37	6
C	attachMailListeners()	0	22	8

<?php
namespace AcMailer\Service\Factory;

use AcMailer\Event\MailListenerAwareInterface;
use AcMailer\Event\MailListenerInterface;
use AcMailer\Factory\AbstractAcMailerFactory;
use AcMailer\Options\Factory\MailOptionsAbstractFactory;
use AcMailer\View\DefaultLayout;
use Zend\Mail\Transport\File;
use Zend\Mail\Transport\TransportInterface;
use Zend\Mvc\Service\ViewHelperManagerFactory;
use Zend\ServiceManager\Config;
use Zend\ServiceManager\Exception\ServiceNotFoundException;
use Zend\Mail\Message;
use Zend\Mail\Transport\Smtp;
use AcMailer\Service\MailService;
use AcMailer\Options\MailOptions;
use AcMailer\Exception\InvalidArgumentException;
use Zend\ServiceManager\ServiceLocatorInterface;
use Zend\View\HelperPluginManager;
use Zend\View\Renderer\PhpRenderer;
use Zend\View\Renderer\RendererInterface;
use Zend\View\Resolver\AggregateResolver;
use Zend\View\Resolver\TemplateMapResolver;
use Zend\View\Resolver\TemplatePathStack;

class MailServiceAbstractFactory extends AbstractAcMailerFactory
{
    const SPECIFIC_PART = 'mailservice';

    /**
     * @var MailOptions
     */
    protected $mailOptions;

    /**
     * Create service with name
     *
     * @param ServiceLocatorInterface $sm
     * @param $name
     * @param $requestedName
     * @return mixed
     */
    public function createServiceWithName(ServiceLocatorInterface $sm, $name, $requestedName)
    {
        $specificServiceName = explode('.', $name)[2];
        $this->mailOptions = $sm->get(

It seems like $sm->get(sprintf('%s.%s.%s', self::ACMAILER_PART, \AcMailer\Options\Factory\MailOptionsAbstractFactory::SPECIFIC_PART, $specificServiceName)) can also be of type array. However, the property $mailOptions is declared as type object<AcMailer\Options\MailOptions>. Maybe add an additional type check?

            sprintf('%s.%s.%s', self::ACMAILER_PART, MailOptionsAbstractFactory::SPECIFIC_PART, $specificServiceName)
        );

        // Create the service
        $message        = $this->createMessage();
        $transport      = $this->createTransport($sm);
        $renderer       = $this->createRenderer($sm);
        $mailService    = new MailService($message, $transport, $renderer);

        // Set subject
        $mailService->setSubject($this->mailOptions->getMessageOptions()->getSubject());

The method AcMailer\Service\MailService::setSubject() has been deprecated with message: Use $mailService->getMessage()->setSubject() instead

        // Set body, either by using a template or a raw body
        $body = $this->mailOptions->getMessageOptions()->getBody();
        if ($body->getUseTemplate()) {
            $defaultLayoutConfig = $body->getTemplate()->getDefaultLayout();
            if (isset($defaultLayoutConfig['path'])) {
                $params = isset($defaultLayoutConfig['params']) ? $defaultLayoutConfig['params'] : [];
                $captureTo = isset($defaultLayoutConfig['template_capture_to'])
                    ? $defaultLayoutConfig['template_capture_to']
                    : 'content';
                $mailService->setDefaultLayout(new DefaultLayout($defaultLayoutConfig['path'], $params, $captureTo));
            }
            $mailService->setTemplate($body->getTemplate()->toViewModel(), ['charset' => $body->getCharset()]);
        } else {
            $mailService->setBody($body->getContent(), $body->getCharset());
        }

        // Attach files
        $files = $this->mailOptions->getMessageOptions()->getAttachments()->getFiles();
        $mailService->addAttachments($files);

        // Attach files from dir
        $dir = $this->mailOptions->getMessageOptions()->getAttachments()->getDir();
        if ($dir['iterate'] === true && is_string($dir['path']) && is_dir($dir['path'])) {
            $files = $dir['recursive'] === true ?
                new \RecursiveIteratorIterator(
                    new \RecursiveDirectoryIterator($dir['path'], \RecursiveDirectoryIterator::SKIP_DOTS),
                    \RecursiveIteratorIterator::CHILD_FIRST
                ):
                new \DirectoryIterator($dir['path']);

            /* @var \SplFileInfo $fileInfo */
            foreach ($files as $fileInfo) {
                if ($fileInfo->isDir()) {
                    continue;
                }
                $mailService->addAttachment($fileInfo->getPathname());
            }
        }

        // Attach mail listeners
        $this->attachMailListeners($mailService, $sm);
        return $mailService;
    }

    /**
     * @return Message
     */
    protected function createMessage()
    {
        $options = $this->mailOptions->getMessageOptions();
        // Prepare Mail Message
        $message = new Message();
        $from = $options->getFrom();
        if (! empty($from)) {
            $message->setFrom($from, $options->getFromName());
        }
        $replyTo = $options->getReplyTo();
        if (! empty($replyTo)) {
            $message->setReplyTo($replyTo, $options->getReplyToName());
        }
        $to = $options->getTo();
        if (! empty($to)) {
            $message->setTo($to);
        }
        $cc = $options->getCc();
        if (! empty($cc)) {
            $message->setCc($cc);
        }
        $bcc = $options->getBcc();
        if (! empty($bcc)) {
            $message->setBcc($bcc);
        }

        return $message;
    }

    /**
     * @param ServiceLocatorInterface $sm
     * @return TransportInterface
     */
    protected function createTransport(ServiceLocatorInterface $sm)
    {
        $adapter = $this->mailOptions->getMailAdapter();
        // A transport instance can be returned as is
        if ($adapter instanceof TransportInterface) {
            return $this->setupTransportConfig($adapter);
        }

        // Check if the adapter is a service
        if (is_string($adapter) && $sm->has($adapter)) {
            /** @var TransportInterface $transport */
            $transport = $sm->get($adapter);
            if ($transport instanceof TransportInterface) {
                return $this->setupTransportConfig($transport);
            } else {
                throw new InvalidArgumentException(
                    'Provided mail_adapter service does not return a "Zend\Mail\Transport\TransportInterface" instance'
                );
            }
        }

        // Check if the adapter is one of Zend's default adapters
        if (is_string($adapter) && is_subclass_of($adapter, 'Zend\Mail\Transport\TransportInterface')) {

Due to PHP Bug #53727, is_subclass_of returns inconsistent results on some PHP versions for interfaces; you could instead use ReflectionClass::implementsInterface.

            return $this->setupTransportConfig(new $adapter());
        }

        // The adapter is not valid. Throw an exception
        throw new InvalidArgumentException(sprintf(
            'mail_adapter must be an instance of "Zend\Mail\Transport\TransportInterface" or string, "%s" provided',
            is_object($adapter) ? get_class($adapter) : gettype($adapter)
        ));
    }

    /**
     * @param TransportInterface $transport
     * @return TransportInterface
     */
    protected function setupTransportConfig(TransportInterface $transport)
    {
        if ($transport instanceof Smtp) {
            $transport->setOptions($this->mailOptions->getSmtpOptions());
        } elseif ($transport instanceof File) {
            $transport->setOptions($this->mailOptions->getFileOptions());

It seems like $this->mailOptions->getFileOptions() can be null; however, setOptions() does not accept null, maybe add an additional type check?

        }

        return $transport;
    }

    /**
     * @param ServiceLocatorInterface $sm
     * @return RendererInterface
     */
    protected function createRenderer(ServiceLocatorInterface $sm)
    {
        // Try to return the configured renderer. If it points to an undefined service, create a renderer on the fly
        $serviceName = $this->mailOptions->getRenderer();

        try {
            $renderer = $sm->get($serviceName);

The expression $sm->get($serviceName); of type object|array adds the type array to the return on line 199 which is incompatible with the return type documented by AcMailer\Service\Factory\MailServiceAbstractFactory::createRenderer of type Zend\View\Renderer\RendererInterface.

            return $renderer;
        } catch (ServiceNotFoundException $e) {
            // In case the renderer service is not defined, try to construct it
            $vmConfig = $this->getSpecificConfig($sm, 'view_manager');
            $renderer = new PhpRenderer();

            // Check what kind of view_manager configuration has been defined
            if (isset($vmConfig['template_map']) && isset($vmConfig['template_path_stack'])) {
                // If both a template_map and a template_path_stack have been defined, create an AggregateResolver
                $pathStackResolver = new TemplatePathStack();
                $pathStackResolver->setPaths($vmConfig['template_path_stack']);
                $resolver = new AggregateResolver();
                $resolver->attach($pathStackResolver)
                    ->attach(new TemplateMapResolver($vmConfig['template_map']));
                $renderer->setResolver($resolver);
            } elseif (isset($vmConfig['template_map'])) {
                // Create a TemplateMapResolver in case only the template_map has been defined
                $renderer->setResolver(new TemplateMapResolver($vmConfig['template_map']));
            } elseif (isset($vmConfig['template_path_stack'])) {
                // Create a TemplatePathStack resolver in case only the template_path_stack has been defined
                $pathStackResolver = new TemplatePathStack();
                $pathStackResolver->setPaths($vmConfig['template_path_stack']);
                $renderer->setResolver($pathStackResolver);
            }

            // Create a HelperPluginManager with default view helpers and user defined view helpers
            $renderer->setHelperPluginManager($this->createHelperPluginManager($sm));
            return $renderer;
        }
    }

    /**
     * Creates a view helper manager
     * @param ServiceLocatorInterface $sm
     * @return HelperPluginManager
     */
    protected function createHelperPluginManager(ServiceLocatorInterface $sm)
    {
        $factory = new ViewHelperManagerFactory();
        /** @var HelperPluginManager $helperManager */
        $helperManager = $factory->createService($sm);
        $config = new Config($this->getSpecificConfig($sm, 'view_helpers'));
        $config->configureServiceManager($helperManager);
        return $helperManager;
    }

    /**
     * Returns a specific configuration defined by provided key
     * @param ServiceLocatorInterface $sm
     * @param $configKey
     * @return array
     */
    protected function getSpecificConfig(ServiceLocatorInterface $sm, $configKey)
    {
        $config = $sm->get('Config');
        return ! empty($config) && isset($config[$configKey]) ? $config[$configKey] : [];
    }

    /**
     * Attaches the preconfigured mail listeners to the mail service
     *
     * @param MailListenerAwareInterface $service
     * @param ServiceLocatorInterface $sm
     * @throws InvalidArgumentException
     */
    protected function attachMailListeners(MailListenerAwareInterface $service, ServiceLocatorInterface $sm)
    {
        $listeners = $this->mailOptions->getMailListeners();
        foreach ($listeners as $listener) {
            // Try to fetch the listener from the ServiceManager or lazily create an instance
            if (is_string($listener) && $sm->has($listener)) {
                $listener = $sm->get($listener);
            } elseif (is_string($listener) && class_exists($listener)) {
                $listener = new $listener();
            }

            // At this point, the listener should be an instance of MailListenerInterface, otherwise it is invalid
            if (! $listener instanceof MailListenerInterface) {
                throw new InvalidArgumentException(sprintf(
                    'Provided listener of type "%s" is not valid. '
                    . 'Expected "string" or "AcMailer\Listener\MailListenerInterface"',
                    is_object($listener) ? get_class($listener) : gettype($listener)
                ));
            }
            $service->attachMailListener($listener);
        }
    }
}