brightnucleus / chainmail

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 FailedToInstantiateFactoryException 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 FailedToInstantiateFactoryException 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 FailedToInstantiateFactoryException(sprintf(
-                'Could not instantiate Factory for unknown Element Type "%1$s".',
-                $element
-            ));
-        }
+		if (! $this->config->hasKey($element)) {
+			throw new FailedToInstantiateFactoryException(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 FailedToInstantiateClassException 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 FailedToInstantiateClassException 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 FailedToInstantiateClassException(sprintf(
-                'Could not create object, unknown Type "%1$s" for "%2$s" elements.',
-                $type,
-                $this->element
-            ));
-        }
+		if (! array_key_exists($type, $classMap)) {
+			throw new FailedToInstantiateClassException(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);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -59,7 +59,7 @@ 
 
         $this->config = $config;
 
-        if (! $this->config->hasKey($element)) {
+        if ( ! $this->config->hasKey($element)) {
             throw new FailedToInstantiateFactoryException(sprintf(
                 'Could not instantiate Factory for unknown Element Type "%1$s".',
                 $element
@@ -85,7 +85,7 @@ 
 
         $classMap = $this->config[$this->element];
 
-        if (! array_key_exists($type, $classMap)) {
+        if ( ! array_key_exists($type, $classMap)) {
             throw new FailedToInstantiateClassException(sprintf(
                 'Could not create object, unknown Type "%1$s" for "%2$s" elements.',
                 $type,

src/TemplateInterface.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 +111 added lines, -111 removed lines

@@ -26,115 +26,115 @@
 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, $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;
-    }
-
-    /**
-     * 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
-     */
-    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;
-    }
+	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, $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;
+	}
+
+	/**
+	 * 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
+	 */
+	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;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -26,7 +26,7 @@ 
 class ChainMail
 {
 
-    const DEFAULT_CONFIG = __DIR__ . '/../config/defaults.php';
+    const DEFAULT_CONFIG = __DIR__.'/../config/defaults.php';
 
     /**
      * Configuration Settings.
@@ -49,15 +49,15 @@ 
 
         $defaults = ConfigFactory::create(include(self::DEFAULT_CONFIG));
 
-        if (! $config) {
+        if ( ! $config) {
             $this->config = $defaults;
 
             return;
         }
 
         $this->config = ConfigFactory::create(array_merge(
-                (array)$defaults,
-                (array)$config)
+                (array) $defaults,
+                (array) $config)
         );
     }
 

src/Renderable.php

Indentation +10 added lines, -10 removed lines

@@ -22,14 +22,14 @@
 interface Renderable
 {
 
-    /**
-     * 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.
-     */
-    public function render(array $context);
+	/**
+	 * 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.
+	 */
+	public function render(array $context);
 }

src/Section/AbstractSection.php

Indentation +157 added lines, -157 removed lines

@@ -28,161 +28,161 @@
 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;
-    }
-
-    /**
-     * 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 FailedToInitialiseSectionException If no section name was passed.
-     * @throws FailedToInitialiseSectionException If an unknown section name was passed.
-     */
-    protected function setSectionName($section = null)
-    {
-        if (null === $section) {
-            throw new FailedToInitialiseSectionException('Initialised section without passing it a section name.');
-        }
-        if (! array_key_exists($section, $this->config['sections'])) {
-            throw new FailedToInitialiseSectionException('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)
-    {
-
-        $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 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'];
-    }
-
-    /**
-     * 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;
+	}
+
+	/**
+	 * 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 FailedToInitialiseSectionException If no section name was passed.
+	 * @throws FailedToInitialiseSectionException If an unknown section name was passed.
+	 */
+	protected function setSectionName($section = null)
+	{
+		if (null === $section) {
+			throw new FailedToInitialiseSectionException('Initialised section without passing it a section name.');
+		}
+		if (! array_key_exists($section, $this->config['sections'])) {
+			throw new FailedToInitialiseSectionException('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)
+	{
+
+		$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 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'];
+	}
+
+	/**
+	 * 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'];
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -103,7 +103,7 @@ 
         if (null === $section) {
             throw new FailedToInitialiseSectionException('Initialised section without passing it a section name.');
         }
-        if (! array_key_exists($section, $this->config['sections'])) {
+        if ( ! array_key_exists($section, $this->config['sections'])) {
             throw new FailedToInitialiseSectionException('Initialised section with an unknown section name.');
         }
         $this->sectionName = $section;
@@ -156,7 +156,7 @@ 
      */
     protected function getViewLocation(array $context)
     {
-        return $this->getViewRoot() . '/sections/' . $context['format'] . '/' . $this->getViewName();
+        return $this->getViewRoot().'/sections/'.$context['format'].'/'.$this->getViewName();
     }
 
     /**

src/Validator/HTMLValidator.php

Indentation +14 added lines, -14 removed lines

@@ -22,18 +22,18 @@
 class HTMLValidator extends AbstractValidator
 {
 
-    /**
-     * 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)
-    {
-        return $content;
-    }
+	/**
+	 * 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)
+	{
+		return $content;
+	}
 }

src/Validator/TextValidator.php

Indentation +14 added lines, -14 removed lines

@@ -22,18 +22,18 @@
 class TextValidator extends AbstractValidator
 {
 
-    /**
-     * 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)
-    {
-        return $content;
-    }
+	/**
+	 * 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)
+	{
+		return $content;
+	}
 }

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();
 }

src/SanitizerInterface.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);
 }