brightnucleus / chainmail

src/View/PHPView.php

Doc Comments +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
      * @param array  $context The context in which to render the Renderable.
      * @param string $content Optional. The content that the view should
      *                        represent.
-     * @return string|null Rendered output of the Renderable.
+     * @return string Rendered output of the Renderable.
      */
     public function render(array $context, $content = null)
     {

Indentation +24 added lines, -24 removed lines

@@ -1,13 +1,13 @@ 
 <?php
 /**
- * PHPView
- *
- * @package   brightnucleus/chainmail
- * @author    Alain Schlesser <alain.schlesser@gmail.com>
- * @license   GPL-2.0+
- * @link      http://www.brightnucleus.com/
- * @copyright 2016 Alain Schlesser, Bright Nucleus
- */
+	 * PHPView
+	 *
+	 * @package   brightnucleus/chainmail
+	 * @author    Alain Schlesser <alain.schlesser@gmail.com>
+	 * @license   GPL-2.0+
+	 * @link      http://www.brightnucleus.com/
+	 * @copyright 2016 Alain Schlesser, Bright Nucleus
+	 */
 
 namespace BrightNucleus\ChainMail\View;
 
@@ -22,23 +22,23 @@ 
 class PHPView extends AbstractView
 {
 
-    /**
-     * Render the current Renderable for a given context.
-     *
-     * @since 1.0.0
-     *
-     * @param array  $context The context in which to render the Renderable.
-     * @param string $content Optional. The content that the view should
-     *                        represent.
-     * @return string|null Rendered output of the Renderable.
-     */
-    public function render(array $context, $content = null)
-    {
+	/**
+	 * Render the current Renderable for a given context.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array  $context The context in which to render the Renderable.
+	 * @param string $content Optional. The content that the view should
+	 *                        represent.
+	 * @return string|null Rendered output of the Renderable.
+	 */
+	public function render(array $context, $content = null)
+	{
 
-        ob_start();
+		ob_start();
 
-        include $this->viewLocation . '.php';
+		include $this->viewLocation . '.php';
 
-        return ob_get_clean();
-    }
+		return ob_get_clean();
+	}
 }

src/ChainMail.php

Indentation +116 added lines, -116 removed lines

@@ -1,13 +1,13 @@ 
 <?php
 /**
- * ChainMail
- *
- * @package   brightnucleus/chainmail
- * @author    Alain Schlesser <alain.schlesser@gmail.com>
- * @license   GPL-2.0+
- * @link      http://www.brightnucleus.com/
- * @copyright 2016 Alain Schlesser, Bright Nucleus
- */
+	 * ChainMail
+	 *
+	 * @package   brightnucleus/chainmail
+	 * @author    Alain Schlesser <alain.schlesser@gmail.com>
+	 * @license   GPL-2.0+
+	 * @link      http://www.brightnucleus.com/
+	 * @copyright 2016 Alain Schlesser, Bright Nucleus
+	 */
 
 namespace BrightNucleus\ChainMail;
 
@@ -27,112 +27,112 @@ 
 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 = new Config(include(self::DEFAULT_CONFIG));
-
-        if ( ! $config) {
-            $this->config = $defaults;
-
-            return;
-        }
-
-        $this->config = new Config(array_merge(
-                (array)$defaults,
-                (array)$config)
-        );
-    }
-
-    /**
-     * Create a new mail object.
-     *
-     * @since 1.0.0
-     *
-     * @param string|null                   $format   Optional. Format to use.
-     * @param string|TemplateInterface|null $template Optional. Template to be
-     *                                                used.
-     * @return MailInterface
-     * @throws RuntimeException
-     */
-    public function createMail($format = null, $template = null)
-    {
-        $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;
-    }
-
-    /**
-     * 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, $context)
-    {
-        /** @var SectionInterface $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($context)
-    {
-        /** @var TemplateInterface $template */
-        $template = $context['template'];
-
-        return $template->getUsedSections();
-    }
-
-    /**
-     * Render a 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($context)
-    {
-        $output = '';
-
-        foreach (self::getUsedSections($context) as $section) {
-            $output .= self::renderSection($section, $context);
-        }
-
-        return $output;
-    }
+	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 = new Config(include(self::DEFAULT_CONFIG));
+
+		if ( ! $config) {
+			$this->config = $defaults;
+
+			return;
+		}
+
+		$this->config = new Config(array_merge(
+				(array)$defaults,
+				(array)$config)
+		);
+	}
+
+	/**
+	 * Create a new mail object.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string|null                   $format   Optional. Format to use.
+	 * @param string|TemplateInterface|null $template Optional. Template to be
+	 *                                                used.
+	 * @return MailInterface
+	 * @throws RuntimeException
+	 */
+	public function createMail($format = null, $template = null)
+	{
+		$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;
+	}
+
+	/**
+	 * 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, $context)
+	{
+		/** @var SectionInterface $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($context)
+	{
+		/** @var TemplateInterface $template */
+		$template = $context['template'];
+
+		return $template->getUsedSections();
+	}
+
+	/**
+	 * Render a 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($context)
+	{
+		$output = '';
+
+		foreach (self::getUsedSections($context) as $section) {
+			$output .= self::renderSection($section, $context);
+		}
+
+		return $output;
+	}
 }

src/Mail/AbstractMail.php

Indentation +204 added lines, -204 removed lines

@@ -1,13 +1,13 @@ 
 <?php
 /**
- * AbstractMail
- *
- * @package   brightnucleus/chainmail
- * @author    Alain Schlesser <alain.schlesser@gmail.com>
- * @license   GPL-2.0+
- * @link      http://www.brightnucleus.com/
- * @copyright 2016 Alain Schlesser, Bright Nucleus
- */
+	 * AbstractMail
+	 *
+	 * @package   brightnucleus/chainmail
+	 * @author    Alain Schlesser <alain.schlesser@gmail.com>
+	 * @license   GPL-2.0+
+	 * @link      http://www.brightnucleus.com/
+	 * @copyright 2016 Alain Schlesser, Bright Nucleus
+	 */
 
 namespace BrightNucleus\ChainMail\Mail;
 
@@ -29,200 +29,200 @@ 
 abstract class AbstractMail implements MailInterface
 {
 
-    /**
-     * Configuration Settings.
-     *
-     * @since 1.0.0
-     *
-     * @var ConfigInterface
-     */
-    protected $config;
-
-    /**
-     * Template that is used for the email.
-     *
-     * @since 1.0.0
-     *
-     * @var TemplateInterface
-     */
-    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;
-
-    /**
-     * Instantiate an AbstractMail object.
-     *
-     * @since 1.0.0
-     *
-     * @param ConfigInterface $config
-     */
-    public function __construct(ConfigInterface $config)
-    {
-        $this->config = $config;
-        $this->setFormat();
-    }
-
-    /**
-     * 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 use for the renderer.
-     *
-     * @since 1.0.0
-     *
-     * @param string|TemplateInterface $template Template to use for the
-     *                                           renderer.
-     * @throws RuntimeException
-     */
-    public function setTemplate($template)
-    {
-        if (is_string($template)) {
-            $template = $this->createTemplate($template);
-        }
-        $this->template = $template;
-    }
-
-    /**
-     * Get the template to use for the renderer.
-     *
-     * @since 1.0.0
-     *
-     * @return TemplateInterface 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 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 TemplateInterface $template Newly created instance.
-     * @throws RuntimeException
-     */
-    protected function createTemplate($template)
-    {
-        $templateFactory = new Factory($this->config, 'templates');
-
-        return $templateFactory->create($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
-     * @throws RuntimeException
-     */
-    public function render(array $context)
-    {
-
-        $template = $this->getTemplate();
-
-        $context['template'] = $template;
-
-        $sections = $template->getUsedSections();
-
-        $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]);
-        }
-
-        $context['format'] = $this->getFormat();
-
-        $context = $this->setContext($context);
-
-        return $template->render($context);
-    }
-
-    /**
-     * 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 TemplateInterface
+	 */
+	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;
+
+	/**
+	 * Instantiate an AbstractMail object.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param ConfigInterface $config
+	 */
+	public function __construct(ConfigInterface $config)
+	{
+		$this->config = $config;
+		$this->setFormat();
+	}
+
+	/**
+	 * 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 use for the renderer.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string|TemplateInterface $template Template to use for the
+	 *                                           renderer.
+	 * @throws RuntimeException
+	 */
+	public function setTemplate($template)
+	{
+		if (is_string($template)) {
+			$template = $this->createTemplate($template);
+		}
+		$this->template = $template;
+	}
+
+	/**
+	 * Get the template to use for the renderer.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return TemplateInterface 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 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 TemplateInterface $template Newly created instance.
+	 * @throws RuntimeException
+	 */
+	protected function createTemplate($template)
+	{
+		$templateFactory = new Factory($this->config, 'templates');
+
+		return $templateFactory->create($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
+	 * @throws RuntimeException
+	 */
+	public function render(array $context)
+	{
+
+		$template = $this->getTemplate();
+
+		$context['template'] = $template;
+
+		$sections = $template->getUsedSections();
+
+		$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]);
+		}
+
+		$context['format'] = $this->getFormat();
+
+		$context = $this->setContext($context);
+
+		return $template->render($context);
+	}
+
+	/**
+	 * 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/MailInterface.php

Indentation +36 added lines, -36 removed lines

@@ -1,13 +1,13 @@ 
 <?php
 /**
- * MailInterface
- *
- * @package   brightnucleus/chainmail
- * @author    Alain Schlesser <alain.schlesser@gmail.com>
- * @license   GPL-2.0+
- * @link      http://www.brightnucleus.com/
- * @copyright 2016 Alain Schlesser, Bright Nucleus
- */
+	 * MailInterface
+	 *
+	 * @package   brightnucleus/chainmail
+	 * @author    Alain Schlesser <alain.schlesser@gmail.com>
+	 * @license   GPL-2.0+
+	 * @link      http://www.brightnucleus.com/
+	 * @copyright 2016 Alain Schlesser, Bright Nucleus
+	 */
 
 namespace BrightNucleus\ChainMail;
 
@@ -24,34 +24,34 @@ 
 interface MailInterface extends Renderable
 {
 
-    /**
-     * Set the template that the email will use.
-     *
-     * @since 1.0.0
-     *
-     * @param string|TemplateInterface $template Template to use.
-     * @return void
-     */
-    public function setTemplate($template);
+	/**
+	 * Set the template that the email will use.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string|TemplateInterface $template Template to use.
+	 * @return void
+	 */
+	public function setTemplate($template);
 
-    /**
-     * Get the instance of the template.
-     *
-     * @since 1.0.0
-     *
-     * @return TemplateInterface
-     */
-    public function getTemplate();
+	/**
+	 * Get the instance of the template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return TemplateInterface
+	 */
+	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/Section/AbstractSection.php

Indentation +160 added lines, -160 removed lines

@@ -1,13 +1,13 @@ 
 <?php
 /**
- * AbstractSection
- *
- * @package   brightnucleus/chainmail
- * @author    Alain Schlesser <alain.schlesser@gmail.com>
- * @license   GPL-2.0+
- * @link      http://www.brightnucleus.com/
- * @copyright 2016 Alain Schlesser, Bright Nucleus
- */
+	 * AbstractSection
+	 *
+	 * @package   brightnucleus/chainmail
+	 * @author    Alain Schlesser <alain.schlesser@gmail.com>
+	 * @license   GPL-2.0+
+	 * @link      http://www.brightnucleus.com/
+	 * @copyright 2016 Alain Schlesser, Bright Nucleus
+	 */
 
 namespace BrightNucleus\ChainMail\Section;
 
@@ -27,156 +27,156 @@ 
 abstract class AbstractSection implements SectionInterface
 {
 
-    /**
-     * 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;
-
-    /**
-     * 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, $arguments)
-    {
-        $this->config = $config;
-        list($section, $content) = $arguments;
-        $this->setSectionName($section);
-        $this->content = $content;
-    }
-
-    /**
-     * Set the name of the Section.
-     *
-     * @since 1.0.0
-     *
-     * @param string|null $section Optional. Name of the section.
-     * @throws RuntimeException
-     */
-    protected function setSectionName($section = null)
-    {
-        if (null === $section) {
-            throw new RuntimeException('Initialised section without passing it a section name.');
-        }
-        if ( ! array_key_exists($section, $this->config['sections'])) {
-            throw new RuntimeException('Initialised section with an unknown section name.');
-        }
-        $this->sectionName = $section;
-    }
-
-    /**
-     * Get the name of the Section.
-     *
-     * @since 1.0.0
-     *
-     * @return string Name of the section.
-     */
-    public function getSectionName()
-    {
-        return $this->sectionName;
-    }
-
-    /**
-     * Get the name of the View to use for rendering.
-     *
-     * @since 1.0.0
-     *
-     * @return string Name of the view.
-     */
-    protected function getViewName()
-    {
-        return $this->config['sections'][$this->getSectionName()]['view_name'];
-    }
-
-    /**
-     * 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)
-    {
-
-        $viewLocation = $this->getViewLocation($context);
-        $viewType     = $this->config['view_type'];
-
-        $viewFactory = new Factory($this->config, 'view_types');
-        $view        = $viewFactory->create($viewType, $viewLocation);
-
-        $context['css_class'] = $this->getCSSClass();
-
-        return $view->render($context, $this->content);
-    }
-
-    /**
-     * Get the location of the view that is used for rendering.
-     *
-     * @since 1.0.0
-     *
-     * @param array $context Context for which to get the view location.
-     * @return string
-     */
-    protected function getViewLocation(array $context)
-    {
-        return $this->getViewRoot() . '/sections/' . $context['format'] . '/' . $this->getViewName();
-    }
-
-    /**
-     * Get the root location of the view that is used for rendering.
-     *
-     * @since 1.0.0
-     *
-     * @return string
-     */
-    protected function getViewRoot()
-    {
-        $viewRoots   = $this->config['view_root_locations'];
-        $viewRootKey = $this->config['sections'][$this->getSectionName()]['view_location'];
-
-        return $viewRoots[$viewRootKey];
-    }
-
-    /**
-     * 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;
+
+	/**
+	 * 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, $arguments)
+	{
+		$this->config = $config;
+		list($section, $content) = $arguments;
+		$this->setSectionName($section);
+		$this->content = $content;
+	}
+
+	/**
+	 * Set the name of the Section.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string|null $section Optional. Name of the section.
+	 * @throws RuntimeException
+	 */
+	protected function setSectionName($section = null)
+	{
+		if (null === $section) {
+			throw new RuntimeException('Initialised section without passing it a section name.');
+		}
+		if ( ! array_key_exists($section, $this->config['sections'])) {
+			throw new RuntimeException('Initialised section with an unknown section name.');
+		}
+		$this->sectionName = $section;
+	}
+
+	/**
+	 * Get the name of the Section.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string Name of the section.
+	 */
+	public function getSectionName()
+	{
+		return $this->sectionName;
+	}
+
+	/**
+	 * Get the name of the View to use for rendering.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string Name of the view.
+	 */
+	protected function getViewName()
+	{
+		return $this->config['sections'][$this->getSectionName()]['view_name'];
+	}
+
+	/**
+	 * 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)
+	{
+
+		$viewLocation = $this->getViewLocation($context);
+		$viewType     = $this->config['view_type'];
+
+		$viewFactory = new Factory($this->config, 'view_types');
+		$view        = $viewFactory->create($viewType, $viewLocation);
+
+		$context['css_class'] = $this->getCSSClass();
+
+		return $view->render($context, $this->content);
+	}
+
+	/**
+	 * Get the location of the view that is used for rendering.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $context Context for which to get the view location.
+	 * @return string
+	 */
+	protected function getViewLocation(array $context)
+	{
+		return $this->getViewRoot() . '/sections/' . $context['format'] . '/' . $this->getViewName();
+	}
+
+	/**
+	 * Get the root location of the view that is used for rendering.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string
+	 */
+	protected function getViewRoot()
+	{
+		$viewRoots   = $this->config['view_root_locations'];
+		$viewRootKey = $this->config['sections'][$this->getSectionName()]['view_location'];
+
+		return $viewRoots[$viewRootKey];
+	}
+
+	/**
+	 * 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/Template/AbstractTemplate.php

Indentation +153 added lines, -153 removed lines

@@ -1,13 +1,13 @@ 
 <?php
 /**
- * AbstractTemplate
- *
- * @package   brightnucleus/chainmail
- * @author    Alain Schlesser <alain.schlesser@gmail.com>
- * @license   GPL-2.0+
- * @link      http://www.brightnucleus.com/
- * @copyright 2016 Alain Schlesser, Bright Nucleus
- */
+	 * AbstractTemplate
+	 *
+	 * @package   brightnucleus/chainmail
+	 * @author    Alain Schlesser <alain.schlesser@gmail.com>
+	 * @license   GPL-2.0+
+	 * @link      http://www.brightnucleus.com/
+	 * @copyright 2016 Alain Schlesser, Bright Nucleus
+	 */
 
 namespace BrightNucleus\ChainMail\Template;
 
@@ -27,149 +27,149 @@ 
 abstract class AbstractTemplate implements TemplateInterface
 {
 
-    /**
-     * Configuration Settings.
-     *
-     * @since 1.0.0
-     *
-     * @var ConfigInterface
-     */
-    protected $config;
-
-    /**
-     * Name of the template.
-     *
-     * @since 1.0.0
-     *
-     * @var string
-     */
-    protected $templateName;
-
-    /**
-     * 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, $arguments)
-    {
-        $this->config = $config;
-        list($template) = $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 RuntimeException
-     */
-    protected function setTemplateName($template = null)
-    {
-        if (null === $template) {
-            throw new RuntimeException('Initialised template without passing it a template name.');
-        }
-        if ( ! array_key_exists($template, $this->config['templates'])) {
-            throw new RuntimeException('Initialised template with an unknown template name.');
-        }
-        $this->templateName = $template;
-    }
-
-    /**
-     * Get the name of the View to use for rendering.
-     *
-     * @since 1.0.0
-     *
-     * @return string Name of the view.
-     */
-    protected function getViewName()
-    {
-        return $this->config['templates'][$this->getTemplateName()]['view_name'];
-    }
-
-    /**
-     * 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.
-     * @throws RuntimeException
-     */
-    public function render(array $context)
-    {
-
-        $viewLocation = $this->getViewLocation($context);
-        $viewType     = $this->config['view_type'];
-
-        $viewFactory = new Factory($this->config, 'view_types');
-        $view        = $viewFactory->create($viewType, $viewLocation);
-
-        $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 location of the view that is used for rendering.
-     *
-     * @since 1.0.0
-     *
-     * @param array $context Context for which to get the view location.
-     * @return string
-     */
-    protected function getViewLocation(array $context)
-    {
-        return $this->getViewRoot() . '/templates/' . $context['format'] . '/' . $this->getViewName();
-    }
-
-    /**
-     * Get the root location of the view that is used for rendering.
-     *
-     * @since 1.0.0
-     *
-     * @return string
-     */
-    protected function getViewRoot()
-    {
-        $viewRoots   = $this->config['view_root_locations'];
-        $viewRootKey = $this->config['templates'][$this->getTemplateName()]['view_location'];
-
-        return $viewRoots[$viewRootKey];
-    }
+	/**
+	 * Configuration Settings.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var ConfigInterface
+	 */
+	protected $config;
+
+	/**
+	 * Name of the template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var string
+	 */
+	protected $templateName;
+
+	/**
+	 * 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, $arguments)
+	{
+		$this->config = $config;
+		list($template) = $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 RuntimeException
+	 */
+	protected function setTemplateName($template = null)
+	{
+		if (null === $template) {
+			throw new RuntimeException('Initialised template without passing it a template name.');
+		}
+		if ( ! array_key_exists($template, $this->config['templates'])) {
+			throw new RuntimeException('Initialised template with an unknown template name.');
+		}
+		$this->templateName = $template;
+	}
+
+	/**
+	 * Get the name of the View to use for rendering.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string Name of the view.
+	 */
+	protected function getViewName()
+	{
+		return $this->config['templates'][$this->getTemplateName()]['view_name'];
+	}
+
+	/**
+	 * 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.
+	 * @throws RuntimeException
+	 */
+	public function render(array $context)
+	{
+
+		$viewLocation = $this->getViewLocation($context);
+		$viewType     = $this->config['view_type'];
+
+		$viewFactory = new Factory($this->config, 'view_types');
+		$view        = $viewFactory->create($viewType, $viewLocation);
+
+		$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 location of the view that is used for rendering.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $context Context for which to get the view location.
+	 * @return string
+	 */
+	protected function getViewLocation(array $context)
+	{
+		return $this->getViewRoot() . '/templates/' . $context['format'] . '/' . $this->getViewName();
+	}
+
+	/**
+	 * Get the root location of the view that is used for rendering.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string
+	 */
+	protected function getViewRoot()
+	{
+		$viewRoots   = $this->config['view_root_locations'];
+		$viewRootKey = $this->config['templates'][$this->getTemplateName()]['view_location'];
+
+		return $viewRoots[$viewRootKey];
+	}
 }