Kaliop\eZMigrationBundle\Core\Executor\MailExecutor

Complexity

Total Complexity

23

Size/Duplication

Total Lines	134
Duplicated Lines	24.63 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	execute()	16	16	3
F	send()	0	50	13
A	resolveReferencesRecursively()	11	11	3
A	resolveReferencesInText()	6	18	3

<?php

namespace Kaliop\eZMigrationBundle\Core\Executor;

use Kaliop\eZMigrationBundle\API\Value\MigrationStep;
use Kaliop\eZMigrationBundle\API\ReferenceResolverInterface;
use Kaliop\eZMigrationBundle\Core\ReferenceResolver\PrefixBasedResolverInterface;
use Swift_Message;
use Swift_Attachment;

class MailExecutor extends AbstractExecutor
{
    protected $supportedStepTypes = array('mail');
    protected $supportedActions = array('send');

    protected $mailService;
    /** @var ReferenceResolverInterface $referenceResolver */
    protected $referenceResolver;

    public function __construct($mailService, PrefixBasedResolverInterface $referenceResolver)
    {
        $this->mailService = $mailService;
        $this->referenceResolver = $referenceResolver;
    }

    /**
     * @param MigrationStep $step
     * @return mixed
     * @throws \Exception
     */
    public function execute(MigrationStep $step)

This method seems to be duplicated in your project.

    {
        parent::execute($step);

        if (!isset($step->dsl['mode'])) {
            throw new \Exception("Invalid step definition: missing 'mode'");
        }

        $action = $step->dsl['mode'];

        if (!in_array($action, $this->supportedActions)) {
            throw new \Exception("Invalid step definition: value '$action' is not allowed for 'mode'");
        }

        return $this->$action($step->dsl, $step->context);
    }

    /**
     * @param array $dsl
     * @param array $context
     * @return true
     * @throws \Exception
     */
    protected function send($dsl, $context)

The parameter $context is not used and could be removed.

    {

        $message = Swift_Message::newInstance();

        if (isset($dsl['from'])) {
            $message->setFrom($this->resolveReferencesRecursively($dsl['from']));

The method Kaliop\eZMigrationBundle\Core\Executor\MailExecutor::resolveReferencesRecursively() has been deprecated with message: should be moved into the reference resolver classes

        }
        if (isset($dsl['to'])) {
            $message->setTo($this->resolveReferencesRecursively($dsl['to']));

The method Kaliop\eZMigrationBundle\Core\Executor\MailExecutor::resolveReferencesRecursively() has been deprecated with message: should be moved into the reference resolver classes

        }
        if (isset($dsl['cc'])) {
            $message->setCc($this->resolveReferencesRecursively($dsl['cc']));

The method Kaliop\eZMigrationBundle\Core\Executor\MailExecutor::resolveReferencesRecursively() has been deprecated with message: should be moved into the reference resolver classes

        }
        if (isset($dsl['bcc'])) {
            $message->setBcc($this->resolveReferencesRecursively($dsl['bcc']));

The method Kaliop\eZMigrationBundle\Core\Executor\MailExecutor::resolveReferencesRecursively() has been deprecated with message: should be moved into the reference resolver classes

        }
        if (isset($dsl['subject'])) {
            $message->setSubject($this->resolveReferencesInText($dsl['subject']));
        }
        if (isset($dsl['body'])) {
            $message->setBody($this->resolveReferencesInText($dsl['body']));
        }
        if (isset($dsl['attach'])) { /// @todo
            $message->attach(Swift_Attachment::fromPath($this->resolveReferencesRecursively($dsl['attach'])));

The method Kaliop\eZMigrationBundle\Core\Executor\MailExecutor::resolveReferencesRecursively() has been deprecated with message: should be moved into the reference resolver classes

        }

        if (isset($dsl['priority'])) {
            $message->setPriority($this->resolveReferencesRecursively($dsl['priority']));

The method Kaliop\eZMigrationBundle\Core\Executor\MailExecutor::resolveReferencesRecursively() has been deprecated with message: should be moved into the reference resolver classes

        }
        if (isset($dsl['read_receipt_to'])) {
            $message->setReadReceiptTo($this->resolveReferencesRecursively($dsl['read_receipt_to']));

The method Kaliop\eZMigrationBundle\Core\Executor\MailExecutor::resolveReferencesRecursively() has been deprecated with message: should be moved into the reference resolver classes

        }
        if (isset($dsl['return_path'])) {
            $message->setReturnPath($this->resolveReferencesRecursively($dsl['return_path']));

The method Kaliop\eZMigrationBundle\Core\Executor\MailExecutor::resolveReferencesRecursively() has been deprecated with message: should be moved into the reference resolver classes

        }
        if (isset($dsl['reply_to'])) {
            $message->setReplyTo($this->resolveReferencesRecursively($dsl['reply_to']));

The method Kaliop\eZMigrationBundle\Core\Executor\MailExecutor::resolveReferencesRecursively() has been deprecated with message: should be moved into the reference resolver classes

        }
        if (isset($dsl['sender'])) {
            $message->setSender($this->resolveReferencesRecursively($dsl['sender']));

The method Kaliop\eZMigrationBundle\Core\Executor\MailExecutor::resolveReferencesRecursively() has been deprecated with message: should be moved into the reference resolver classes

        }

        $this->mailService->send($message);

        // q: shall we set any reference?

        // q: what to return?
        return true;
    }

    /**
     * @deprecated should be moved into the reference resolver classes
     */
    protected function resolveReferencesRecursively($match)

This method seems to be duplicated in your project.

    {
        if (is_array($match)) {
            foreach ($match as $condition => $values) {
                $match[$condition] = $this->resolveReferencesRecursively($values);

The method Kaliop\eZMigrationBundle\Core\Executor\MailExecutor::resolveReferencesRecursively() has been deprecated with message: should be moved into the reference resolver classes

            }
            return $match;
        } else {
            return $this->referenceResolver->resolveReference($match);
        }
    }

    /**
     * Replaces any references inside a string
     *
     * @param string
     * @return string
     */
    protected function resolveReferencesInText($text)
    {
        // we need to alter the regexp we get from the resolver, as it will be used to match parts of text, not the whole string
        $regexp = substr($this->referenceResolver->getRegexp(), 1, -1);

It seems like you code against a concrete implementation and not the interface Kaliop\eZMigrationBundle\API\ReferenceResolverInterface as the method getRegexp() does only exist in the following implementations of said interface: Kaliop\eZMigrationBundle\Core\ReferenceResolver\AbstractResolver, Kaliop\eZMigrationBundle\Core\ReferenceResolver\ChainPrefixResolver, Kaliop\eZMigrationBundle\Core\ReferenceResolver\ChainRegexpResolver, Kaliop\eZMigrationBundle\Core\ReferenceResolver\ContentResolver, Kaliop\eZMigrationBundle\Core\ReferenceResolver\CustomReferenceResolver, Kaliop\eZMigrationBundle\Core\ReferenceResolver\LocationResolver, Kaliop\eZMigrationBundle\Core\ReferenceResolver\PrefixBasedResolver, Kaliop\eZMigrationBundle\Core\ReferenceResolver\TagResolver.

        // NB: here we assume that all regexp resolvers give us a regexp with a very specific format...
        $regexp = '/\[' . preg_replace(array('/^\^/'), array('', ''), $regexp) . '[^]]+\]/';

        $count = preg_match_all($regexp, $text, $matches);
        // $matches[0][] will have the matched full string eg.: [reference:example_reference]
        if ($count) {

This code seems to be duplicated across your project.

            foreach ($matches[0] as $referenceIdentifier) {
                $reference = $this->referenceResolver->getReferenceValue(substr($referenceIdentifier, 1, -1));
                $text = str_replace($referenceIdentifier, $reference, $text);
            }
        }

        return $text;
    }
}