Skip to content

Email sending events #1202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Apr 30, 2015
Merged

Email sending events #1202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6ff9807
add event to adjust template vars for creditmemo comment email
fooman Apr 19, 2015
01ded50
add event to adjust template vars for creditmemo email
fooman Apr 19, 2015
863137e
add event to adjust template vars for invoice comment email
fooman Apr 19, 2015
ad989c5
add event to adjust template vars for invoice email
fooman Apr 19, 2015
13d7f39
add event to adjust template vars for order comment email
fooman Apr 19, 2015
7db7444
add event to adjust template vars for order email
fooman Apr 19, 2015
811e035
add event to adjust template vars for shipment comment email
fooman Apr 19, 2015
d434ebc
add event to adjust template vars for shipment email
fooman Apr 19, 2015
e76f322
fix unit tests and array set up
fooman Apr 19, 2015
c93b2ed
Merge remote-tracking branch 'origin/master' into email-sending-events
fooman Apr 28, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 30 additions & 10 deletions app/code/Magento/Sales/Model/Order/Email/Sender/CreditmemoCommentSender.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use Magento\Sales\Model\Order\Email\Container\Template;
use Magento\Sales\Model\Order\Email\NotifySender;
use Magento\Sales\Model\Order\Address\Renderer;
use Magento\Framework\Event\ManagerInterface;

/**
* Class CreditmemoCommentSender
Expand All @@ -22,22 +23,32 @@ class CreditmemoCommentSender extends NotifySender
*/
protected $addressRenderer;

/**
* Application Event Dispatcher
*
* @var ManagerInterface
*/
protected $eventManager;

/**
* @param Template $templateContainer
* @param CreditmemoCommentIdentity $identityContainer
* @param Order\Email\SenderBuilderFactory $senderBuilderFactory
* @param \Psr\Log\LoggerInterface $logger
* @param Renderer $addressRenderer
* @param ManagerInterface $eventManager
*/
public function __construct(
Template $templateContainer,
CreditmemoCommentIdentity $identityContainer,
\Magento\Sales\Model\Order\Email\SenderBuilderFactory $senderBuilderFactory,
\Psr\Log\LoggerInterface $logger,
Renderer $addressRenderer
Renderer $addressRenderer,
ManagerInterface $eventManager
) {
parent::__construct($templateContainer, $identityContainer, $senderBuilderFactory, $logger);
$this->addressRenderer = $addressRenderer;
$this->eventManager = $eventManager;
}

/**
Expand All @@ -57,18 +68,27 @@ public function send(Creditmemo $creditmemo, $notify = true, $comment = '')
$formattedShippingAddress = '';
}
$formattedBillingAddress = $this->addressRenderer->format($order->getBillingAddress(), 'html');
$this->templateContainer->setTemplateVars(
[
'order' => $order,
'creditmemo' => $creditmemo,
'comment' => $comment,
'billing' => $order->getBillingAddress(),
'store' => $order->getStore(),
'formattedShippingAddress' => $formattedShippingAddress,
'formattedBillingAddress' => $formattedBillingAddress,

$transport = new \Magento\Framework\Object(
['template_vars' =>
[
'order' => $order,
'creditmemo' => $creditmemo,
'comment' => $comment,
'billing' => $order->getBillingAddress(),
'store' => $order->getStore(),
'formattedShippingAddress' => $formattedShippingAddress,
'formattedBillingAddress' => $formattedBillingAddress,
]
]
);

$this->eventManager->dispatch(
'email_creditmemo_comment_set_template_vars_before', array('sender' => $this, 'transport' => $transport)
);

$this->templateContainer->setTemplateVars($transport->getTemplateVars());

return $this->checkAndSend($order, $notify);
}
}
42 changes: 31 additions & 11 deletions app/code/Magento/Sales/Model/Order/Email/Sender/CreditmemoSender.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use Magento\Sales\Model\Order\Email\Sender;
use Magento\Sales\Model\Resource\Order\Creditmemo as CreditmemoResource;
use Magento\Sales\Model\Order\Address\Renderer;
use Magento\Framework\Event\ManagerInterface;

/**
* Class CreditmemoSender
Expand Down Expand Up @@ -43,6 +44,13 @@ class CreditmemoSender extends Sender
*/
protected $addressRenderer;

/**
* Application Event Dispatcher
*
* @var ManagerInterface
*/
protected $eventManager;

/**
* @param Template $templateContainer
* @param CreditmemoIdentity $identityContainer
Expand All @@ -52,6 +60,7 @@ class CreditmemoSender extends Sender
* @param CreditmemoResource $creditmemoResource
* @param \Magento\Framework\App\Config\ScopeConfigInterface $globalConfig
* @param Renderer $addressRenderer
* @param ManagerInterface $eventManager
*/
public function __construct(
Template $templateContainer,
Expand All @@ -61,13 +70,15 @@ public function __construct(
PaymentHelper $paymentHelper,
CreditmemoResource $creditmemoResource,
\Magento\Framework\App\Config\ScopeConfigInterface $globalConfig,
Renderer $addressRenderer
Renderer $addressRenderer,
ManagerInterface $eventManager
) {
parent::__construct($templateContainer, $identityContainer, $senderBuilderFactory, $logger);
$this->paymentHelper = $paymentHelper;
$this->creditmemoResource = $creditmemoResource;
$this->globalConfig = $globalConfig;
$this->addressRenderer = $addressRenderer;
$this->eventManager = $eventManager;
}

/**
Expand Down Expand Up @@ -100,19 +111,28 @@ public function send(Creditmemo $creditmemo, $forceSyncMode = false)

$formattedBillingAddress = $this->addressRenderer->format($order->getBillingAddress(), 'html');

$this->templateContainer->setTemplateVars(
[
'order' => $order,
'creditmemo' => $creditmemo,
'comment' => $creditmemo->getCustomerNoteNotify() ? $creditmemo->getCustomerNote() : '',
'billing' => $order->getBillingAddress(),
'payment_html' => $this->getPaymentHtml($order),
'store' => $order->getStore(),
'formattedShippingAddress' => $formattedShippingAddress,
'formattedBillingAddress' => $formattedBillingAddress,
$transport = new \Magento\Framework\Object(
['template_vars' =>
[
'order' => $order,
'creditmemo' => $creditmemo,
'comment' => $creditmemo->getCustomerNoteNotify()
? $creditmemo->getCustomerNote() : '',
'billing' => $order->getBillingAddress(),
'payment_html' => $this->getPaymentHtml($order),
'store' => $order->getStore(),
'formattedShippingAddress' => $formattedShippingAddress,
'formattedBillingAddress' => $formattedBillingAddress
]
]
);

$this->eventManager->dispatch(
'email_creditmemo_set_template_vars_before', array('sender' => $this, 'transport' => $transport)
);

$this->templateContainer->setTemplateVars($transport->getTemplateVars());

if ($this->checkAndSend($order)) {
$creditmemo->setEmailSent(true);

Expand Down
41 changes: 31 additions & 10 deletions app/code/Magento/Sales/Model/Order/Email/Sender/InvoiceCommentSender.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use Magento\Sales\Model\Order\Email\NotifySender;
use Magento\Sales\Model\Order\Invoice;
use Magento\Sales\Model\Order\Address\Renderer;
use Magento\Framework\Event\ManagerInterface;

/**
* Class InvoiceCommentSender
Expand All @@ -22,22 +23,32 @@ class InvoiceCommentSender extends NotifySender
*/
protected $addressRenderer;

/**
* Application Event Dispatcher
*
* @var ManagerInterface
*/
protected $eventManager;

/**
* @param Template $templateContainer
* @param InvoiceCommentIdentity $identityContainer
* @param Order\Email\SenderBuilderFactory $senderBuilderFactory
* @param \Psr\Log\LoggerInterface $logger
* @param Renderer $addressRenderer
* @param ManagerInterface $eventManager
*/
public function __construct(
Template $templateContainer,
InvoiceCommentIdentity $identityContainer,
\Magento\Sales\Model\Order\Email\SenderBuilderFactory $senderBuilderFactory,
\Psr\Log\LoggerInterface $logger,
Renderer $addressRenderer
Renderer $addressRenderer,
ManagerInterface $eventManager
) {
parent::__construct($templateContainer, $identityContainer, $senderBuilderFactory, $logger);
$this->addressRenderer = $addressRenderer;
$this->eventManager = $eventManager;
}

/**
Expand All @@ -57,17 +68,27 @@ public function send(Invoice $invoice, $notify = true, $comment = '')
$formattedShippingAddress = '';
}
$formattedBillingAddress = $this->addressRenderer->format($order->getBillingAddress(), 'html');
$this->templateContainer->setTemplateVars(
[
'order' => $order,
'invoice' => $invoice,
'comment' => $comment,
'billing' => $order->getBillingAddress(),
'store' => $order->getStore(),
'formattedShippingAddress' => $formattedShippingAddress,
'formattedBillingAddress' => $formattedBillingAddress,

$transport = new \Magento\Framework\Object(
['template_vars' =>
[
'order' => $order,
'invoice' => $invoice,
'comment' => $comment,
'billing' => $order->getBillingAddress(),
'store' => $order->getStore(),
'formattedShippingAddress' => $formattedShippingAddress,
'formattedBillingAddress' => $formattedBillingAddress,
]
]
);

$this->eventManager->dispatch(
'email_invoice_comment_set_template_vars_before', array('sender' => $this, 'transport' => $transport)
);

$this->templateContainer->setTemplateVars($transport->getTemplateVars());

return $this->checkAndSend($order, $notify);
}
}
44 changes: 32 additions & 12 deletions app/code/Magento/Sales/Model/Order/Email/Sender/InvoiceSender.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use Magento\Sales\Model\Order\Invoice;
use Magento\Sales\Model\Resource\Order\Invoice as InvoiceResource;
use Magento\Sales\Model\Order\Address\Renderer;
use Magento\Framework\Event\ManagerInterface;

/**
* Class InvoiceSender
Expand Down Expand Up @@ -43,6 +44,13 @@ class InvoiceSender extends Sender
*/
protected $addressRenderer;

/**
* Application Event Dispatcher
*
* @var ManagerInterface
*/
protected $eventManager;

/**
* @param Template $templateContainer
* @param InvoiceIdentity $identityContainer
Expand All @@ -52,6 +60,7 @@ class InvoiceSender extends Sender
* @param InvoiceResource $invoiceResource
* @param \Magento\Framework\App\Config\ScopeConfigInterface $globalConfig
* @param Renderer $addressRenderer
* @param ManagerInterface $eventManager
*/
public function __construct(
Template $templateContainer,
Expand All @@ -61,13 +70,15 @@ public function __construct(
PaymentHelper $paymentHelper,
InvoiceResource $invoiceResource,
\Magento\Framework\App\Config\ScopeConfigInterface $globalConfig,
Renderer $addressRenderer
Renderer $addressRenderer,
ManagerInterface $eventManager
) {
parent::__construct($templateContainer, $identityContainer, $senderBuilderFactory, $logger);
$this->paymentHelper = $paymentHelper;
$this->invoiceResource = $invoiceResource;
$this->globalConfig = $globalConfig;
$this->addressRenderer = $addressRenderer;
$this->eventManager = $eventManager;
}

/**
Expand Down Expand Up @@ -98,20 +109,29 @@ public function send(Invoice $invoice, $forceSyncMode = false)
$formattedShippingAddress = '';
}
$formattedBillingAddress = $this->addressRenderer->format($order->getBillingAddress(), 'html');

$this->templateContainer->setTemplateVars(
[
'order' => $order,
'invoice' => $invoice,
'comment' => $invoice->getCustomerNoteNotify() ? $invoice->getCustomerNote() : '',
'billing' => $order->getBillingAddress(),
'payment_html' => $this->getPaymentHtml($order),
'store' => $order->getStore(),
'formattedShippingAddress' => $formattedShippingAddress,
'formattedBillingAddress' => $formattedBillingAddress

$transport = new \Magento\Framework\Object(
['template_vars' =>
[
'order' => $order,
'invoice' => $invoice,
'comment' => $invoice->getCustomerNoteNotify() ? $invoice->getCustomerNote()
: '',
'billing' => $order->getBillingAddress(),
'payment_html' => $this->getPaymentHtml($order),
'store' => $order->getStore(),
'formattedShippingAddress' => $formattedShippingAddress,
'formattedBillingAddress' => $formattedBillingAddress
]
]
);

$this->eventManager->dispatch(
'email_invoice_set_template_vars_before', array('sender' => $this, 'transport' => $transport)
);

$this->templateContainer->setTemplateVars($transport->getTemplateVars());

if ($this->checkAndSend($order)) {
$invoice->setEmailSent(true);

Expand Down
Loading