ublaboo / mailing

src/Mail.php

<?php

/**
 * @copyright   Copyright (c) 2015 ublaboo <ublaboo@paveljanda.com>
 * @author      Pavel Janda <me@paveljanda.com>
 * @package     Ublaboo
 */

namespace Ublaboo\Mailing;

use Nette;
use Ublaboo;
use Ublaboo\Mailing\Exception\MailingException;
use Latte;

abstract class Mail extends Nette\Object
{

	const CONFIG_LOG  = 'log';
	const CONFIG_SEND = 'send';
	const CONFIG_BOTH = 'both';


	/**
	 * @var string
	 */
	private $config;

	/**
	 * @var array
	 */
	protected $mails;

	/**
	 * @var Nette\Mail\IMailer
	 */
	protected $mailer;

	/**
	 * @var Nette\Mail\Message
	 */
	protected $message;

	/**
	 * @var array
	 */
	protected $args;

	/**
	 * @var Nette\Application\LinkGenerator
	 */
	protected $linkGenerator;

	/**
	 * @var ILogger
	 */
	protected $logger;

	/**
	 * @var Nette\Application\UI\ITemplate
	 */
	protected $template;

	/**
	 * @var string
	 */
	protected $underscore_name;

	/**
	 * @var string
	 */
	protected $log_type;

	/**
	 * @var string
	 */
	protected $mail_images_base_path;

	/**
	 * @var string
	 */
	protected $template_file;


	public function __construct(
		$config,
		$mails,
		Nette\Mail\IMailer $mailer,
		Nette\Mail\Message $message,
		Nette\Application\LinkGenerator $linkGenerator,
		Nette\Application\UI\ITemplateFactory $templateFactory,
		ILogger $logger,
		$args
	) {
		$this->config = $config;
		$this->mails = $mails;
		$this->mailer = $mailer;
		$this->message = $message;
		$this->linkGenerator = $linkGenerator;
		$this->logger = $logger;
		$this->args = $args;

		$this->template = $templateFactory->createTemplate();

		/**
		 * Initiate mail composing
		 */
		if ($this instanceof IComposableMail) {
			$this->compose($this->message, $this->args);

The method compose does not exist on object<Ublaboo\Mailing\Mail>? Since you implemented __call, maybe consider adding a @method annotation.

		}
	}


	/**
	 * Set template file
	 * @return void
	 */
	public function setTemplateFile($template_file)
	{
		$this->template_file = (string) $template_file;
	}


	/**
	 * Set template variables
	 * @return void
	 */
	protected function setTemplateVariables()
	{
		foreach ($this->args as $key => $value) {
			$this->template->$key = $value;
		}
	}


	/**
	 * Set absolute base path for images
	 * @param string $mail_images_base_path
	 * @return self
	 */
	public function setBasePath($mail_images_base_path)
	{
		$this->mail_images_base_path = (string) $mail_images_base_path;

		return $this;
	}


	/**
	 * Stick to convention that Email:
	 * 		?/mailing/Mails/FooMail.php	
	 * 
	 * will have template with path of:
	 * 		?/mailing/Mails/templates/foo_mail.latte
	 * 
	 * @return string
	 */
	public function getTemplateFile()
	{
		/**
		 * Get child class file path
		 * @var \ReflectionClass
		 */
		$reflection = new \ReflectionClass(get_class($this));
		
		/**
		 * Split path to directory and file
		 */
		$class_path = $reflection->getFileName();
		$class_dir = dirname($class_path);
		$class_name = pathinfo($class_path, PATHINFO_FILENAME);

		/**
		 * Convert class name to underscore and set latte file extension
		 */
		$this->underscore_name = lcfirst(preg_replace_callback('/(?<=.)([A-Z])/', function ($m) {
			return '_' . strtolower($m[1]);
		}, $class_name));

		$template_name = $this->underscore_name . '.latte';
		$this->log_type = $this->underscore_name;

		if ($this->template_file) {
			return $this->template_file;
		}

		$template_file = "$class_dir/templates/$template_name";

		if (!file_exists($template_file)) {
			throw new MailingException("Error creating template from file [$template_file]", 1);
		}

		return $template_file;
	}


	/**
	 * Render latte template to string and send (and/or log) mail
	 * @return void
	 */
	public function send()
	{
		/**
		 * Set template variables
		 */
		$this->setTemplateVariables();

		/**
		 * Set body/html body
		 */
		try {
			$this->template->setFile($this->getTemplateFile());

			if (version_compare(Latte\Engine::VERSION, '2.4.0', '>=')) {
				$this->template->getLatte()->addProvider('uiControl', $this->linkGenerator);
			} else {
				$this->template->_control = $this->linkGenerator;

Accessing _control on the interface Nette\Application\UI\ITemplate suggest that you code against a concrete implementation. How about adding an instanceof check?

			}

			$this->message->setHtmlBody((string) $this->template, $this->mail_images_base_path);
		} catch (MailingException $e) {
			/**
			 * If mail template was set and not found, bubble exception up
			 */
			if ($this->template_file) {
				throw $e;
			}
			/**
			 * Otherwise just suppose that user has set message body via ::setBody
			 */
		}

		/**
		 * In case mail sending in on, send message
		 */
		if ($this->config === self::CONFIG_BOTH || $this->config === self::CONFIG_SEND) {
			$this->mailer->send($this->message);
		}

		/**
		 * In case mail logging is turned on, log message
		 */
		if ($this->config === self::CONFIG_LOG || $this->config === self::CONFIG_BOTH) {
			$this->logger->log($this->log_type, $this->message);
		}
	}

}