brightnucleus / chainmail

src/Mail.php

Indentation +40 added lines, -40 removed lines

@@ -25,47 +25,47 @@
 interface Mail extends Renderable
 {
 
-    /**
-     * Set the template that the email will use.
-     *
-     * @since 1.0.0
-     *
-     * @param string|Template $template Template to use.
-     *
-     * @return Mail
-     */
-    public function setTemplate($template);
+	/**
+	 * Set the template that the email will use.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string|Template $template Template to use.
+	 *
+	 * @return Mail
+	 */
+	public function setTemplate($template);
 
-    /**
-     * Get the instance of the template.
-     *
-     * @since 1.0.0
-     *
-     * @return Template
-     */
-    public function getTemplate();
+	/**
+	 * Get the instance of the template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return Template
+	 */
+	public function getTemplate();
 
-    /**
-     * Add a section to the Mail.
-     *
-     * @since 1.0.0
-     *
-     * @param string $type    Type of section to add.
-     * @param string $content Content of the section.
-     *
-     * @return Mail
-     * @throws RuntimeException
-     */
-    public function addSection($type, $content);
+	/**
+	 * Add a section to the Mail.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $type    Type of section to add.
+	 * @param string $content Content of the section.
+	 *
+	 * @return Mail
+	 * @throws RuntimeException
+	 */
+	public function addSection($type, $content);
 
-    /**
-     * Send the email to one or more recipients.
-     *
-     * @since 1.0.0
-     *
-     * @param Recipients|EmailAddress|array|string $recipients
-     *
-     * @return Mail
-     */
-    public function sendTo($recipients);
+	/**
+	 * Send the email to one or more recipients.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param Recipients|EmailAddress|array|string $recipients
+	 *
+	 * @return Mail
+	 */
+	public function sendTo($recipients);
 }

src/Support/Domain.php

Indentation +48 added lines, -48 removed lines

@@ -24,57 +24,57 @@
 class Domain
 {
 
-    /**
-     * Domain name.
-     *
-     * @var string
-     */
-    protected $domain;
+	/**
+	 * Domain name.
+	 *
+	 * @var string
+	 */
+	protected $domain;
 
-    /**
-     * Instantiate a Domain object.
-     *
-     * @param Domain|string $domain
-     *
-     * @throws InvalidDomain If the domain is not valid.
-     */
-    public function __construct($domain)
-    {
-        if ( ! $this->isValid($domain)) {
-            throw InvalidDomain::from($domain);
-        }
+	/**
+	 * Instantiate a Domain object.
+	 *
+	 * @param Domain|string $domain
+	 *
+	 * @throws InvalidDomain If the domain is not valid.
+	 */
+	public function __construct($domain)
+	{
+		if ( ! $this->isValid($domain)) {
+			throw InvalidDomain::from($domain);
+		}
 
-        $this->domain = (string)$domain;
-    }
+		$this->domain = (string)$domain;
+	}
 
-    /**
-     * Return the domain name.
-     *
-     * @return string
-     */
-    public function getDomain()
-    {
-        return $this->domain;
-    }
+	/**
+	 * Return the domain name.
+	 *
+	 * @return string
+	 */
+	public function getDomain()
+	{
+		return $this->domain;
+	}
 
-    /**
-     * Reutrn a string representation of the Domain object.
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->getDomain();
-    }
+	/**
+	 * Reutrn a string representation of the Domain object.
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->getDomain();
+	}
 
-    /**
-     * @param $domain
-     *
-     * @return bool
-     */
-    protected function isValid($domain)
-    {
-        // TODO: Implement real validation.
-        return $domain === trim($domain);
-    }
+	/**
+	 * @param $domain
+	 *
+	 * @return bool
+	 */
+	protected function isValid($domain)
+	{
+		// TODO: Implement real validation.
+		return $domain === trim($domain);
+	}
 }
\ No newline at end of file

src/Mail/AbstractMail.php

Indentation +300 added lines, -300 removed lines

@@ -36,304 +36,304 @@
 abstract class AbstractMail implements Mail
 {
 
-    /**
-     * Configuration Settings.
-     *
-     * @since 1.0.0
-     *
-     * @var ConfigInterface
-     */
-    protected $config;
-
-    /**
-     * Template that is used for the email.
-     *
-     * @since 1.0.0
-     *
-     * @var Template
-     */
-    protected $template;
-
-    /**
-     * Content for the different sections.
-     *
-     * @since 1.0.0
-     *
-     * @var array
-     */
-    protected $sectionContent = [];
-
-    /**
-     * Format of the mail.
-     *
-     * @since 1.0.0
-     *
-     * @var string
-     */
-    protected $format;
-
-    /**
-     * ViewBuilder to create template and section views.
-     *
-     * @since 1.0.0
-     *
-     * @var ViewBuilder
-     */
-    protected $viewBuilder;
-
-    /**
-     * Instantiate an AbstractMail object.
-     *
-     * @since 1.0.0
-     *
-     * @param ConfigInterface $config The Config to use.
-     *
-     * @throws FailedToProcessConfigException If the Config could not be processed.
-     */
-    public function __construct(ConfigInterface $config)
-    {
-        $this->config = $config;
-        $this->setFormat();
-
-        $this->viewBuilder = new ViewBuilder($config
-            ? $config->getSubConfig('ViewBuilder')
-            : null
-        );
-
-        foreach ($this->config->getKey('view_root_locations') as $folder) {
-            $this->viewBuilder->addLocation(
-                new FilesystemLocation($folder)
-            );
-        }
-    }
-
-    /**
-     * Get the template to use for the renderer.
-     *
-     * @since 1.0.0
-     *
-     * @return Template Reference to the template that is used.
-     * @throws RuntimeException
-     */
-    public function getTemplate()
-    {
-
-        if ( ! $this->template) {
-            $this->setDefaultTemplate();
-        }
-
-        if (is_string($this->template)) {
-            $this->template = $this->createTemplate($this->template);
-        }
-
-        return $this->template;
-    }
-
-    /**
-     * Set the template to use for the renderer.
-     *
-     * @since 1.0.0
-     *
-     * @param string|Template $template          Template to use for the
-     *                                           renderer.
-     *
-     * @return Mail
-     * @throws InvalidTemplate If the template class could not be instantiated.
-     * @throws InvalidTemplate If the template type is not recognized.
-     */
-    public function setTemplate($template)
-    {
-        try {
-            if (is_string($template)) {
-                $template = $this->createTemplate($template);
-            }
-        } catch (Exception $exception) {
-            throw new InvalidTemplate(
-                'Could not instantiate the template class "%1$s". Reason: "%2$s".',
-                $template,
-                $exception->getMessage()
-            );
-        }
-
-        if ( ! $template instanceof Template) {
-            throw new InvalidTemplate(
-                'Could not set the template, invalid type.',
-                (array)$template
-            );
-        }
-        $this->template = $template;
-
-        return $this;
-    }
-
-    /**
-     * 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);
-    }
-
-    /**
-     * Send the email to one or more recipients.
-     *
-     * @since 1.0.0
-     *
-     * @param Recipients|EmailAddress|array|string $recipients
-     *
-     * @return Mail
-     */
-    public function sendTo($recipients)
-    {
-        if ($recipients instanceof EmailAddress) {
-            return $this->executeSend($recipients);
-        }
-
-        if (is_string($recipients)) {
-            return $this->sendTo(new EmailAddress($recipients));
-        }
-
-        if ($recipients instanceof Recipients) {
-            array_walk($recipients, [$this, 'sendTo']);
-
-            return $this;
-        }
-    }
-
-    /**
-     * Execute the sending of one individual email.
-     *
-     * @since 1.0.0
-     *
-     * @param EmailAddress $recipient Recipient to send the email to.
-     *
-     * @return Mail
-     */
-    protected function executeSend(EmailAddress $recipient)
-    {
-        // Do the actual sending.
-        echo "Sending email to ${recipient}...";
-
-        return $this;
-    }
-
-    /**
-     * Instantiate the requested sections for a template.
-     *
-     * @since 1.0.0
-     *
-     * @param array $sections Sections to instantiate.
-     * @param array $context  The context in which to instantiate the sections.
-     */
-    protected function instantiateSections(array $sections, array &$context)
-    {
-        $sectionFactory = new Factory($this->config, 'sections');
-
-        foreach ($sections as $section) {
-
-            $content = null;
-
-            if (array_key_exists($section, $this->sectionContent)) {
-                $content = $this->sectionContent[$section];
-            }
-
-            $context['sections'][$section] = $sectionFactory->create(
-                $section,
-                [$section, $content, $this->viewBuilder]
-            );
-        }
-    }
-
-    /**
-     * Set the format of the mail.
-     *
-     * @since 1.0.0
-     *
-     * @return string Format of the Mail.
-     */
-    protected function getFormat()
-    {
-        return $this->format;
-    }
-
-    /**
-     * Set the format of the mail.
-     *
-     * @since 1.0.0
-     *
-     * @return void
-     */
-    abstract protected function setFormat();
-
-    /**
-     * Set the template to the default template defined in the configuration.
-     *
-     * @since 1.0.0
-     *
-     * @throws RuntimeException
-     */
-    protected function setDefaultTemplate()
-    {
-        $defaultTemplate = $this->config->getKey('default_template');
-        $this->setTemplate($defaultTemplate);
-    }
-
-    /**
-     * Create an instance of a template.
-     *
-     * @since 1.0.0
-     *
-     * @param string $template Template to instantiate.
-     *
-     * @return Template $template Newly created instance.
-     * @throws RuntimeException
-     */
-    protected function createTemplate($template)
-    {
-        $templateFactory = new Factory($this->config, 'templates');
-
-        return $templateFactory->create($template, [$template, $this->viewBuilder]);
-    }
-
-    /**
-     * Set the context of the mail.
-     *
-     * @since 1.0.0
-     *
-     * @param array $context Context to set/modify.
-     *
-     * @return array Updated context.
-     */
-    abstract protected function setContext(array $context);
+	/**
+	 * Configuration Settings.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var ConfigInterface
+	 */
+	protected $config;
+
+	/**
+	 * Template that is used for the email.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var Template
+	 */
+	protected $template;
+
+	/**
+	 * Content for the different sections.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var array
+	 */
+	protected $sectionContent = [];
+
+	/**
+	 * Format of the mail.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var string
+	 */
+	protected $format;
+
+	/**
+	 * ViewBuilder to create template and section views.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var ViewBuilder
+	 */
+	protected $viewBuilder;
+
+	/**
+	 * Instantiate an AbstractMail object.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param ConfigInterface $config The Config to use.
+	 *
+	 * @throws FailedToProcessConfigException If the Config could not be processed.
+	 */
+	public function __construct(ConfigInterface $config)
+	{
+		$this->config = $config;
+		$this->setFormat();
+
+		$this->viewBuilder = new ViewBuilder($config
+			? $config->getSubConfig('ViewBuilder')
+			: null
+		);
+
+		foreach ($this->config->getKey('view_root_locations') as $folder) {
+			$this->viewBuilder->addLocation(
+				new FilesystemLocation($folder)
+			);
+		}
+	}
+
+	/**
+	 * Get the template to use for the renderer.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return Template Reference to the template that is used.
+	 * @throws RuntimeException
+	 */
+	public function getTemplate()
+	{
+
+		if ( ! $this->template) {
+			$this->setDefaultTemplate();
+		}
+
+		if (is_string($this->template)) {
+			$this->template = $this->createTemplate($this->template);
+		}
+
+		return $this->template;
+	}
+
+	/**
+	 * Set the template to use for the renderer.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string|Template $template          Template to use for the
+	 *                                           renderer.
+	 *
+	 * @return Mail
+	 * @throws InvalidTemplate If the template class could not be instantiated.
+	 * @throws InvalidTemplate If the template type is not recognized.
+	 */
+	public function setTemplate($template)
+	{
+		try {
+			if (is_string($template)) {
+				$template = $this->createTemplate($template);
+			}
+		} catch (Exception $exception) {
+			throw new InvalidTemplate(
+				'Could not instantiate the template class "%1$s". Reason: "%2$s".',
+				$template,
+				$exception->getMessage()
+			);
+		}
+
+		if ( ! $template instanceof Template) {
+			throw new InvalidTemplate(
+				'Could not set the template, invalid type.',
+				(array)$template
+			);
+		}
+		$this->template = $template;
+
+		return $this;
+	}
+
+	/**
+	 * 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);
+	}
+
+	/**
+	 * Send the email to one or more recipients.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param Recipients|EmailAddress|array|string $recipients
+	 *
+	 * @return Mail
+	 */
+	public function sendTo($recipients)
+	{
+		if ($recipients instanceof EmailAddress) {
+			return $this->executeSend($recipients);
+		}
+
+		if (is_string($recipients)) {
+			return $this->sendTo(new EmailAddress($recipients));
+		}
+
+		if ($recipients instanceof Recipients) {
+			array_walk($recipients, [$this, 'sendTo']);
+
+			return $this;
+		}
+	}
+
+	/**
+	 * Execute the sending of one individual email.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param EmailAddress $recipient Recipient to send the email to.
+	 *
+	 * @return Mail
+	 */
+	protected function executeSend(EmailAddress $recipient)
+	{
+		// Do the actual sending.
+		echo "Sending email to ${recipient}...";
+
+		return $this;
+	}
+
+	/**
+	 * Instantiate the requested sections for a template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $sections Sections to instantiate.
+	 * @param array $context  The context in which to instantiate the sections.
+	 */
+	protected function instantiateSections(array $sections, array &$context)
+	{
+		$sectionFactory = new Factory($this->config, 'sections');
+
+		foreach ($sections as $section) {
+
+			$content = null;
+
+			if (array_key_exists($section, $this->sectionContent)) {
+				$content = $this->sectionContent[$section];
+			}
+
+			$context['sections'][$section] = $sectionFactory->create(
+				$section,
+				[$section, $content, $this->viewBuilder]
+			);
+		}
+	}
+
+	/**
+	 * Set the format of the mail.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return string Format of the Mail.
+	 */
+	protected function getFormat()
+	{
+		return $this->format;
+	}
+
+	/**
+	 * Set the format of the mail.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return void
+	 */
+	abstract protected function setFormat();
+
+	/**
+	 * Set the template to the default template defined in the configuration.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @throws RuntimeException
+	 */
+	protected function setDefaultTemplate()
+	{
+		$defaultTemplate = $this->config->getKey('default_template');
+		$this->setTemplate($defaultTemplate);
+	}
+
+	/**
+	 * Create an instance of a template.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param string $template Template to instantiate.
+	 *
+	 * @return Template $template Newly created instance.
+	 * @throws RuntimeException
+	 */
+	protected function createTemplate($template)
+	{
+		$templateFactory = new Factory($this->config, 'templates');
+
+		return $templateFactory->create($template, [$template, $this->viewBuilder]);
+	}
+
+	/**
+	 * Set the context of the mail.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param array $context Context to set/modify.
+	 *
+	 * @return array Updated context.
+	 */
+	abstract protected function setContext(array $context);
 }

src/Recipients.php

Indentation +30 added lines, -30 removed lines

@@ -25,40 +25,40 @@
 class Recipients extends ArrayCollection
 {
 
-    /**
-     * Instantiate a Recipients object.
-     *
-     * @param array $emails Array of email addresses and/or recipients.
-     */
-    public function __construct(array $emails)
-    {
-        parent::__construct([]);
-        $this->add($emails);
-    }
+	/**
+	 * Instantiate a Recipients object.
+	 *
+	 * @param array $emails Array of email addresses and/or recipients.
+	 */
+	public function __construct(array $emails)
+	{
+		parent::__construct([]);
+		$this->add($emails);
+	}
 
-    /**
-     * Add an email address to the Recipients collection.
-     *
-     * @param Recipients|EmailAddress|array|string $email Email address to add.
-     *
-     * @return static
-     */
-    public function add($email)
-    {
-        if ($email instanceof EmailAddress) {
-            parent::add($email);
+	/**
+	 * Add an email address to the Recipients collection.
+	 *
+	 * @param Recipients|EmailAddress|array|string $email Email address to add.
+	 *
+	 * @return static
+	 */
+	public function add($email)
+	{
+		if ($email instanceof EmailAddress) {
+			parent::add($email);
 
-            return $this;
-        }
+			return $this;
+		}
 
-        if (is_array($email) || $email instanceof Recipients) {
-            array_walk($email, [$this, 'add']);
+		if (is_array($email) || $email instanceof Recipients) {
+			array_walk($email, [$this, 'add']);
 
-            return $this;
-        }
+			return $this;
+		}
 
-        parent::add(new EmailAddress($email));
+		parent::add(new EmailAddress($email));
 
-        return $this;
-    }
+		return $this;
+	}
 }
\ No newline at end of file

src/Support/EmailAddress.php

Indentation +84 added lines, -84 removed lines

@@ -25,96 +25,96 @@
 class EmailAddress
 {
 
-    /**
-     * The local part of the email address (before the '@' sign).
-     *
-     * @var string
-     */
-    protected $localPart;
+	/**
+	 * The local part of the email address (before the '@' sign).
+	 *
+	 * @var string
+	 */
+	protected $localPart;
 
-    /**
-     * The domain part of the email address (after the '@' sign).
-     *
-     * @var Domain
-     */
-    protected $domain;
+	/**
+	 * The domain part of the email address (after the '@' sign).
+	 *
+	 * @var Domain
+	 */
+	protected $domain;
 
-    /**
-     * Instantiate an EmailAddress object.
-     *
-     * @param EmailAddress|string $email The email to parse.
-     *
-     * @throws InvalidEmailAddress If the email is not valid.
-     */
-    public function __construct($email)
-    {
-        if ($email instanceof EmailAddress) {
-            $this->localPart = $email->getLocalPart();
-            $this->domain    = $email->getDomain();
-        } else {
-            if ( ! $this->isValid($email)) {
-                throw InvalidEmailAddress::from($email);
-            }
+	/**
+	 * Instantiate an EmailAddress object.
+	 *
+	 * @param EmailAddress|string $email The email to parse.
+	 *
+	 * @throws InvalidEmailAddress If the email is not valid.
+	 */
+	public function __construct($email)
+	{
+		if ($email instanceof EmailAddress) {
+			$this->localPart = $email->getLocalPart();
+			$this->domain    = $email->getDomain();
+		} else {
+			if ( ! $this->isValid($email)) {
+				throw InvalidEmailAddress::from($email);
+			}
 
-            try {
-                $parts           = explode('@', $email);
-                $this->localPart = trim($parts[0]);
-                $this->domain    = new Domain(trim($parts[1]));
-            } catch (Exception $exception) {
-                throw InvalidEmailAddress::from($email);
-            }
-        }
-    }
+			try {
+				$parts           = explode('@', $email);
+				$this->localPart = trim($parts[0]);
+				$this->domain    = new Domain(trim($parts[1]));
+			} catch (Exception $exception) {
+				throw InvalidEmailAddress::from($email);
+			}
+		}
+	}
 
-    /**
-     * Returns the local part of the email address.
-     *
-     * @return string
-     */
-    public function getLocalPart()
-    {
-        return $this->localPart;
-    }
+	/**
+	 * Returns the local part of the email address.
+	 *
+	 * @return string
+	 */
+	public function getLocalPart()
+	{
+		return $this->localPart;
+	}
 
-    /**
-     * Returns the domain part of the email address.
-     *
-     * @return Domain
-     */
-    public function getDomain()
-    {
-        return $this->domain;
-    }
+	/**
+	 * Returns the domain part of the email address.
+	 *
+	 * @return Domain
+	 */
+	public function getDomain()
+	{
+		return $this->domain;
+	}
 
-    /**
-     * Returns the entire email address.
-     *
-     * @return string
-     */
-    public function getAddress()
-    {
-        return $this->getLocalPart() . '@' . $this->getDomain();
-    }
+	/**
+	 * Returns the entire email address.
+	 *
+	 * @return string
+	 */
+	public function getAddress()
+	{
+		return $this->getLocalPart() . '@' . $this->getDomain();
+	}
 
-    /**
-     * Convert the EmailAddress object to a string.
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->getAddress();
-    }
+	/**
+	 * Convert the EmailAddress object to a string.
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->getAddress();
+	}
 
-    /**
-     * Check whether an email is valid.
-     *
-     * @param string $email Email to check.
-     *
-     * @return bool Whether the email is valid.
-     */
-    protected function isValid($email)
-    {
-        return (bool)filter_var($email, FILTER_VALIDATE_EMAIL);
-    }
+	/**
+	 * Check whether an email is valid.
+	 *
+	 * @param string $email Email to check.
+	 *
+	 * @return bool Whether the email is valid.
+	 */
+	protected function isValid($email)
+	{
+		return (bool)filter_var($email, FILTER_VALIDATE_EMAIL);
+	}
 }
\ No newline at end of file