Core\Mail\HTMLTemplateMessage

Complexity

Total Complexity

26

Size/Duplication

Total Lines	239
Duplicated Lines	3.77 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes	2
Bugs	2	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	__set()	0	4	1
A	__get()	0	9	2
A	__isset()	0	5	1
A	__unset()	0	8	2
A	getVariable()	0	9	2
A	setVariable()	0	5	1
C	setVariables()	9	27	8
A	getVariables()	0	4	1
A	clearVariables()	0	5	1
A	setTemplate()	0	5	1
A	getTemplate()	0	4	1
B	getBodyText()	0	33	3
A	factory()	0	4	1

<?php
/**
 * YAWIK
 *
 * @filesource
 * @copyright (c) 2013 - 2016 Cross Solution (http://cross-solution.de)
 * @license   MIT
 * @author    weitz@cross-solution.de
 */

namespace Core\Mail;

use Zend\Mail\Header;
use Zend\ServiceManager\ServiceLocatorInterface;
use Zend\View\Model\ViewModel;
use Zend\Stdlib\Response;
use Zend\View\Variables as ViewVariables;
use Zend\Stdlib\ArrayUtils;
use Core\Mail\MailService;

/**
 * Class HTMLTemplateMessage.
 * uses methods alike ViewModel
 * @package Core\Mail
 */
class HTMLTemplateMessage extends TranslatorAwareMessage
{
    /**
     * @var ServiceLocatorInterface
     */
    protected $serviceManager;

    /**
     * View variables
     * @var array|ArrayAccess&Traversable
     */
    protected $variables = array();

    /**
     * @param ServiceLocatorInterface $serviceManager
     * @param array $options
     */
    public function __construct(ServiceLocatorInterface $serviceManager, array $options = array())
    {
        // @TODO make this multipart
        parent::__construct($options);
        $this->serviceManager = $serviceManager;
        $this->getHeaders()->addHeader(Header\ContentType::fromString('Content-Type: text/html; charset=UTF-8'));
        $this->setEncoding('UTF-8');
        $this->variables = new ViewVariables();

It seems like new \Zend\View\Variables() of type object<Zend\View\Variables> is incompatible with the declared type array of property $variables.

    }

    /**
     * Property overloading: set variable value
     *
     * @param  string $name
     * @param  mixed $value
     * @return void
     */
    public function __set($name, $value)
    {
        $this->setVariable($name, $value);
    }

    /**
     * Property overloading: get variable value
     *
     * @param  string $name
     * @return mixed
     */
    public function __get($name)
    {
        if (!$this->__isset($name)) {
            return null;
        }

        $variables = $this->getVariables();
        return $variables[$name];
    }

    /**
     * Property overloading: do we have the requested variable value?
     *
     * @param  string $name
     * @return bool
     */
    public function __isset($name)

function __isset() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        $variables = $this->getVariables();
        return isset($variables[$name]);
    }

    /**
     * Property overloading: unset the requested variable
     *
     * @param  string $name
     * @return void
     */
    public function __unset($name)
    {
        if (!$this->__isset($name)) {
            return null;
        }

        unset($this->variables[$name]);
    }

    /**
     * Get a single view variable
     *
     * @param  string       $name
     * @param  mixed|null   $default (optional) default value if the variable is not present.
     * @return mixed
     */
    public function getVariable($name, $default = null)
    {
        $name = (string) $name;
        if (array_key_exists($name, $this->variables)) {
            return $this->variables[$name];
        }

        return $default;
    }

    /**
     * Set view variable
     *
     * @param  string $name
     * @param  mixed $value
     * @return ViewModel

Should the return type not be HTMLTemplateMessage?

     */
    public function setVariable($name, $value)
    {
        $this->variables[(string) $name] = $value;
        return $this;
    }

    /**
     * Set view variables en masse
     *
     * Can be an array or a Traversable + ArrayAccess object.
     *
     * @param  array|ArrayAccess|Traversable $variables
     * @param  bool $overwrite Whether or not to overwrite the internal container with $variables
     * @throws \InvalidArgumentException
     * @return self
     */
    public function setVariables($variables, $overwrite = false)
    {
        if (!is_array($variables) && !$variables instanceof \Traversable) {

This code seems to be duplicated across your project.

            throw new \InvalidArgumentException(
                sprintf(
                    '%s: expects an array, or Traversable argument; received "%s"',
                    __METHOD__,
                    (is_object($variables) ? get_class($variables) : gettype($variables))
                )
            );
        }

        if ($overwrite) {
            if (is_object($variables) && !$variables instanceof \ArrayAccess) {
                $variables = ArrayUtils::iteratorToArray($variables);
            }

            $this->variables = $variables;
            return $this;
        }

        foreach ($variables as $key => $value) {
            $this->setVariable($key, $value);
        }

        return $this;
    }

    /**
     * Get view variables
     *
     * @return array|ArrayAccess|Traversable
     */
    public function getVariables()
    {
        return $this->variables;
    }

    /**
     * Clear all variables
     *
     * Resets the internal variable container to an empty container.
     *
     * @return ViewModel

Should the return type not be HTMLTemplateMessage?

     */
    public function clearVariables()
    {
        $this->variables = new ViewVariables();

It seems like new \Zend\View\Variables() of type object<Zend\View\Variables> is incompatible with the declared type array of property $variables.

        return $this;
    }

    /**
     *
     *
     * @param $template
     *
     * @return self
     */
    public function setTemplate($template)
    {
        $this->template = $template;

The property template does not exist on object<Core\Mail\HTMLTemplateMessage>. Since you implemented __set, maybe consider adding a @property annotation.

        return $this;
    }

    public function getTemplate()
    {
        return $this->template;

The property template does not exist on object<Core\Mail\HTMLTemplateMessage>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * @example /module/Jobs/src/Jobs/Listener/PortalListener.php
     * @return string
     * @throws \InvalidArgumentException the mail body must completely be provided by the template, any other attempt is a misconception that may leave the coder in an quagmire
     */
    public function getBodyText()
    {
        $viewModel    = new ViewModel();
        $response     = new Response();
        $body         = parent::getBodyText();
        if (!empty($body)) {
            throw new \InvalidArgumentException('mail body shall come from Template.');
        }

        /* @var \Zend\Mvc\View\Http\ViewManager $viewManager */
        $viewManager  = $this->serviceManager->get('viewManager');
        $resolver = $this->serviceManager->get('viewResolver');

        /* @var \Zend\Mvc\MvcEvent $event */
        $event = $this->serviceManager->get('application')->getMvcEvent();
        $lang = $event->getRouteMatch()->getParam('lang');


        if ($resolver->resolve($this->getTemplate() . '.' . $lang)) {
            $viewModel->setTemplate($this->getTemplate() . '.' . $lang);
        }else{
            $viewModel->setTemplate($this->getTemplate());
        }

        $view         = $viewManager->getView();

        $viewModel->setVariables($this->getVariables());
        $view->setResponse($response);
        $view->render($viewModel);
        $body = $response->getContent();

        return $body;
    }
    
    /**
     * @param MailService $mailService
     * @return \Core\Mail\HTMLTemplateMessage
     */
    public static function factory(MailService $mailService)
    {
        return new static($mailService->getServiceLocator());
    }
}