brightnucleus / chainmail

config/defaults.php

Indentation +127 added lines, -127 removed lines

@@ -16,175 +16,175 @@
  * `ConfigInterface` to the `ChainMail` constructor.
  */
 return [
-    /*
+	/*
      * Root location that contains the view files to be rendered. These are
      * referenced by the individual sections & templates when choosing a
      * specific view to be rendered.
      */
-    'view_root_locations' => [
-        'default' => realpath(__DIR__ . '/../views'),
-    ],
+	'view_root_locations' => [
+		'default' => realpath(__DIR__ . '/../views'),
+	],
 
-    /*
+	/*
      * The default template to when none is specified.
      */
-    'default_template'    => 'BasicTemplate',
+	'default_template'    => 'BasicTemplate',
 
-    /*
+	/*
      * The formats in which an email can be rendered.
      * Each format needs a `Mail` implementation, a
      * `Validator` implementation, as well as a `Sanitizer`
      * implementation.
      */
-    'formats'             => [
+	'formats'             => [
 
-        /*
+		/*
          * The `html` format should be the default format when using responsive
          * emails.
          */
-        'html' => [
-            'mail'      => 'HTMLMail',
-            'validator' => 'HTMLValidator',
-            'sanitizer' => 'HTMLSanitizer',
-        ],
+		'html' => [
+			'mail'      => 'HTMLMail',
+			'validator' => 'HTMLValidator',
+			'sanitizer' => 'HTMLSanitizer',
+		],
 
-        /*
+		/*
          * The `text` format is meant to be used a as a fallback, and can also
          * be sent as backup content embedded within HTML emails.
          */
-        'text' => [
-            'mail'      => 'TextMail',
-            'validator' => 'TextValidator',
-            'sanitizer' => 'TextSanitizer',
-        ],
-    ],
+		'text' => [
+			'mail'      => 'TextMail',
+			'validator' => 'TextValidator',
+			'sanitizer' => 'TextSanitizer',
+		],
+	],
 
-    /*
+	/*
      * The `Mail` implementations that are provided.
      */
-    'mails'               => [
-        'HTMLMail' => [
-            'class_name' => 'BrightNucleus\ChainMail\Mail\HTMLMail',
-        ],
-        'TextMail' => [
-            'class_name' => 'BrightNucleus\ChainMail\Mail\TextMail',
-        ],
-    ],
+	'mails'               => [
+		'HTMLMail' => [
+			'class_name' => 'BrightNucleus\ChainMail\Mail\HTMLMail',
+		],
+		'TextMail' => [
+			'class_name' => 'BrightNucleus\ChainMail\Mail\TextMail',
+		],
+	],
 
-    /*
+	/*
      * The `Validator` implementations that are provided.
      */
-    'validators'          => [
-        'HTMLValidator' => [
-            'class_name' => 'BrightNucleus\ChainMail\Validator\HTMLValidator',
-        ],
-        'TextValidator' => [
-            'class_name' => 'BrightNucleus\ChainMail\Validator\TextValidator',
-        ],
-    ],
+	'validators'          => [
+		'HTMLValidator' => [
+			'class_name' => 'BrightNucleus\ChainMail\Validator\HTMLValidator',
+		],
+		'TextValidator' => [
+			'class_name' => 'BrightNucleus\ChainMail\Validator\TextValidator',
+		],
+	],
 
-    /*
+	/*
      * The `Sanitizer` implementations that are provided.
      */
-    'sanitizers'          => [
-        'HTMLSanitizer' => [
-            'class_name' => 'BrightNucleus\ChainMail\Sanitizer\HTMLSanitizer',
-        ],
-        'TextSanitizer' => [
-            'class_name' => 'BrightNucleus\ChainMail\Sanitizer\TextSanitizer',
-        ],
-    ],
+	'sanitizers'          => [
+		'HTMLSanitizer' => [
+			'class_name' => 'BrightNucleus\ChainMail\Sanitizer\HTMLSanitizer',
+		],
+		'TextSanitizer' => [
+			'class_name' => 'BrightNucleus\ChainMail\Sanitizer\TextSanitizer',
+		],
+	],
 
-    /*
+	/*
      * ViewBuilder configuration that is passed into the `brightnucleus/view` component.
      */
-    'ViewBuilder'         => [
-        'ViewFinder' => [
-            'Views' => [
-                'MailView' => 'BrightNucleus\ChainMail\View\MailView',
-            ],
-        ],
-    ],
+	'ViewBuilder'         => [
+		'ViewFinder' => [
+			'Views' => [
+				'MailView' => 'BrightNucleus\ChainMail\View\MailView',
+			],
+		],
+	],
 
-    /*
+	/*
      * The `Template` implementations that are provided.
      *
      * Each template also defines what sections it intends to use, and what
      * view it intends to use for rendering.
      */
-    'templates'           => [
-        'BasicTemplate'       => [
-            'class_name' => 'BrightNucleus\ChainMail\Template\GenericTemplate',
-            'sections'   => [
-                'HeaderSection',
-                'BodySection',
-                'FooterSection',
-            ],
-            'view_name'  => 'GenericTemplate',
-        ],
-        'HeroTemplate'        => [
-            'class_name' => 'BrightNucleus\ChainMail\Template\GenericTemplate',
-            'sections'   => [
-                'HeaderSection',
-                'HeroSection',
-                'BodySection',
-                'FooterSection',
-            ],
-            'view_name'  => 'GenericTemplate',
-        ],
-        'SidebarTemplate'     => [
-            'class_name' => 'BrightNucleus\ChainMail\Template\GenericTemplate',
-            'sections'   => [
-                'HeaderSection',
-                'BodySection',
-                'SidebarSection',
-                'FooterSection',
-            ],
-            'view_name'  => 'GenericTemplate',
-        ],
-        'HeroSidebarTemplate' => [
-            'class_name' => 'BrightNucleus\ChainMail\Template\GenericTemplate',
-            'sections'   => [
-                'HeaderSection',
-                'HeroSection',
-                'BodySection',
-                'SidebarSection',
-                'FooterSection',
-            ],
-            'view_name'  => 'GenericTemplate',
-        ],
-    ],
+	'templates'           => [
+		'BasicTemplate'       => [
+			'class_name' => 'BrightNucleus\ChainMail\Template\GenericTemplate',
+			'sections'   => [
+				'HeaderSection',
+				'BodySection',
+				'FooterSection',
+			],
+			'view_name'  => 'GenericTemplate',
+		],
+		'HeroTemplate'        => [
+			'class_name' => 'BrightNucleus\ChainMail\Template\GenericTemplate',
+			'sections'   => [
+				'HeaderSection',
+				'HeroSection',
+				'BodySection',
+				'FooterSection',
+			],
+			'view_name'  => 'GenericTemplate',
+		],
+		'SidebarTemplate'     => [
+			'class_name' => 'BrightNucleus\ChainMail\Template\GenericTemplate',
+			'sections'   => [
+				'HeaderSection',
+				'BodySection',
+				'SidebarSection',
+				'FooterSection',
+			],
+			'view_name'  => 'GenericTemplate',
+		],
+		'HeroSidebarTemplate' => [
+			'class_name' => 'BrightNucleus\ChainMail\Template\GenericTemplate',
+			'sections'   => [
+				'HeaderSection',
+				'HeroSection',
+				'BodySection',
+				'SidebarSection',
+				'FooterSection',
+			],
+			'view_name'  => 'GenericTemplate',
+		],
+	],
 
-    /*
+	/*
      * The `Section` implementations that are provided.
      *
      * Each section also defines what view it intends to use for rendering.
      */
-    'sections'            => [
-        'HeaderSection'  => [
-            'css_class'  => 'header',
-            'class_name' => 'BrightNucleus\ChainMail\Section\GenericSection',
-            'view_name'  => 'GenericSection',
-        ],
-        'BodySection'    => [
-            'css_class'  => 'body',
-            'class_name' => 'BrightNucleus\ChainMail\Section\GenericSection',
-            'view_name'  => 'GenericSection',
-        ],
-        'FooterSection'  => [
-            'css_class'  => 'footer',
-            'class_name' => 'BrightNucleus\ChainMail\Section\GenericSection',
-            'view_name'  => 'GenericSection',
-        ],
-        'HeroSection'    => [
-            'css_class'  => 'hero',
-            'class_name' => 'BrightNucleus\ChainMail\Section\GenericSection',
-            'view_name'  => 'GenericSection',
-        ],
-        'SidebarSection' => [
-            'css_class'  => 'sidebar',
-            'class_name' => 'BrightNucleus\ChainMail\Section\GenericSection',
-            'view_name'  => 'GenericSection',
-        ],
-    ],
+	'sections'            => [
+		'HeaderSection'  => [
+			'css_class'  => 'header',
+			'class_name' => 'BrightNucleus\ChainMail\Section\GenericSection',
+			'view_name'  => 'GenericSection',
+		],
+		'BodySection'    => [
+			'css_class'  => 'body',
+			'class_name' => 'BrightNucleus\ChainMail\Section\GenericSection',
+			'view_name'  => 'GenericSection',
+		],
+		'FooterSection'  => [
+			'css_class'  => 'footer',
+			'class_name' => 'BrightNucleus\ChainMail\Section\GenericSection',
+			'view_name'  => 'GenericSection',
+		],
+		'HeroSection'    => [
+			'css_class'  => 'hero',
+			'class_name' => 'BrightNucleus\ChainMail\Section\GenericSection',
+			'view_name'  => 'GenericSection',
+		],
+		'SidebarSection' => [
+			'css_class'  => 'sidebar',
+			'class_name' => 'BrightNucleus\ChainMail\Section\GenericSection',
+			'view_name'  => 'GenericSection',
+		],
+	],
 ];

Spacing +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
      * specific view to be rendered.
      */
     'view_root_locations' => [
-        'default' => realpath(__DIR__ . '/../views'),
+        'default' => realpath(__DIR__.'/../views'),
     ],
 
     /*

src/Validator.php

Indentation +11 added lines, -11 removed lines

@@ -22,15 +22,15 @@
 interface ValidatorInterface
 {
 
-    /**
-     * Validate the content for a given context.
-     *
-     * @since 1.0.0
-     *
-     * @param string $content Content to validate.
-     * @param array  $context Context in which to validate.
-     *
-     * @return string Validated content.
-     */
-    public function validate($content, array $context);
+	/**
+	 * Validate the content for a given context.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $content Content to validate.
+	 * @param array  $context Context in which to validate.
+	 *
+	 * @return string Validated content.
+	 */
+	public function validate($content, array $context);
 }

src/Section/AbstractSection.php

Indentation +141 added lines, -141 removed lines

@@ -28,145 +28,145 @@
 abstract class AbstractSection implements Section
 {
 
-    /**
-     * Name of the Section.
-     *
-     * @since 1.0.0
-     *
-     * @var string
-     */
-    protected $sectionName;
-
-    /**
-     * Configuration Settings.
-     *
-     * @since 1.0.0
-     *
-     * @var ConfigInterface
-     */
-    protected $config;
-
-    /**
-     * Content of the section.
-     *
-     * @since 1.0.0
-     *
-     * @var string
-     */
-    protected $content;
-
-    /**
-     * ViewBuilder to create template and section views.
-     *
-     * @since 1.0.0
-     *
-     * @var ViewBuilder
-     */
-    protected $viewBuilder;
-
-    /**
-     * Instantiate a AbstractSection object.
-     *
-     * @since 1.0.0
-     *
-     * @param ConfigInterface $config    Configuration settings.
-     * @param array           $arguments Arguments that are passed through the constructor.
-     *                                   Contained elements:
-     *                                   string $section, string $content
-     *
-     * @throws RuntimeException
-     */
-    public function __construct($config, array $arguments)
-    {
-        $this->config = $config;
-        list($section, $content, $this->viewBuilder) = $arguments;
-        $this->setSectionName($section);
-        $this->content = $content;
-    }
-
-    /**
-     * Get the name of the Section.
-     *
-     * @since 1.0.0
-     *
-     * @return string Name of the section.
-     */
-    public function getSectionName()
-    {
-        return $this->sectionName;
-    }
-
-    /**
-     * Set the name of the Section.
-     *
-     * @since 1.0.0
-     *
-     * @param string|null $section Optional. Name of the section.
-     *
-     * @throws FailedToInitialiseSection If no section name was passed.
-     * @throws FailedToInitialiseSection If an unknown section name was passed.
-     */
-    protected function setSectionName($section = null)
-    {
-        if (null === $section) {
-            throw new FailedToInitialiseSection(
-                'Initialised section without passing it a section name.'
-            );
-        }
-        if ( ! array_key_exists($section, $this->config['sections'])) {
-            throw new FailedToInitialiseSection(
-                'Initialised section with an unknown section name.'
-            );
-        }
-        $this->sectionName = $section;
-    }
-
-    /**
-     * Render the current Renderable for a given context.
-     *
-     * @since 1.0.0
-     *
-     * @param array $context The context in which to render the Renderable.
-     *
-     * @return string Rendered output of the Renderable.
-     * @throws RuntimeException
-     */
-    public function render(array $context)
-    {
-
-        $viewName = $this->getViewName($context);
-        $view     = $this->viewBuilder->create($viewName);
-
-        $context['css_class'] = $this->getCSSClass();
-        $context['content']   = $this->content;
-
-        return $view->render($context);
-    }
-
-    /**
-     * Get the name of the View to use for rendering.
-     *
-     * @since 1.0.0
-     *
-     * @param array $context The context in which to render the template.
-     *
-     * @return string Name of the view.
-     */
-    protected function getViewName(array $context)
-    {
-        return $this->config['sections'][$this->getSectionName()]['view_name']
-               . '.' . $context['format'];
-    }
-
-    /**
-     * Get the CSS class that is used for the section.
-     *
-     * @since 1.0.0
-     *
-     * @return string
-     */
-    protected function getCSSClass()
-    {
-        return $this->config['sections'][$this->getSectionName()]['css_class'];
-    }
+	/**
+	 * Name of the Section.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var string
+	 */
+	protected $sectionName;
+
+	/**
+	 * Configuration Settings.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var ConfigInterface
+	 */
+	protected $config;
+
+	/**
+	 * Content of the section.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var string
+	 */
+	protected $content;
+
+	/**
+	 * ViewBuilder to create template and section views.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var ViewBuilder
+	 */
+	protected $viewBuilder;
+
+	/**
+	 * Instantiate a AbstractSection object.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param ConfigInterface $config    Configuration settings.
+	 * @param array           $arguments Arguments that are passed through the constructor.
+	 *                                   Contained elements:
+	 *                                   string $section, string $content
+	 *
+	 * @throws RuntimeException
+	 */
+	public function __construct($config, array $arguments)
+	{
+		$this->config = $config;
+		list($section, $content, $this->viewBuilder) = $arguments;
+		$this->setSectionName($section);
+		$this->content = $content;
+	}
+
+	/**
+	 * Get the name of the Section.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string Name of the section.
+	 */
+	public function getSectionName()
+	{
+		return $this->sectionName;
+	}
+
+	/**
+	 * Set the name of the Section.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string|null $section Optional. Name of the section.
+	 *
+	 * @throws FailedToInitialiseSection If no section name was passed.
+	 * @throws FailedToInitialiseSection If an unknown section name was passed.
+	 */
+	protected function setSectionName($section = null)
+	{
+		if (null === $section) {
+			throw new FailedToInitialiseSection(
+				'Initialised section without passing it a section name.'
+			);
+		}
+		if ( ! array_key_exists($section, $this->config['sections'])) {
+			throw new FailedToInitialiseSection(
+				'Initialised section with an unknown section name.'
+			);
+		}
+		$this->sectionName = $section;
+	}
+
+	/**
+	 * Render the current Renderable for a given context.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $context The context in which to render the Renderable.
+	 *
+	 * @return string Rendered output of the Renderable.
+	 * @throws RuntimeException
+	 */
+	public function render(array $context)
+	{
+
+		$viewName = $this->getViewName($context);
+		$view     = $this->viewBuilder->create($viewName);
+
+		$context['css_class'] = $this->getCSSClass();
+		$context['content']   = $this->content;
+
+		return $view->render($context);
+	}
+
+	/**
+	 * Get the name of the View to use for rendering.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $context The context in which to render the template.
+	 *
+	 * @return string Name of the view.
+	 */
+	protected function getViewName(array $context)
+	{
+		return $this->config['sections'][$this->getSectionName()]['view_name']
+			   . '.' . $context['format'];
+	}
+
+	/**
+	 * Get the CSS class that is used for the section.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string
+	 */
+	protected function getCSSClass()
+	{
+		return $this->config['sections'][$this->getSectionName()]['css_class'];
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -155,6 +155,6 @@
     protected function getViewName(array $context)
     {
         return $this->config['templates'][$this->getTemplateName()]['view_name']
-               . '.' . $context['format'];
+               . '.'.$context['format'];
     }
 }

src/Sanitizer.php

Indentation +11 added lines, -11 removed lines

@@ -22,15 +22,15 @@
 interface SanitizerInterface
 {
 
-    /**
-     * Sanitize content for a given context.
-     *
-     * @since 1.0.0
-     *
-     * @param string $content Content to sanitize.
-     * @param array  $context Context in which to sanitize.
-     *
-     * @return string Sanitized content.
-     */
-    public function sanitize($content, array $context);
+	/**
+	 * Sanitize content for a given context.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $content Content to sanitize.
+	 * @param array  $context Context in which to sanitize.
+	 *
+	 * @return string Sanitized content.
+	 */
+	public function sanitize($content, array $context);
 }

src/Template.php

Indentation +16 added lines, -16 removed lines

@@ -22,21 +22,21 @@
 interface TemplateInterface extends Renderable
 {
 
-    /**
-     * Get an array of Sections that are used by this template.
-     *
-     * @since 1.0.0
-     *
-     * @return array Sections that are used by this template.
-     */
-    public function getUsedSections();
+	/**
+	 * Get an array of Sections that are used by this template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return array Sections that are used by this template.
+	 */
+	public function getUsedSections();
 
-    /**
-     * Get the name of the Template.
-     *
-     * @since 1.0.0
-     *
-     * @return string Name of the template.
-     */
-    public function getTemplateName();
+	/**
+	 * Get the name of the Template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string Name of the template.
+	 */
+	public function getTemplateName();
 }

src/Section.php

Indentation +8 added lines, -8 removed lines

@@ -22,12 +22,12 @@
 interface SectionInterface extends Renderable
 {
 
-    /**
-     * Get the name of the Section.
-     *
-     * @since 1.0.0
-     *
-     * @return string Name of the section.
-     */
-    public function getSectionName();
+	/**
+	 * Get the name of the Section.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string Name of the section.
+	 */
+	public function getSectionName();
 }

src/Mail/AbstractMail.php

Spacing +1 added lines, -1 removed lines

@@ -155,7 +155,7 @@
         if ( ! $template instanceof Template) {
             throw new InvalidTemplate(
                 'Could not set the template, invalid type.',
-                (array)$template
+                (array) $template
             );
         }
         $this->template = $template;

Unused Use Statements -1 removed lines

@@ -19,7 +19,6 @@
 use BrightNucleus\ChainMail\Template;
 use BrightNucleus\Config\ConfigInterface;
 use BrightNucleus\Config\Exception\FailedToProcessConfigException;
-use BrightNucleus\View;
 use BrightNucleus\View\Location\FilesystemLocation;
 use BrightNucleus\View\ViewBuilder;
 use Exception;

Indentation +300 added lines, -300 removed lines

@@ -36,304 +36,304 @@
 abstract class AbstractMail implements Mail
 {
 
-    /**
-     * Configuration Settings.
-     *
-     * @since 1.0.0
-     *
-     * @var ConfigInterface
-     */
-    protected $config;
-
-    /**
-     * Template that is used for the email.
-     *
-     * @since 1.0.0
-     *
-     * @var Template
-     */
-    protected $template;
-
-    /**
-     * Content for the different sections.
-     *
-     * @since 1.0.0
-     *
-     * @var array
-     */
-    protected $sectionContent = [];
-
-    /**
-     * Format of the mail.
-     *
-     * @since 1.0.0
-     *
-     * @var string
-     */
-    protected $format;
-
-    /**
-     * ViewBuilder to create template and section views.
-     *
-     * @since 1.0.0
-     *
-     * @var ViewBuilder
-     */
-    protected $viewBuilder;
-
-    /**
-     * Instantiate an AbstractMail object.
-     *
-     * @since 1.0.0
-     *
-     * @param ConfigInterface $config The Config to use.
-     *
-     * @throws FailedToProcessConfigException If the Config could not be processed.
-     */
-    public function __construct(ConfigInterface $config)
-    {
-        $this->config = $config;
-        $this->setFormat();
-
-        $this->viewBuilder = new ViewBuilder($config
-            ? $config->getSubConfig('ViewBuilder')
-            : null
-        );
-
-        foreach ($this->config->getKey('view_root_locations') as $folder) {
-            $this->viewBuilder->addLocation(
-                new FilesystemLocation($folder)
-            );
-        }
-    }
-
-    /**
-     * Get the template to use for the renderer.
-     *
-     * @since 1.0.0
-     *
-     * @return Template Reference to the template that is used.
-     * @throws RuntimeException
-     */
-    public function getTemplate()
-    {
-
-        if ( ! $this->template) {
-            $this->setDefaultTemplate();
-        }
-
-        if (is_string($this->template)) {
-            $this->template = $this->createTemplate($this->template);
-        }
-
-        return $this->template;
-    }
-
-    /**
-     * Set the template to use for the renderer.
-     *
-     * @since 1.0.0
-     *
-     * @param string|Template $template          Template to use for the
-     *                                           renderer.
-     *
-     * @return Mail
-     * @throws InvalidTemplate If the template class could not be instantiated.
-     * @throws InvalidTemplate If the template type is not recognized.
-     */
-    public function setTemplate($template)
-    {
-        try {
-            if (is_string($template)) {
-                $template = $this->createTemplate($template);
-            }
-        } catch (Exception $exception) {
-            throw new InvalidTemplate(
-                'Could not instantiate the template class "%1$s". Reason: "%2$s".',
-                $template,
-                $exception->getMessage()
-            );
-        }
-
-        if ( ! $template instanceof Template) {
-            throw new InvalidTemplate(
-                'Could not set the template, invalid type.',
-                (array)$template
-            );
-        }
-        $this->template = $template;
-
-        return $this;
-    }
-
-    /**
-     * Add a section to the Mail.
-     *
-     * @since 1.0.0
-     *
-     * @param string $type    Type of section to add.
-     * @param string $content Content of the section.
-     *
-     * @throws RuntimeException
-     */
-    public function addSection($type, $content)
-    {
-        $this->sectionContent[$type] = $content;
-    }
-
-    /**
-     * Render the Mail for a given context.
-     *
-     * @since 1.0.0
-     *
-     * @param array $context The context in which to render the email.
-     *
-     * @return string Rendered output of the email
-     */
-    public function render(array $context)
-    {
-        $template = $this->getTemplate();
-
-        $context['template'] = $template;
-
-        $this->instantiateSections($template->getUsedSections(), $context);
-
-        $context['format'] = $this->getFormat();
-
-        $context = $this->setContext($context);
-
-        return $template->render($context);
-    }
-
-    /**
-     * Send the email to one or more recipients.
-     *
-     * @since 1.0.0
-     *
-     * @param Recipients|EmailAddress|array|string $recipients
-     *
-     * @return Mail
-     */
-    public function sendTo($recipients)
-    {
-        if ($recipients instanceof EmailAddress) {
-            return $this->executeSend($recipients);
-        }
-
-        if (is_string($recipients)) {
-            return $this->sendTo(new EmailAddress($recipients));
-        }
-
-        if ($recipients instanceof Recipients) {
-            array_walk($recipients, [$this, 'sendTo']);
-
-            return $this;
-        }
-    }
-
-    /**
-     * Execute the sending of one individual email.
-     *
-     * @since 1.0.0
-     *
-     * @param EmailAddress $recipient Recipient to send the email to.
-     *
-     * @return Mail
-     */
-    protected function executeSend(EmailAddress $recipient)
-    {
-        // Do the actual sending.
-        echo "Sending email to ${recipient}...";
-
-        return $this;
-    }
-
-    /**
-     * Instantiate the requested sections for a template.
-     *
-     * @since 1.0.0
-     *
-     * @param array $sections Sections to instantiate.
-     * @param array $context  The context in which to instantiate the sections.
-     */
-    protected function instantiateSections(array $sections, array &$context)
-    {
-        $sectionFactory = new Factory($this->config, 'sections');
-
-        foreach ($sections as $section) {
-
-            $content = null;
-
-            if (array_key_exists($section, $this->sectionContent)) {
-                $content = $this->sectionContent[$section];
-            }
-
-            $context['sections'][$section] = $sectionFactory->create(
-                $section,
-                [$section, $content, $this->viewBuilder]
-            );
-        }
-    }
-
-    /**
-     * Set the format of the mail.
-     *
-     * @since 1.0.0
-     *
-     * @return string Format of the Mail.
-     */
-    protected function getFormat()
-    {
-        return $this->format;
-    }
-
-    /**
-     * Set the format of the mail.
-     *
-     * @since 1.0.0
-     *
-     * @return void
-     */
-    abstract protected function setFormat();
-
-    /**
-     * Set the template to the default template defined in the configuration.
-     *
-     * @since 1.0.0
-     *
-     * @throws RuntimeException
-     */
-    protected function setDefaultTemplate()
-    {
-        $defaultTemplate = $this->config->getKey('default_template');
-        $this->setTemplate($defaultTemplate);
-    }
-
-    /**
-     * Create an instance of a template.
-     *
-     * @since 1.0.0
-     *
-     * @param string $template Template to instantiate.
-     *
-     * @return Template $template Newly created instance.
-     * @throws RuntimeException
-     */
-    protected function createTemplate($template)
-    {
-        $templateFactory = new Factory($this->config, 'templates');
-
-        return $templateFactory->create($template, [$template, $this->viewBuilder]);
-    }
-
-    /**
-     * Set the context of the mail.
-     *
-     * @since 1.0.0
-     *
-     * @param array $context Context to set/modify.
-     *
-     * @return array Updated context.
-     */
-    abstract protected function setContext(array $context);
+	/**
+	 * Configuration Settings.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var ConfigInterface
+	 */
+	protected $config;
+
+	/**
+	 * Template that is used for the email.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var Template
+	 */
+	protected $template;
+
+	/**
+	 * Content for the different sections.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var array
+	 */
+	protected $sectionContent = [];
+
+	/**
+	 * Format of the mail.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var string
+	 */
+	protected $format;
+
+	/**
+	 * ViewBuilder to create template and section views.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var ViewBuilder
+	 */
+	protected $viewBuilder;
+
+	/**
+	 * Instantiate an AbstractMail object.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param ConfigInterface $config The Config to use.
+	 *
+	 * @throws FailedToProcessConfigException If the Config could not be processed.
+	 */
+	public function __construct(ConfigInterface $config)
+	{
+		$this->config = $config;
+		$this->setFormat();
+
+		$this->viewBuilder = new ViewBuilder($config
+			? $config->getSubConfig('ViewBuilder')
+			: null
+		);
+
+		foreach ($this->config->getKey('view_root_locations') as $folder) {
+			$this->viewBuilder->addLocation(
+				new FilesystemLocation($folder)
+			);
+		}
+	}
+
+	/**
+	 * Get the template to use for the renderer.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return Template Reference to the template that is used.
+	 * @throws RuntimeException
+	 */
+	public function getTemplate()
+	{
+
+		if ( ! $this->template) {
+			$this->setDefaultTemplate();
+		}
+
+		if (is_string($this->template)) {
+			$this->template = $this->createTemplate($this->template);
+		}
+
+		return $this->template;
+	}
+
+	/**
+	 * Set the template to use for the renderer.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string|Template $template          Template to use for the
+	 *                                           renderer.
+	 *
+	 * @return Mail
+	 * @throws InvalidTemplate If the template class could not be instantiated.
+	 * @throws InvalidTemplate If the template type is not recognized.
+	 */
+	public function setTemplate($template)
+	{
+		try {
+			if (is_string($template)) {
+				$template = $this->createTemplate($template);
+			}
+		} catch (Exception $exception) {
+			throw new InvalidTemplate(
+				'Could not instantiate the template class "%1$s". Reason: "%2$s".',
+				$template,
+				$exception->getMessage()
+			);
+		}
+
+		if ( ! $template instanceof Template) {
+			throw new InvalidTemplate(
+				'Could not set the template, invalid type.',
+				(array)$template
+			);
+		}
+		$this->template = $template;
+
+		return $this;
+	}
+
+	/**
+	 * Add a section to the Mail.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $type    Type of section to add.
+	 * @param string $content Content of the section.
+	 *
+	 * @throws RuntimeException
+	 */
+	public function addSection($type, $content)
+	{
+		$this->sectionContent[$type] = $content;
+	}
+
+	/**
+	 * Render the Mail for a given context.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $context The context in which to render the email.
+	 *
+	 * @return string Rendered output of the email
+	 */
+	public function render(array $context)
+	{
+		$template = $this->getTemplate();
+
+		$context['template'] = $template;
+
+		$this->instantiateSections($template->getUsedSections(), $context);
+
+		$context['format'] = $this->getFormat();
+
+		$context = $this->setContext($context);
+
+		return $template->render($context);
+	}
+
+	/**
+	 * Send the email to one or more recipients.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param Recipients|EmailAddress|array|string $recipients
+	 *
+	 * @return Mail
+	 */
+	public function sendTo($recipients)
+	{
+		if ($recipients instanceof EmailAddress) {
+			return $this->executeSend($recipients);
+		}
+
+		if (is_string($recipients)) {
+			return $this->sendTo(new EmailAddress($recipients));
+		}
+
+		if ($recipients instanceof Recipients) {
+			array_walk($recipients, [$this, 'sendTo']);
+
+			return $this;
+		}
+	}
+
+	/**
+	 * Execute the sending of one individual email.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param EmailAddress $recipient Recipient to send the email to.
+	 *
+	 * @return Mail
+	 */
+	protected function executeSend(EmailAddress $recipient)
+	{
+		// Do the actual sending.
+		echo "Sending email to ${recipient}...";
+
+		return $this;
+	}
+
+	/**
+	 * Instantiate the requested sections for a template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $sections Sections to instantiate.
+	 * @param array $context  The context in which to instantiate the sections.
+	 */
+	protected function instantiateSections(array $sections, array &$context)
+	{
+		$sectionFactory = new Factory($this->config, 'sections');
+
+		foreach ($sections as $section) {
+
+			$content = null;
+
+			if (array_key_exists($section, $this->sectionContent)) {
+				$content = $this->sectionContent[$section];
+			}
+
+			$context['sections'][$section] = $sectionFactory->create(
+				$section,
+				[$section, $content, $this->viewBuilder]
+			);
+		}
+	}
+
+	/**
+	 * Set the format of the mail.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string Format of the Mail.
+	 */
+	protected function getFormat()
+	{
+		return $this->format;
+	}
+
+	/**
+	 * Set the format of the mail.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return void
+	 */
+	abstract protected function setFormat();
+
+	/**
+	 * Set the template to the default template defined in the configuration.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @throws RuntimeException
+	 */
+	protected function setDefaultTemplate()
+	{
+		$defaultTemplate = $this->config->getKey('default_template');
+		$this->setTemplate($defaultTemplate);
+	}
+
+	/**
+	 * Create an instance of a template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $template Template to instantiate.
+	 *
+	 * @return Template $template Newly created instance.
+	 * @throws RuntimeException
+	 */
+	protected function createTemplate($template)
+	{
+		$templateFactory = new Factory($this->config, 'templates');
+
+		return $templateFactory->create($template, [$template, $this->viewBuilder]);
+	}
+
+	/**
+	 * Set the context of the mail.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $context Context to set/modify.
+	 *
+	 * @return array Updated context.
+	 */
+	abstract protected function setContext(array $context);
 }

src/Support/Factory.php

Indentation +61 added lines, -61 removed lines

@@ -26,75 +26,75 @@
 class Factory
 {
 
-    /**
-     * Configuration Settings.
-     *
-     * @since 1.0.0
-     *
-     * @var ConfigInterface
-     */
-    protected $config;
+	/**
+	 * Configuration Settings.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var ConfigInterface
+	 */
+	protected $config;
 
-    /**
-     * Type of element the factory wants to create.
-     *
-     * @since 1.0.0
-     *
-     * @var string
-     */
-    protected $element;
+	/**
+	 * Type of element the factory wants to create.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var string
+	 */
+	protected $element;
 
-    /**
-     * Instantiate a Factory object.
-     *
-     * @since 1.0.0
-     *
-     * @param ConfigInterface $config  Configuration settings.
-     * @param string          $element The type of element to instantiate a factory for.
-     *
-     * @throws FailedToInstantiateFactory When an unknown element type is requested.
-     */
-    public function __construct(ConfigInterface $config, $element)
-    {
+	/**
+	 * Instantiate a Factory object.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param ConfigInterface $config  Configuration settings.
+	 * @param string          $element The type of element to instantiate a factory for.
+	 *
+	 * @throws FailedToInstantiateFactory When an unknown element type is requested.
+	 */
+	public function __construct(ConfigInterface $config, $element)
+	{
 
-        $this->config = $config;
+		$this->config = $config;
 
-        if ( ! $this->config->hasKey($element)) {
-            throw new FailedToInstantiateFactory(sprintf(
-                'Could not instantiate Factory for unknown Element Type "%1$s".',
-                $element
-            ));
-        }
+		if ( ! $this->config->hasKey($element)) {
+			throw new FailedToInstantiateFactory(sprintf(
+				'Could not instantiate Factory for unknown Element Type "%1$s".',
+				$element
+			));
+		}
 
-        $this->element = $element;
-    }
+		$this->element = $element;
+	}
 
-    /**
-     * Create and return a new instance of an element.
-     *
-     * @since 1.0.0
-     *
-     * @param string $type      Type of element to create.
-     * @param mixed  $arguments Optional. Arguments to pass to the object.
-     *
-     * @return object New instance of the requested class.
-     * @throws FailedToInstantiateClass If an unknown element type is requested.
-     */
-    public function create($type, $arguments = null)
-    {
+	/**
+	 * Create and return a new instance of an element.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $type      Type of element to create.
+	 * @param mixed  $arguments Optional. Arguments to pass to the object.
+	 *
+	 * @return object New instance of the requested class.
+	 * @throws FailedToInstantiateClass If an unknown element type is requested.
+	 */
+	public function create($type, $arguments = null)
+	{
 
-        $classMap = $this->config[$this->element];
+		$classMap = $this->config[$this->element];
 
-        if ( ! array_key_exists($type, $classMap)) {
-            throw new FailedToInstantiateClass(sprintf(
-                'Could not create object, unknown Type "%1$s" for "%2$s" elements.',
-                $type,
-                $this->element
-            ));
-        }
+		if ( ! array_key_exists($type, $classMap)) {
+			throw new FailedToInstantiateClass(sprintf(
+				'Could not create object, unknown Type "%1$s" for "%2$s" elements.',
+				$type,
+				$this->element
+			));
+		}
 
-        $className = $classMap[$type]['class_name'];
+		$className = $classMap[$type]['class_name'];
 
-        return new $className($this->config, $arguments);
-    }
+		return new $className($this->config, $arguments);
+	}
 }

src/Template/AbstractTemplate.php

Indentation +128 added lines, -128 removed lines

@@ -29,132 +29,132 @@
 abstract class AbstractTemplate implements Template
 {
 
-    /**
-     * Configuration Settings.
-     *
-     * @since 1.0.0
-     *
-     * @var ConfigInterface
-     */
-    protected $config;
-
-    /**
-     * Name of the template.
-     *
-     * @since 1.0.0
-     *
-     * @var string
-     */
-    protected $templateName;
-
-    /**
-     * ViewBuilder to create template and section views.
-     *
-     * @since 1.0.0
-     *
-     * @var ViewBuilder
-     */
-    protected $viewBuilder;
-
-    /**
-     * Instantiate a AbstractTemplate object.
-     *
-     * @since 1.0.0
-     *
-     * @param ConfigInterface $config    Configuration settings.
-     * @param array           $arguments Arguments that are passed through the constructor.
-     *                                   Contained elements: string $template
-     *
-     * @throws RuntimeException
-     */
-    public function __construct($config, array $arguments)
-    {
-        $this->config = $config;
-        list($template, $this->viewBuilder) = $arguments;
-        $this->setTemplateName($template);
-    }
-
-    /**
-     * Get the name of the Template.
-     *
-     * @since 1.0.0
-     *
-     * @return string Name of the template.
-     */
-    public function getTemplateName()
-    {
-        return $this->templateName;
-    }
-
-    /**
-     * Set the name of the Template.
-     *
-     * @since 1.0.0
-     *
-     * @param string|null $template Optional. Name of the template.
-     *
-     * @throws FailedToInitialiseTemplate If no template name was passed.
-     * @throws FailedToInitialiseTemplate If an unknown template name was passed.
-     */
-    protected function setTemplateName($template = null)
-    {
-        if (null === $template) {
-            throw new FailedToInitialiseTemplate('Initialised template without passing it a template name.');
-        }
-        if ( ! array_key_exists($template, $this->config['templates'])) {
-            throw new FailedToInitialiseTemplate('Initialised template with an unknown template name.');
-        }
-        $this->templateName = $template;
-    }
-
-    /**
-     * Get an array of Sections that are used by this template.
-     *
-     * @since 1.0.0
-     *
-     * @return array Sections that are used by this template.
-     */
-    public function getUsedSections()
-    {
-        return $this->config['templates'][$this->getTemplateName()]['sections'];
-    }
-
-    /**
-     * Render the template for a given context.
-     *
-     * @since 1.0.0
-     *
-     * @param array $context The context in which to render the template.
-     *
-     * @return string The rendered content.
-     */
-    public function render(array $context)
-    {
-
-        $viewName = $this->getViewName($context);
-        $view     = $this->viewBuilder->create($viewName);
-
-        $sanitizerType    = $this->config['formats'][$context['format']]['sanitizer'];
-        $sanitizerFactory = new Factory($this->config, 'sanitizers');
-        $sanitizer        = $sanitizerFactory->create($sanitizerType);
-
-        $output = $view->render($context);
-
-        return $sanitizer->sanitize($output, $context);
-    }
-
-    /**
-     * Get the name of the View to use for rendering.
-     *
-     * @since 1.0.0
-     *
-     * @param array $context Context in which to get the view name.
-     *
-     * @return string Name of the view.
-     */
-    protected function getViewName(array $context)
-    {
-        return $this->config['templates'][$this->getTemplateName()]['view_name']
-               . '.' . $context['format'];
-    }
+	/**
+	 * Configuration Settings.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var ConfigInterface
+	 */
+	protected $config;
+
+	/**
+	 * Name of the template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var string
+	 */
+	protected $templateName;
+
+	/**
+	 * ViewBuilder to create template and section views.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var ViewBuilder
+	 */
+	protected $viewBuilder;
+
+	/**
+	 * Instantiate a AbstractTemplate object.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param ConfigInterface $config    Configuration settings.
+	 * @param array           $arguments Arguments that are passed through the constructor.
+	 *                                   Contained elements: string $template
+	 *
+	 * @throws RuntimeException
+	 */
+	public function __construct($config, array $arguments)
+	{
+		$this->config = $config;
+		list($template, $this->viewBuilder) = $arguments;
+		$this->setTemplateName($template);
+	}
+
+	/**
+	 * Get the name of the Template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string Name of the template.
+	 */
+	public function getTemplateName()
+	{
+		return $this->templateName;
+	}
+
+	/**
+	 * Set the name of the Template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string|null $template Optional. Name of the template.
+	 *
+	 * @throws FailedToInitialiseTemplate If no template name was passed.
+	 * @throws FailedToInitialiseTemplate If an unknown template name was passed.
+	 */
+	protected function setTemplateName($template = null)
+	{
+		if (null === $template) {
+			throw new FailedToInitialiseTemplate('Initialised template without passing it a template name.');
+		}
+		if ( ! array_key_exists($template, $this->config['templates'])) {
+			throw new FailedToInitialiseTemplate('Initialised template with an unknown template name.');
+		}
+		$this->templateName = $template;
+	}
+
+	/**
+	 * Get an array of Sections that are used by this template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return array Sections that are used by this template.
+	 */
+	public function getUsedSections()
+	{
+		return $this->config['templates'][$this->getTemplateName()]['sections'];
+	}
+
+	/**
+	 * Render the template for a given context.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $context The context in which to render the template.
+	 *
+	 * @return string The rendered content.
+	 */
+	public function render(array $context)
+	{
+
+		$viewName = $this->getViewName($context);
+		$view     = $this->viewBuilder->create($viewName);
+
+		$sanitizerType    = $this->config['formats'][$context['format']]['sanitizer'];
+		$sanitizerFactory = new Factory($this->config, 'sanitizers');
+		$sanitizer        = $sanitizerFactory->create($sanitizerType);
+
+		$output = $view->render($context);
+
+		return $sanitizer->sanitize($output, $context);
+	}
+
+	/**
+	 * Get the name of the View to use for rendering.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $context Context in which to get the view name.
+	 *
+	 * @return string Name of the view.
+	 */
+	protected function getViewName(array $context)
+	{
+		return $this->config['templates'][$this->getTemplateName()]['view_name']
+			   . '.' . $context['format'];
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -155,6 +155,6 @@
     protected function getViewName(array $context)
     {
         return $this->config['templates'][$this->getTemplateName()]['view_name']
-               . '.' . $context['format'];
+               . '.'.$context['format'];
     }
 }