brightnucleus / chainmail

src/Mail.php

Indentation +30 added lines, -30 removed lines

@@ -24,36 +24,36 @@
 interface Mail extends Renderable
 {
 
-    /**
-     * Set the template that the email will use.
-     *
-     * @since 1.0.0
-     *
-     * @param string|Template $template Template to use.
-     *
-     * @return void
-     */
-    public function setTemplate($template);
+	/**
+	 * Set the template that the email will use.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string|Template $template Template to use.
+	 *
+	 * @return void
+	 */
+	public function setTemplate($template);
 
-    /**
-     * Get the instance of the template.
-     *
-     * @since 1.0.0
-     *
-     * @return Template
-     */
-    public function getTemplate();
+	/**
+	 * Get the instance of the template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return Template
+	 */
+	public function getTemplate();
 
-    /**
-     * 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.
-     *
-     * @return void
-     * @throws RuntimeException
-     */
-    public function addSection($type, $content);
+	/**
+	 * 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.
+	 *
+	 * @return void
+	 * @throws RuntimeException
+	 */
+	public function addSection($type, $content);
 }

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'];
+	}
 }

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/ChainMail.php

Indentation +110 added lines, -110 removed lines

@@ -26,114 +26,114 @@
 class ChainMail
 {
 
-    const DEFAULT_CONFIG = __DIR__ . '/../config/defaults.php';
-
-    /**
-     * Configuration Settings.
-     *
-     * @since 1.0.0
-     *
-     * @var ConfigInterface
-     */
-    protected $config;
-
-    /**
-     * Instantiate a ChainMail object.
-     *
-     * @since 1.0.0
-     *
-     * @param ConfigInterface|null $config Optional. Configuration settings.
-     */
-    public function __construct(ConfigInterface $config = null)
-    {
-
-        $defaults = ConfigFactory::create(include(self::DEFAULT_CONFIG));
-
-        if ( ! $config) {
-            $this->config = $defaults;
-
-            return;
-        }
-
-        $this->config = ConfigFactory::create(array_merge(
-                (array)$defaults,
-                (array)$config)
-        );
-    }
-
-    /**
-     * Render a specific section.
-     *
-     * @since 1.0.0
-     *
-     * @param string $sectionType Type of section to render.
-     * @param array  $context     The context in which to render the section.
-     *
-     * @return string Rendered HTML.
-     */
-    public static function renderSection($sectionType, array $context)
-    {
-        /** @var Section $section */
-        $section = $context['sections'][$sectionType];
-
-        return $section->render($context);
-    }
-
-    /**
-     * Get an array of strings representing the sections that are used by the
-     * template.
-     *
-     * @since 1.0.0
-     *
-     * @param array $context The context in which to render the section.
-     *
-     * @return array Array of strings with section types.
-     */
-    public static function getUsedSections(array $context)
-    {
-        /** @var Template $template */
-        $template = $context['template'];
-
-        return $template->getUsedSections();
-    }
-
-    /**
-     * Render all used sections.
-     *
-     * @since 1.0.0
-     *
-     * @param array $context The context in which to render the section.
-     *
-     * @return string Rendered HTML.
-     */
-    public static function renderSections(array $context)
-    {
-        $output = '';
-
-        foreach (self::getUsedSections($context) as $section) {
-            $output .= self::renderSection($section, $context);
-        }
-
-        return $output;
-    }
-
-    /**
-     * Create a new mail object.
-     *
-     * @since 1.0.0
-     *
-     * @param string          $format   Optional. Format to use.
-     * @param string|Template $template Optional. Template to be used.
-     *
-     * @return Mail
-     */
-    public function createMail($format = 'html', $template = 'BasicTemplate')
-    {
-        $mail_factory = new Factory($this->config, 'mails');
-        $mail_class   = $this->config->getKey('formats')[$format]['mail'];
-        $mail         = $mail_factory->create($mail_class);
-        $mail->setTemplate($template);
-
-        return $mail;
-    }
+	const DEFAULT_CONFIG = __DIR__ . '/../config/defaults.php';
+
+	/**
+	 * Configuration Settings.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var ConfigInterface
+	 */
+	protected $config;
+
+	/**
+	 * Instantiate a ChainMail object.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param ConfigInterface|null $config Optional. Configuration settings.
+	 */
+	public function __construct(ConfigInterface $config = null)
+	{
+
+		$defaults = ConfigFactory::create(include(self::DEFAULT_CONFIG));
+
+		if ( ! $config) {
+			$this->config = $defaults;
+
+			return;
+		}
+
+		$this->config = ConfigFactory::create(array_merge(
+				(array)$defaults,
+				(array)$config)
+		);
+	}
+
+	/**
+	 * Render a specific section.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $sectionType Type of section to render.
+	 * @param array  $context     The context in which to render the section.
+	 *
+	 * @return string Rendered HTML.
+	 */
+	public static function renderSection($sectionType, array $context)
+	{
+		/** @var Section $section */
+		$section = $context['sections'][$sectionType];
+
+		return $section->render($context);
+	}
+
+	/**
+	 * Get an array of strings representing the sections that are used by the
+	 * template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $context The context in which to render the section.
+	 *
+	 * @return array Array of strings with section types.
+	 */
+	public static function getUsedSections(array $context)
+	{
+		/** @var Template $template */
+		$template = $context['template'];
+
+		return $template->getUsedSections();
+	}
+
+	/**
+	 * Render all used sections.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $context The context in which to render the section.
+	 *
+	 * @return string Rendered HTML.
+	 */
+	public static function renderSections(array $context)
+	{
+		$output = '';
+
+		foreach (self::getUsedSections($context) as $section) {
+			$output .= self::renderSection($section, $context);
+		}
+
+		return $output;
+	}
+
+	/**
+	 * Create a new mail object.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string          $format   Optional. Format to use.
+	 * @param string|Template $template Optional. Template to be used.
+	 *
+	 * @return Mail
+	 */
+	public function createMail($format = 'html', $template = 'BasicTemplate')
+	{
+		$mail_factory = new Factory($this->config, 'mails');
+		$mail_class   = $this->config->getKey('formats')[$format]['mail'];
+		$mail         = $mail_factory->create($mail_class);
+		$mail->setTemplate($template);
+
+		return $mail;
+	}
 }

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

Indentation +254 added lines, -254 removed lines

@@ -34,258 +34,258 @@
 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')
-            : View::getDefaultConfig()
-        );
-
-        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.
-     *
-     * @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;
-    }
-
-    /**
-     * 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);
-    }
-
-    /**
-     * 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')
+			: View::getDefaultConfig()
+		);
+
+		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.
+	 *
+	 * @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;
+	}
+
+	/**
+	 * 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);
+	}
+
+	/**
+	 * 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);
+	}
 }