Azine\EmailBundle\Services\AzineWebViewService

Complexity

Total Complexity

6

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	1	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	addTemplate()	0	13	1
A	getTemplatesForWebPreView()	0	9	1
A	__construct()	0	3	1
A	addTestMailAccount()	0	5	1
A	getTestMailAccounts()	0	7	1
A	getDummyVarsFor()	0	24	1

<?php

namespace Azine\EmailBundle\Services;

use Symfony\Component\Routing\Generator\UrlGeneratorInterface;

/**
 * You must override this service for your needs. Also see ExampleAzineWebViewSerive for some examples.
 *
 * @author dominik
 */
class AzineWebViewService implements WebViewServiceInterface
{
    /**
     * (non-PHPdoc).
     *
     * @see Azine\EmailBundle\Services.WebViewServiceInterface::getTemplatesForWebPreView()
     */
    public function getTemplatesForWebPreView()
    {
        $templates = array();
        $templates = $this->addTemplate($templates, 'Reset Passwort Email', AzineTemplateProvider::FOS_USER_PWD_RESETTING_TEMPLATE);
        $templates = $this->addTemplate($templates, 'Account activation', AzineTemplateProvider::FOS_USER_REGISTRATION_TEMPLATE);
        // override this method to add your own templates
        // $templates =$this->addTemplate($templates, "Some other mail",	ExampleTemplateProvider::SOME_OTHER_MAIL_TEMPLATE);
        // $templates =$this->addTemplate($templates, "VIP Infos",	ExampleTemplateProvider::VIP_INFO_MAIL_TEMPLATE);
        return $templates;
    }

    /**
     * (non-PHPdoc).
     *
     * @see Azine\EmailBundle\Services.WebViewServiceInterface::getTestMailAccounts()
     */
    public function getTestMailAccounts()
    {
        $emails = array();
        // override this method to add your own emails
        // $emails = $this->addTestMailAccount($emails, 'Testmail-account for MS Outlook',	'your.email.address@for.an.outlook.client.com');
        // $emails = $this->addTestMailAccount($emails, 'Testmail-account for Gmail', 	'your.email.address@gmail');
        return $emails;
    }

    /**
     * (non-PHPdoc).
     *
     * @see Azine\EmailBundle\Services.WebViewServiceInterface::getDummyVarsFor()
     */
    public function getDummyVarsFor($template, $locale, $variables = array())
    {
        $variables['subject'] = 'some dummy subject';
        $variables['sendMailAccountName'] = 'some name';
        $variables['sendMailAccountAddress'] = 'no-reply@email.com';

        // override this method to provide dummy-variables
        // to view rendered templates for emails that you didn't send yet
        // or to send an email with dummy-variables to your test-account(s)
        //
        // do something like this:
        //
        // if ($template == ExampleTemplateProvider::VIP_INFO_MAIL_TEMPLATE) {
        // 	$vipVars = array();
        // 	$vipVars['vipInfos'] = $someService->getVipInfosFor($aUser);
        // 	$vipVars['userTitle'] = "You majesty";
        // 	$variables['contentItems'][] = array(ExampleTemplateProvider::VIP_INFO_MAIL_TEMPLATE, $vipVars);

        // } elseif ($template == ExampleTemplateProvider::SOME_OTHER_MAIL_TEMPLATE) {
        // 	$otherMailVars = array();
        // 	$otherMailVars['date'] = new \DateTime("long ago");
        // 	$variables['contentItems'][] = array(ExampleTemplateProvider::SOME_OTHER_MAIL_TEMPLATE, $otherMailVars);
        // }
        return $variables;
    }

    /**
     * @param UrlGeneratorInterface $router
     */
    public function __construct(UrlGeneratorInterface $router)
    {
        $this->router = $router;
    }

    //////////////////////////////////////////////////////////////////////////
    /* You probably don't need to change or override any of the stuff below */
    //////////////////////////////////////////////////////////////////////////

    /**
     * @var UrlGeneratorInterface
     */
    protected $router;

    /**
     * Add an email of a test account, you might want to send html-emails to, to verify the template before sending the emails to "real" recipients/users.
     *
     * @param array  $emails
     * @param string $description
     * @param string $emailAddress
     *
     * @return array the array with the added email-test-account
     */
    protected function addTestMailAccount(array $emails, $description, $emailAddress)
    {
        $emails[] = array('accountDescription' => $description, 'accountEmail' => $emailAddress);

        return $emails;
    }

    /**
     * Add the required variables to the $templates-array, so the line can be rendered in the template-index.
     *
     * @param array  $templates
     * @param string $description
     * @param string $templateId
     * @param array  $formats
     *
     * @return array
     */
    protected function addTemplate($templates, $description, $templateId, $formats = array('txt', 'html'))
    {
        $route = $this->router->generate('azine_email_web_preview', array('template' => urlencode($templateId)));

        $template = array('url' => $route,
                            'description' => $description,
                            'formats' => $formats,
                            'templateId' => $templateId,
        );

        $templates[] = $template;

        return $templates;
    }
}