OrderEmailNotifier::sendCancelNotification() - Code Metrics - Inspection of "FEAT: Add new VisibleToCustomer flag to OrderStatu..." - silvershop/silvershop-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#736)

by Matt

created 2020-02-04 13:12 UTC

OrderEmailNotifier::sendCancelNotification() A

↳ Parent: OrderEmailNotifier

Complexity

Conditions	2
Paths	2

Size

Total Lines	17
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	13
c	1
b	0
f	0
nc	2
nop	0
dl	0
loc	17
rs	9.8333

<?php

namespace SilverShop\Checkout;

use SilverShop\Extension\ShopConfigExtension;
use SilverShop\Model\Order;
use SilverShop\Model\OrderStatusLog;
use SilverShop\Page\CheckoutPage;
use SilverStripe\Control\Director;
use SilverStripe\Control\Email\Email;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Config\Configurable;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\Core\Injector\Injector;

/**
 * Handles email notifications to customers and / or admins.
 *
 * @package shop
 */
class OrderEmailNotifier
{
    use Injectable;
    use Configurable;

    /**
     * @var Order $order
     */
    protected $order;

    /**
     * @var bool
     */
    protected $debugMode = false;

    /**
     * Assign the order to a local variable
     *
     * @param Order $order
     */
    public function __construct(Order $order)
    {
        $this->order = $order;
    }

    /**
     * @param bool $bool
     * @return $this
     */
    public function setDebugMode($bool)
    {
        $this->debugMode = $bool;
        return $this;
    }

    /**
     * @param string $template
     * @param string $subject
     *
     * @return Email
     */
    protected function buildEmail($template, $subject)
    {
        $from = ShopConfigExtension::config()->email_from ? ShopConfigExtension::config()->email_from : Email::config()->admin_email;
        $to = $this->order->getLatestEmail();
        $checkoutpage = CheckoutPage::get()->first();
        $completemessage = $checkoutpage ? $checkoutpage->PurchaseComplete : '';

        /**
         * @var Email $email
         */
        $email = Email::create()
            ->setHTMLTemplate($template)
            ->setFrom($from)
            ->setTo($to)
            ->setSubject($subject);

        $email->setData(
            [
                'PurchaseCompleteMessage' => $completemessage,
                'Order' => $this->order,
                'BaseURL' => Director::absoluteBaseURL(),
            ]
        );

        return $email;
    }

    /**
     * Send a mail of the order to the client (and another to the admin).
     *
     * @param string $template    - the class name of the email you wish to send
     * @param string $subject     - subject of the email
     * @param bool   $copyToAdmin - true by default, whether it should send a copy to the admin
     *
     * @return bool|string
     */
    public function sendEmail($template, $subject, $copyToAdmin = true)
    {
        $email = $this->buildEmail($template, $subject);

        if ($copyToAdmin) {
            $email->setBcc(Email::config()->admin_email);
        }
        if ($this->debugMode) {
            return $this->debug($email);
        } else {
            return $email->send();
        }
    }

    /**
     * Send customer a confirmation that the order has been received
     *
     * @return bool
     */
    public function sendConfirmation()
    {
        $subject = _t(
            'SilverShop\ShopEmail.ConfirmationSubject',
            'Order #{OrderNo} confirmation',
            '',
            array('OrderNo' => $this->order->Reference)
        );
        return $this->sendEmail(

            'SilverShop/Model/Order_ConfirmationEmail',
            $subject,
            self::config()->bcc_confirmation_to_admin
        );
    }

    /**
     * Notify store owner about new order.
     *
     * @return bool|string
     */
    public function sendAdminNotification()
    {
        $subject = _t(
            'SilverShop\ShopEmail.AdminNotificationSubject',
            'Order #{OrderNo} notification',
            '',
            array('OrderNo' => $this->order->Reference)
        );

        $email = $this->buildEmail('SilverShop/Model/Order_AdminNotificationEmail', $subject)
            ->setTo(Email::config()->admin_email);

        if ($this->debugMode) {
            return $this->debug($email);
        } else {
            return $email->send();
        }
    }

    /**
     * Send customer an order receipt email.
     * Precondition: The order payment has been successful
     */
    public function sendReceipt()
    {
        $subject = _t(
            'SilverShop\ShopEmail.ReceiptSubject',
            'Order #{OrderNo} receipt',
            '',
            array('OrderNo' => $this->order->Reference)
        );

        return $this->sendEmail(
            'SilverShop/Model/Order_ReceiptEmail',
            $subject,
            self::config()->bcc_receipt_to_admin
        );
    }

    /**
     * Sends an email to the admin that an order has been cancelled
     */
    public function sendCancelNotification()
    {
        $email = Email::create()
            ->setSubject(_t(
                'SilverShop\ShopEmail.CancelSubject',
                'Order #{OrderNo} cancelled by member',
                '',
                ['OrderNo' => $this->order->Reference]
            ))
            ->setFrom(Email::config()->admin_email)
            ->setTo(Email::config()->admin_email)
            ->setBody($this->order->renderWith(Order::class));

        if ($this->debugMode) {
            return $this->debug($email);
        } else {
            return $email->send();
        }
    }

    /**
     * Send an email to the customer containing the latest note of {@link OrderStatusLog} and the current status.
     *
     * @param string $title Subject for email
     * @param string $note  Optional note-content (instead of using the OrderStatusLog)
     *
     * @return bool|string
     */
    public function sendStatusChange($title, $note = null)
    {
        $latestLog = null;

        if (!$note) {
            // Find the latest log message that hasn't been sent to the client yet, but can be (e.g. is visible)
            $latestLog = OrderStatusLog::get()
                ->filter("OrderID", $this->order->ID)
                ->filter("SentToCustomer", 0)
                ->filter("VisibleToCustomer", 1)
                ->first();

            if ($latestLog) {

                $note = $latestLog->Note;
                $title = $latestLog->Title;
            }
        }

        if (Config::inst()->get(OrderProcessor::class, 'receipt_email')) {
            $adminEmail = Config::inst()->get(OrderProcessor::class, 'receipt_email');
        } else {
            $adminEmail = Email::config()->admin_email;
        }

        /**
         * @var Email $e
         */
        $email = Email::create()
            ->setFrom($adminEmail)
            ->setSubject(_t('SilverShop\ShopEmail.StatusChangeSubject', 'SilverShop – {Title}', ['Title' => $title]))
            ->setTo($this->order->getLatestEmail())
            ->setHTMLTemplate('SilverShop/Model/Order_StatusEmail')
            ->setData(
                [
                    'Order' => $this->order,
                    'Note' => $note,
                    'FromEmail' => $adminEmail
                ]
            );

        if ($this->debugMode) {
            $result = $this->debug($email);
        } else {
            $result = $email->send();
        }

        if ($latestLog) {
            // If we got the note from an OrderStatusLog object, mark it as having been sent to the customer
            $latestLog->SentToCustomer = true;
            $latestLog->write();
        }

        return $result;
    }

    /**
     * The new Email::debug method in SilverStripe dumps the entire message with all message parts,
     * which makes it unusable to preview an Email.
     * This method simulates the old way of the message output and renders only the HTML body.
     *
     * @param Email $email
     * @return string
     */
    protected function debug(Email $email)
    {
        $email->render();
        $template = $email->getHTMLTemplate();
        $headers = $email->getSwiftMessage()->getHeaders()->toString();

        return "<h2>Email HTML template: $template</h2>\n" .
            "<pre>$headers</pre>" .
            $email->getBody();
    }
}


1			<?php
2
3			namespace SilverShop\Checkout;
4
5			use SilverShop\Extension\ShopConfigExtension;
6			use SilverShop\Model\Order;
7			use SilverShop\Model\OrderStatusLog;
8			use SilverShop\Page\CheckoutPage;
9			use SilverStripe\Control\Director;
10			use SilverStripe\Control\Email\Email;
11			use SilverStripe\Core\Config\Config;
12			use SilverStripe\Core\Config\Configurable;
13			use SilverStripe\Core\Injector\Injectable;
14			use SilverStripe\Core\Injector\Injector;
15
16			/**
17			* Handles email notifications to customers and / or admins.
18			*
19			* @package shop
20			*/
21			class OrderEmailNotifier
22			{
23			use Injectable;
24			use Configurable;
25
26			/**
27			* @var Order $order
28			*/
29			protected $order;
30
31			/**
32			* @var bool
33			*/
34			protected $debugMode = false;
35
36			/**
37			* Assign the order to a local variable
38			*
39			* @param Order $order
40			*/
41			public function __construct(Order $order)
42			{
43			$this->order = $order;
44			}
45
46			/**
47			* @param bool $bool
48			* @return $this
49			*/
50			public function setDebugMode($bool)
51			{
52			$this->debugMode = $bool;
53			return $this;
54			}
55
56			/**
57			* @param string $template
58			* @param string $subject
59			*
60			* @return Email
61			*/
62			protected function buildEmail($template, $subject)
63			{
64			$from = ShopConfigExtension::config()->email_from ? ShopConfigExtension::config()->email_from : Email::config()->admin_email;
65			$to = $this->order->getLatestEmail();
66			$checkoutpage = CheckoutPage::get()->first();
67			$completemessage = $checkoutpage ? $checkoutpage->PurchaseComplete : '';
68
69			/**
70			* @var Email $email
71			*/
72			$email = Email::create()
73			->setHTMLTemplate($template)
74			->setFrom($from)
75			->setTo($to)
76			->setSubject($subject);
77
78			$email->setData(
79			[
80			'PurchaseCompleteMessage' => $completemessage,
81			'Order' => $this->order,
82			'BaseURL' => Director::absoluteBaseURL(),
83			]
84			);
85
86			return $email;
87			}
88
89			/**
90			* Send a mail of the order to the client (and another to the admin).
91			*
92			* @param string $template - the class name of the email you wish to send
93			* @param string $subject - subject of the email
94			* @param bool $copyToAdmin - true by default, whether it should send a copy to the admin
95			*
96			* @return bool\|string
97			*/
98			public function sendEmail($template, $subject, $copyToAdmin = true)
99			{
100			$email = $this->buildEmail($template, $subject);
101
102			if ($copyToAdmin) {
103			$email->setBcc(Email::config()->admin_email);
104			}
105			if ($this->debugMode) {
106			return $this->debug($email);
107			} else {
108			return $email->send();
109			}
110			}
111
112			/**
113			* Send customer a confirmation that the order has been received
114			*
115			* @return bool
116			*/
117			public function sendConfirmation()
118			{
119			$subject = _t(
120			'SilverShop\ShopEmail.ConfirmationSubject',
121			'Order #{OrderNo} confirmation',
122			'',
123			array('OrderNo' => $this->order->Reference)
124			);
125			return $this->sendEmail(
			0 ignored issues – show Bug Best Practice introduced 2018-02-23 10:09 UTC by Report Bug Copy Issue Report The expression `return $this->sendEmail(..._confirmation_to_admin)` also could return the type `string` which is incompatible with the documented return type `boolean`. Loading history...
126			'SilverShop/Model/Order_ConfirmationEmail',
127			$subject,
128			self::config()->bcc_confirmation_to_admin
129			);
130			}
131
132			/**
133			* Notify store owner about new order.
134			*
135			* @return bool\|string
136			*/
137			public function sendAdminNotification()
138			{
139			$subject = _t(
140			'SilverShop\ShopEmail.AdminNotificationSubject',
141			'Order #{OrderNo} notification',
142			'',
143			array('OrderNo' => $this->order->Reference)
144			);
145
146			$email = $this->buildEmail('SilverShop/Model/Order_AdminNotificationEmail', $subject)
147			->setTo(Email::config()->admin_email);
148
149			if ($this->debugMode) {
150			return $this->debug($email);
151			} else {
152			return $email->send();
153			}
154			}
155
156			/**
157			* Send customer an order receipt email.
158			* Precondition: The order payment has been successful
159			*/
160			public function sendReceipt()
161			{
162			$subject = _t(
163			'SilverShop\ShopEmail.ReceiptSubject',
164			'Order #{OrderNo} receipt',
165			'',
166			array('OrderNo' => $this->order->Reference)
167			);
168
169			return $this->sendEmail(
170			'SilverShop/Model/Order_ReceiptEmail',
171			$subject,
172			self::config()->bcc_receipt_to_admin
173			);
174			}
175
176			/**
177			* Sends an email to the admin that an order has been cancelled
178			*/
179			public function sendCancelNotification()
180			{
181			$email = Email::create()
182			->setSubject(_t(
183			'SilverShop\ShopEmail.CancelSubject',
184			'Order #{OrderNo} cancelled by member',
185			'',
186			['OrderNo' => $this->order->Reference]
187			))
188			->setFrom(Email::config()->admin_email)
189			->setTo(Email::config()->admin_email)
190			->setBody($this->order->renderWith(Order::class));
191
192			if ($this->debugMode) {
193			return $this->debug($email);
194			} else {
195			return $email->send();
196			}
197			}
198
199			/**
200			* Send an email to the customer containing the latest note of {@link OrderStatusLog} and the current status.
201			*
202			* @param string $title Subject for email
203			* @param string $note Optional note-content (instead of using the OrderStatusLog)
204			*
205			* @return bool\|string
206			*/
207			public function sendStatusChange($title, $note = null)
208			{
209			$latestLog = null;
210
211			if (!$note) {
212			// Find the latest log message that hasn't been sent to the client yet, but can be (e.g. is visible)
213			$latestLog = OrderStatusLog::get()
214			->filter("OrderID", $this->order->ID)
215			->filter("SentToCustomer", 0)
216			->filter("VisibleToCustomer", 1)
217			->first();
218
219			if ($latestLog) {
			0 ignored issues – show introduced 2018-10-27 14:54 UTC by Report Bug Copy Issue Report `$latestLog` is of type `SilverStripe\ORM\DataObject`, thus it always evaluated to `true`. Loading history...
220			$note = $latestLog->Note;
221			$title = $latestLog->Title;
222			}
223			}
224
225			if (Config::inst()->get(OrderProcessor::class, 'receipt_email')) {
226			$adminEmail = Config::inst()->get(OrderProcessor::class, 'receipt_email');
227			} else {
228			$adminEmail = Email::config()->admin_email;
229			}
230
231			/**
232			* @var Email $e
233			*/
234			$email = Email::create()
235			->setFrom($adminEmail)
236			->setSubject(_t('SilverShop\ShopEmail.StatusChangeSubject', 'SilverShop – {Title}', ['Title' => $title]))
237			->setTo($this->order->getLatestEmail())
238			->setHTMLTemplate('SilverShop/Model/Order_StatusEmail')
239			->setData(
240			[
241			'Order' => $this->order,
242			'Note' => $note,
243			'FromEmail' => $adminEmail
244			]
245			);
246
247			if ($this->debugMode) {
248			$result = $this->debug($email);
249			} else {
250			$result = $email->send();
251			}
252
253			if ($latestLog) {
254			// If we got the note from an OrderStatusLog object, mark it as having been sent to the customer
255			$latestLog->SentToCustomer = true;
256			$latestLog->write();
257			}
258
259			return $result;
260			}
261
262			/**
263			* The new Email::debug method in SilverStripe dumps the entire message with all message parts,
264			* which makes it unusable to preview an Email.
265			* This method simulates the old way of the message output and renders only the HTML body.
266			*
267			* @param Email $email
268			* @return string
269			*/
270			protected function debug(Email $email)
271			{
272			$email->render();
273			$template = $email->getHTMLTemplate();
274			$headers = $email->getSwiftMessage()->getHeaders()->toString();
275
276			return "<h2>Email HTML template: $template</h2>\n" .
277			"<pre>$headers</pre>" .
278			$email->getBody();
279			}
280			}
281

silvershop / silvershop-core

Pull Request — master (#736)

OrderEmailNotifier::sendCancelNotification() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like