accounts/common/emails/TemplateWithRenderer.php

79 lines
1.9 KiB
PHP
Raw Normal View History

<?php
declare(strict_types=1);
namespace common\emails;
use Exception;
use yii\mail\MailerInterface;
use yii\mail\MessageInterface;
abstract class TemplateWithRenderer extends Template {
/**
* @var RendererInterface
*/
private $renderer;
/**
* @var string
*/
private $locale = 'en';
public function __construct(MailerInterface $mailer, RendererInterface $renderer) {
parent::__construct($mailer);
$this->renderer = $renderer;
}
public function setLocale(string $locale): void {
$this->locale = $locale;
}
public function getLocale(): string {
return $this->locale;
}
/**
* This method should return the template's name, which will be rendered.
* List of available templates names can be found at https://github.com/elyby/emails-renderer
*
* @return string
*/
abstract public function getTemplateName(): string;
final protected function getRenderer(): RendererInterface {
return $this->renderer;
}
2018-04-18 02:17:25 +05:30
final protected function getView() {
return $this->getTemplateName();
}
/**
* @param string|array $for
*
* @return MessageInterface
* @throws \common\emails\exceptions\CannotRenderEmailException
*/
protected function createMessage($for): MessageInterface {
return $this->getMailer()
->compose()
->setHtmlBody($this->render())
->setTo($for)
->setFrom($this->getFrom())
->setSubject($this->getSubject());
}
/**
* @return string
* @throws \common\emails\exceptions\CannotRenderEmailException
*/
private function render(): string {
try {
return $this->getRenderer()->render($this->getTemplateName(), $this->getLocale(), $this->getParams());
} catch (Exception $e) {
throw new exceptions\CannotRenderEmailException($e);
}
}
}