brightnucleus / chainmail

src/SanitizerInterface.php

Indentation +18 added lines, -18 removed lines

@@ -1,13 +1,13 @@ 
 <?php
 /**
- * SanitizerInterface
- *
- * @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
- */
+	 * SanitizerInterface
+	 *
+	 * @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;
 
@@ -22,14 +22,14 @@ 
 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);
 }
\ No newline at end of file

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 $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 $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/Section/GenericSection.php

Indentation +8 added lines, -8 removed lines

@@ -1,13 +1,13 @@
 <?php
 /**
- * GenericSection
- *
- * @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
- */
+	 * GenericSection
+	 *
+	 * @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;
 

src/SectionInterface.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();
 }
\ No newline at end of file

src/Support/Config.php

Indentation +74 added lines, -74 removed lines

@@ -1,13 +1,13 @@ 
 <?php
 /**
- * Config
- *
- * @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
- */
+	 * Config
+	 *
+	 * @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\Support;
 
@@ -24,75 +24,75 @@ 
 class Config extends ArrayObject implements ConfigInterface
 {
 
-    /**
-     * Instantiate the Config object.
-     *
-     * @since 1.0.0
-     *
-     * @param  array $config Array with settings.
-     */
-    public function __construct(array $config)
-    {
-        // Make sure the config entries can be accessed as properties.
-        parent::__construct($config, ArrayObject::ARRAY_AS_PROPS);
-    }
+	/**
+	 * Instantiate the Config object.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param  array $config Array with settings.
+	 */
+	public function __construct(array $config)
+	{
+		// Make sure the config entries can be accessed as properties.
+		parent::__construct($config, ArrayObject::ARRAY_AS_PROPS);
+	}
 
-    /**
-     * Magic method that enables the use of normal array_* functions on the
-     * Config object.
-     *
-     * @since  1.0.0
-     *
-     * @param  string $function  The function that was called on this object.
-     * @param  mixed  $arguments The arguments that were used for the function
-     *                           call.
-     * @return mixed
-     * @throws BadMethodCallException
-     */
-    public function __call($function, $arguments)
-    {
-        if ( ! is_callable($function) || substr($function, 0, 6) !== 'array_') {
-            throw new BadMethodCallException(__CLASS__ . '->' . $function);
-        }
+	/**
+	 * Magic method that enables the use of normal array_* functions on the
+	 * Config object.
+	 *
+	 * @since  1.0.0
+	 *
+	 * @param  string $function  The function that was called on this object.
+	 * @param  mixed  $arguments The arguments that were used for the function
+	 *                           call.
+	 * @return mixed
+	 * @throws BadMethodCallException
+	 */
+	public function __call($function, $arguments)
+	{
+		if ( ! is_callable($function) || substr($function, 0, 6) !== 'array_') {
+			throw new BadMethodCallException(__CLASS__ . '->' . $function);
+		}
 
-        return call_user_func_array($function,
-            array_merge(array($this->getArrayCopy()), $arguments));
-    }
+		return call_user_func_array($function,
+			array_merge(array($this->getArrayCopy()), $arguments));
+	}
 
-    /**
-     * Check whether the Config has a specific key.
-     *
-     * @since 1.0.0
-     *
-     * @param string $key The key to check the existence for.
-     * @return bool
-     */
-    public function hasKey($key)
-    {
-        return array_key_exists($key, (array)$this);
-    }
+	/**
+	 * Check whether the Config has a specific key.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $key The key to check the existence for.
+	 * @return bool
+	 */
+	public function hasKey($key)
+	{
+		return array_key_exists($key, (array)$this);
+	}
 
-    /**
-     * Get the value of a specific key.
-     *
-     * @since 1.0.0
-     *
-     * @param string $key The key to get the value for.
-     * @return mixed
-     */
-    public function getKey($key)
-    {
-        return $this[$key];
-    }
+	/**
+	 * Get the value of a specific key.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $key The key to get the value for.
+	 * @return mixed
+	 */
+	public function getKey($key)
+	{
+		return $this[$key];
+	}
 
-    /**
-     * Get the an array with all the keys
-     *
-     * @since 1.0.0
-     * @return mixed
-     */
-    public function getKeys()
-    {
-        return array_keys((array)$this);
-    }
+	/**
+	 * Get the an array with all the keys
+	 *
+	 * @since 1.0.0
+	 * @return mixed
+	 */
+	public function getKeys()
+	{
+		return array_keys((array)$this);
+	}
 }
\ No newline at end of file

src/Support/ConfigInterface.php

Indentation +48 added lines, -48 removed lines

@@ -1,13 +1,13 @@ 
 <?php
 /**
- * ConfigInterface
- *
- * @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
- */
+	 * ConfigInterface
+	 *
+	 * @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\Support;
 
@@ -23,47 +23,47 @@ 
 interface ConfigInterface extends ArrayAccess
 {
 
-    /**
-     * Creates a copy of the ArrayObject.
-     *
-     * Returns a copy of the array. When the ArrayObject refers to an object an
-     * array of the public properties of that object will be returned.
-     * This is implemented by \ArrayObject.
-     *
-     * @since 1.0.0
-     *
-     * @return array Copy of the array.
-     */
-    public function getArrayCopy();
+	/**
+	 * Creates a copy of the ArrayObject.
+	 *
+	 * Returns a copy of the array. When the ArrayObject refers to an object an
+	 * array of the public properties of that object will be returned.
+	 * This is implemented by \ArrayObject.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return array Copy of the array.
+	 */
+	public function getArrayCopy();
 
-    /**
-     * Check whether the Config has a specific key.
-     *
-     * @since 1.0.0
-     *
-     * @param string $key The key to check the existence for.
-     *
-     * @return bool
-     */
-    public function hasKey($key);
+	/**
+	 * Check whether the Config has a specific key.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $key The key to check the existence for.
+	 *
+	 * @return bool
+	 */
+	public function hasKey($key);
 
-    /**
-     * Get the value of a specific key.
-     *
-     * @since 1.0.0
-     *
-     * @param string $key The key to get the value for.
-     *
-     * @return mixed
-     */
-    public function getKey($key);
+	/**
+	 * Get the value of a specific key.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $key The key to get the value for.
+	 *
+	 * @return mixed
+	 */
+	public function getKey($key);
 
-    /**
-     * Get the an array with all the keys
-     *
-     * @since 1.0.0
-     *
-     * @return mixed
-     */
-    public function getKeys();
+	/**
+	 * Get the an array with all the keys
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return mixed
+	 */
+	public function getKeys();
 }
\ No newline at end of file

src/Support/Factory.php

Indentation +68 added lines, -68 removed lines

@@ -1,13 +1,13 @@ 
 <?php
 /**
- * Factory
- *
- * @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
- */
+	 * Factory
+	 *
+	 * @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\Support;
 
@@ -24,74 +24,74 @@ 
 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 RuntimeException 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 RuntimeException 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 RuntimeException(sprintf(
-                'Could not instantiate Factory for unknown Element Type "%1$s".',
-                $element
-            ));
-        }
+		if ( ! $this->config->hasKey($element)) {
+			throw new RuntimeException(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 mixed
-     * @throws RuntimeException 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 mixed
+	 * @throws RuntimeException 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 RuntimeException(sprintf(
-                'Could not create object, unknown Type "%1$s" for "%2$s" elements.',
-                $type,
-                $this->element
-            ));
-        }
+		if ( ! array_key_exists($type, $classMap)) {
+			throw new RuntimeException(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 +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 $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 $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];
+	}
 }

src/Template/GenericTemplate.php

Indentation +8 added lines, -8 removed lines

@@ -1,13 +1,13 @@
 <?php
 /**
- * GenericTemplate
- *
- * @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
- */
+	 * GenericTemplate
+	 *
+	 * @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;