brightnucleus / chainmail

config/defaults.php

Indentation +136 added lines, -136 removed lines

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

Spacing +1 added lines, -1 removed lines

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

src/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, array $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(array $context)
-    {
-        /** @var TemplateInterface $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|TemplateInterface $template      Optional. Template to be
-     *                                                used.
-     *
-     * @return MailInterface
-     */
-    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 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(array $context)
+	{
+		/** @var TemplateInterface $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|TemplateInterface $template      Optional. Template to be
+	 *                                                used.
+	 *
+	 * @return MailInterface
+	 */
+	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/AbstractSection.php

Indentation +141 added lines, -141 removed lines

@@ -28,145 +28,145 @@
 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;
-
-    /**
-     * 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 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)
-    {
-
-        $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 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)
+	{
+
+		$viewName = $this->getViewName($context);
+		$view     = $this->viewBuilder->create($viewName);
+
+		$context['css_class'] = $this->getCSSClass();
+		$context['content']   = $this->content;
+
+		return $view->render($context);
+	}
+
+	/**
+	 * Get the name of the View to use for rendering.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $context The context in which to render the template.
+	 *
+	 * @return string Name of the view.
+	 */
+	protected function getViewName(array $context)
+	{
+		return $this->config['sections'][$this->getSectionName()]['view_name']
+			   . '.' . $context['format'];
+	}
+
+	/**
+	 * Get the CSS class that is used for the section.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string
+	 */
+	protected function getCSSClass()
+	{
+		return $this->config['sections'][$this->getSectionName()]['css_class'];
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -113,7 +113,7 @@ 
                 '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.'
             );
@@ -155,7 +155,7 @@ 
     protected function getViewName(array $context)
     {
         return $this->config['sections'][$this->getSectionName()]['view_name']
-               . '.' . $context['format'];
+               . '.'.$context['format'];
     }
 
     /**

src/View/MailView.php

Indentation +13 added lines, -13 removed lines

@@ -24,17 +24,17 @@
 class MailView extends AbstractView
 {
 
-    /**
-     * Check whether the Findable can handle an individual criterion.
-     *
-     * @since 0.1.0
-     *
-     * @param mixed $criterion Criterion to check.
-     *
-     * @return bool Whether the Findable can handle the criterion.
-     */
-    public function canHandle($criterion)
-    {
-        return $criterion === $this->uri;
-    }
+	/**
+	 * Check whether the Findable can handle an individual criterion.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param mixed $criterion Criterion to check.
+	 *
+	 * @return bool Whether the Findable can handle the criterion.
+	 */
+	public function canHandle($criterion)
+	{
+		return $criterion === $this->uri;
+	}
 }

src/Mail/AbstractMail.php

Indentation +254 added lines, -254 removed lines

@@ -34,258 +34,258 @@
 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;
-
-    /**
-     * 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 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 use for the renderer.
-     *
-     * @since 1.0.0
-     *
-     * @param string|TemplateInterface $template Template to use for the
-     *                                           renderer.
-     *
-     * @throws InvalidTemplateException If the template class could not be instantiated.
-     * @throws InvalidTemplateException 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 InvalidTemplateException(
-                'Could not instantiate the template class "%1$s". Reason: "%2$s".',
-                $template,
-                $exception->getMessage()
-            );
-        }
-
-        if (! $template instanceof TemplateInterface) {
-            throw new InvalidTemplateException(
-                '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 TemplateInterface $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 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;
+
+	/**
+	 * 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 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 use for the renderer.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string|TemplateInterface $template Template to use for the
+	 *                                           renderer.
+	 *
+	 * @throws InvalidTemplateException If the template class could not be instantiated.
+	 * @throws InvalidTemplateException 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 InvalidTemplateException(
+				'Could not instantiate the template class "%1$s". Reason: "%2$s".',
+				$template,
+				$exception->getMessage()
+			);
+		}
+
+		if (! $template instanceof TemplateInterface) {
+			throw new InvalidTemplateException(
+				'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 TemplateInterface $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);
 }

Spacing +3 added lines, -3 removed lines

@@ -116,7 +116,7 @@ 
     public function getTemplate()
     {
 
-        if (! $this->template) {
+        if ( ! $this->template) {
             $this->setDefaultTemplate();
         }
 
@@ -152,10 +152,10 @@ 
             );
         }
 
-        if (! $template instanceof TemplateInterface) {
+        if ( ! $template instanceof TemplateInterface) {
             throw new InvalidTemplateException(
                 'Could not set the template, invalid type.',
-                (array)$template
+                (array) $template
             );
         }
         $this->template = $template;

src/Template/AbstractTemplate.php

Indentation +128 added lines, -128 removed lines

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

Spacing +2 added lines, -2 removed lines

@@ -101,7 +101,7 @@ 
         if (null === $template) {
             throw new FailedToInitialiseTemplateException('Initialised template without passing it a template name.');
         }
-        if (! array_key_exists($template, $this->config['templates'])) {
+        if ( ! array_key_exists($template, $this->config['templates'])) {
             throw new FailedToInitialiseTemplateException('Initialised template with an unknown template name.');
         }
         $this->templateName = $template;
@@ -155,6 +155,6 @@ 
     protected function getViewName(array $context)
     {
         return $this->config['templates'][$this->getTemplateName()]['view_name']
-               . '.' . $context['format'];
+               . '.'.$context['format'];
     }
 }