OrderCommentSender Class Reference

Inheritance diagram for OrderCommentSender:

Public Member Functions
	__construct (Template $templateContainer, OrderCommentIdentity $identityContainer, \Magento\Sales\Model\Order\Email\SenderBuilderFactory $senderBuilderFactory, \Psr\Log\LoggerInterface $logger, Renderer $addressRenderer, ManagerInterface $eventManager)
	send (Order $order, $notify=true, $comment='')
Public Member Functions inherited from Sender
	__construct (Template $templateContainer, IdentityInterface $identityContainer, \Magento\Sales\Model\Order\Email\SenderBuilderFactory $senderBuilderFactory, \Psr\Log\LoggerInterface $logger, Renderer $addressRenderer)

Protected Attributes
	$addressRenderer
	$eventManager
Protected Attributes inherited from Sender
	$senderBuilderFactory
	$templateContainer
	$identityContainer
	$logger
	$addressRenderer

Additional Inherited Members
Protected Member Functions inherited from Sender
	prepareTemplate (Order $order)
	getSender ()
	getTemplateOptions ()
	getFormattedShippingAddress ($order)
	getFormattedBillingAddress ($order)

Detailed Description

Class OrderCommentSender

Definition at line 19 of file OrderCommentSender.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Template	$templateContainer,
		OrderCommentIdentity	$identityContainer,
		\Magento\Sales\Model\Order\Email\SenderBuilderFactory	$senderBuilderFactory,
		\Psr\Log\LoggerInterface	$logger,
		Renderer	$addressRenderer,
		ManagerInterface	$eventManager
	)

Parameters

Template	$templateContainer
OrderCommentIdentity	$identityContainer
Order\Email\SenderBuilderFactory	$senderBuilderFactory
\Psr\Log\LoggerInterface	$logger
Renderer	$addressRenderer
ManagerInterface	$eventManager

Definition at line 41 of file OrderCommentSender.php.

      {
        parent::__construct($templateContainer, $identityContainer, $senderBuilderFactory, $logger, $addressRenderer);
        $this->addressRenderer = $addressRenderer;
        $this->eventManager = $eventManager;
    }

Member Function Documentation

send()

send	(	Order	$order,
			$notify = true,
			$comment = ''
	)

Send email to customer

Parameters

Order	$order
bool	$notify
string	$comment

Returns

bool

Event argument transport is

Deprecated:

. Use transportObject instead.

Definition at line 62 of file OrderCommentSender.php.

    {
        $transport = [
            'order' => $order,
            'comment' => $comment,
            'billing' => $order->getBillingAddress(),
            'store' => $order->getStore(),
            'formattedShippingAddress' => $this->getFormattedShippingAddress($order),
            'formattedBillingAddress' => $this->getFormattedBillingAddress($order),
        ];
        $transportObject = new DataObject($transport);

        $this->eventManager->dispatch(
            'email_order_comment_set_template_vars_before',
            ['sender' => $this, 'transport' => $transportObject->getData(), 'transportObject' => $transportObject]
        );

        $this->templateContainer->setTemplateVars($transportObject->getData());

        return $this->checkAndSend($order, $notify);
    }

Field Documentation

$addressRenderer

$addressRenderer

protected

Definition at line 24 of file OrderCommentSender.php.

$eventManager

$eventManager

protected

Definition at line 31 of file OrderCommentSender.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-sales/Model/Order/Email/Sender/OrderCommentSender.php