Standard::type() - Code Metrics - Inspection of "Improved order e-mail voucher implementation" - aimeos/ai-controller-jobs - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 863c7f...5d3493 )

by Aimeos

created 2024-04-23 11:51 UTC

Standard::type() A

↳ Parent: Standard

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2015-2024
 * @package Controller
 * @subpackage Order
 */


namespace Aimeos\Controller\Jobs\Order\Email\Delivery;


/**
 * Order delivery e-mail job controller.
 *
 * @package Controller
 * @subpackage Order
 */
class Standard
	extends \Aimeos\Controller\Jobs\Base
	implements \Aimeos\Controller\Jobs\Iface
{
	/** controller/jobs/order/email/delivery/name
	 * Class name of the used order email delivery scheduler controller implementation
	 *
	 * Each default job controller can be replace by an alternative imlementation.
	 * To use this implementation, you have to set the last part of the class
	 * name as configuration value so the controller factory knows which class it
	 * has to instantiate.
	 *
	 * For example, if the name of the default class is
	 *
	 *  \Aimeos\Controller\Jobs\Order\Email\Delivery\Standard
	 *
	 * and you want to replace it with your own version named
	 *
	 *  \Aimeos\Controller\Jobs\Order\Email\Delivery\Mydelivery
	 *
	 * then you have to set the this configuration option:
	 *
	 *  controller/jobs/order/email/delivery/name = Mydelivery
	 *
	 * The value is the last part of your own class name and it's case sensitive,
	 * so take care that the configuration value is exactly named like the last
	 * part of the class name.
	 *
	 * The allowed characters of the class name are A-Z, a-z and 0-9. No other
	 * characters are possible! You should always start the last part of the class
	 * name with an upper case character and continue only with lower case characters
	 * or numbers. Avoid chamel case names like "MyDelivery"!
	 *
	 * @param string Last part of the class name
	 * @since 2014.03
	 */

	/** controller/jobs/order/email/delivery/decorators/excludes
	 * Excludes decorators added by the "common" option from the order email delivery controllers
	 *
	 * Decorators extend the functionality of a class by adding new aspects
	 * (e.g. log what is currently done), executing the methods of the underlying
	 * class only in certain conditions (e.g. only for logged in users) or
	 * modify what is returned to the caller.
	 *
	 * This option allows you to remove a decorator added via
	 * "controller/jobs/common/decorators/default" before they are wrapped
	 * around the job controller.
	 *
	 *  controller/jobs/order/email/delivery/decorators/excludes = array( 'decorator1' )
	 *
	 * This would remove the decorator named "decorator1" from the list of
	 * common decorators ("\Aimeos\Controller\Jobs\Common\Decorator\*") added via
	 * "controller/jobs/common/decorators/default" to this job controller.
	 *
	 * @param array List of decorator names
	 * @since 2015.09
	 * @see controller/jobs/common/decorators/default
	 * @see controller/jobs/order/email/delivery/decorators/global
	 * @see controller/jobs/order/email/delivery/decorators/local
	 */

	/** controller/jobs/order/email/delivery/decorators/global
	 * Adds a list of globally available decorators only to the order email delivery controllers
	 *
	 * Decorators extend the functionality of a class by adding new aspects
	 * (e.g. log what is currently done), executing the methods of the underlying
	 * class only in certain conditions (e.g. only for logged in users) or
	 * modify what is returned to the caller.
	 *
	 * This option allows you to wrap global decorators
	 * ("\Aimeos\Controller\Jobs\Common\Decorator\*") around the job controller.
	 *
	 *  controller/jobs/order/email/delivery/decorators/global = array( 'decorator1' )
	 *
	 * This would add the decorator named "decorator1" defined by
	 * "\Aimeos\Controller\Jobs\Common\Decorator\Decorator1" only to this job controller.
	 *
	 * @param array List of decorator names
	 * @since 2015.09
	 * @see controller/jobs/common/decorators/default
	 * @see controller/jobs/order/email/delivery/decorators/excludes
	 * @see controller/jobs/order/email/delivery/decorators/local
	 */

	/** controller/jobs/order/email/delivery/decorators/local
	 * Adds a list of local decorators only to the order email delivery controllers
	 *
	 * Decorators extend the functionality of a class by adding new aspects
	 * (e.g. log what is currently done), executing the methods of the underlying
	 * class only in certain conditions (e.g. only for logged in users) or
	 * modify what is returned to the caller.
	 *
	 * This option allows you to wrap local decorators
	 * ("\Aimeos\Controller\Jobs\Order\Email\Delivery\Decorator\*") around this job controller.
	 *
	 *  controller/jobs/order/email/delivery/decorators/local = array( 'decorator2' )
	 *
	 * This would add the decorator named "decorator2" defined by
	 * "\Aimeos\Controller\Jobs\Order\Email\Delivery\Decorator\Decorator2" only to this job
	 * controller.
	 *
	 * @param array List of decorator names
	 * @since 2015.09
	 * @see controller/jobs/common/decorators/default
	 * @see controller/jobs/order/email/delivery/decorators/excludes
	 * @see controller/jobs/order/email/delivery/decorators/global
	 */


	use \Aimeos\Controller\Jobs\Mail;


	/**
	 * Returns the localized name of the job.
	 *
	 * @return string Name of the job
	 */
	public function getName() : string
	{
		return $this->context()->translate( 'controller/jobs', 'Order delivery related e-mails' );
	}


	/**
	 * Returns the localized description of the job.
	 *
	 * @return string Description of the job
	 */
	public function getDescription() : string
	{
		return $this->context()->translate( 'controller/jobs', 'Sends order delivery status update e-mails' );
	}


	/**
	 * Executes the job.
	 *
	 * @throws \Aimeos\Controller\Jobs\Exception If an error occurs
	 */
	public function run()
	{
		$context = $this->context();
		$manager = \Aimeos\MShop::create( $context, 'order' );

		foreach( $this->status() as $status )
		{
			$ref = ['order'] + $context->config()->get( 'mshop/order/manager/subdomains', [] );
			$filter = $this->filter( $manager->filter(), $status );
			$cursor = $manager->cursor( $filter );

			while( $items = $manager->iterate( $cursor, $ref ) ) {
				$this->notify( $items, $status );
			}
		}
	}


	/**
	 * Returns the address item from the order
	 *
	 * @param \Aimeos\MShop\Order\Item\Iface $basket Order including address items
	 * @return \Aimeos\MShop\Common\Item\Address\Iface Address item
	 * @throws \Aimeos\Controller\Jobs\Exception If no suitable address item is available
	 */
	protected function address( \Aimeos\MShop\Order\Item\Iface $basket ) : \Aimeos\MShop\Common\Item\Address\Iface
	{
		if( ( $addr = current( $basket->getAddress( 'delivery' ) ) ) !== false && $addr->getEmail() ) {
			return $addr;
		};

		if( ( $addr = current( $basket->getAddress( 'payment' ) ) ) !== false && $addr->getEmail() ) {
			return $addr;
		};

		$msg = sprintf( 'No address with e-mail found in order base with ID "%1$s"', $basket->getId() );
		throw new \Aimeos\Controller\Jobs\Exception( $msg );
	}


	/**
	 * Adds the given list of files as attachments to the mail message object
	 *
	 * @param \Aimeos\Base\Mail\Message\Iface $msg Mail message
	 * @param array $files List of absolute file paths
	 */
	protected function attachments( \Aimeos\Base\Mail\Message\Iface $msg ) : \Aimeos\Base\Mail\Message\Iface
	{
		$context = $this->context();
		$fs = $context->fs();

		/** controller/jobs/order/email/delivery/attachments
		 * List of file paths whose content should be attached to all delivery e-mails
		 *
		 * This configuration option allows you to add files to the e-mails that are
		 * sent to the customer when the delivery status changes, e.g. for the order
		 * confirmation e-mail. These files can't be customer specific.
		 *
		 * @param array List of absolute file paths
		 * @since 2016.10
		 * @see controller/jobs/order/email/payment/attachments
		 */
		$files = $context->config()->get( 'controller/jobs/order/email/delivery/attachments', [] );

		foreach( $files as $filepath )
		{
			if( $fs->has( $filepath ) ) {
				$msg->attach( $fs->read( $filepath ), basename( $filepath ) );
			}
		}

		return $msg;
	}


	/**
	 * Returns the filter for searching the appropriate orders
	 *
	 * @param \Aimeos\Base\Criteria\Iface $filter Order filter object
	 * @param int $status Delivery status value	to search for
	 * @return \Aimeos\Base\Criteria\Iface Filter object with conditions set
	 */
	protected function filter( \Aimeos\Base\Criteria\Iface $filter, int $status ) : \Aimeos\Base\Criteria\Iface
	{
		$limitDate = date( 'Y-m-d H:i:s', time() - $this->limit() * 86400 );
		$param = [$this->type(), (string) $status];

		$filter->add( $filter->and( [
			$filter->compare( '>=', 'order.mtime', $limitDate ),
			$filter->compare( '==', 'order.statusdelivery', $status ),
			$filter->compare( '==', $filter->make( 'order:status', $param ), 0 ),
		] ) );

		return $filter;
	}


	/**
	 * Returns the number of days after no e-mail will be sent anymore
	 *
	 * @return int Number of days
	 */
	protected function limit() : int
	{
		/** controller/jobs/order/email/delivery/limit-days
		 * Only send delivery e-mails of orders that were created in the past within the configured number of days
		 *
		 * The delivery e-mails are normally send immediately after the delivery
		 * status has changed. This option prevents e-mails for old order from
		 * being send in case anything went wrong or an update failed to avoid
		 * confusion of customers.
		 *
		 * @param integer Number of days
		 * @since 2014.03
		 * @see controller/jobs/order/email/delivery/limit-days
		 * @see controller/jobs/service/delivery/process/limit-days
		 */
		return (int) $this->context()->config()->get( 'controller/jobs/order/email/delivery/limit-days', 90 );
	}


	/**
	 * Sends the delivery e-mail for the given orders
	 *
	 * @param \Aimeos\Map $items List of order items implementing \Aimeos\MShop\Order\Item\Iface with their IDs as keys
	 * @param int $status Delivery status value
	 */
	protected function notify( \Aimeos\Map $items, int $status )
	{
		$context = $this->context();
		$sites = $this->sites( $items->getSiteId()->unique() );

		foreach( $items as $id => $item )
		{
			try
			{
				$list = $sites->get( $item->getSiteId(), map() );

				$this->send( $item, $list->getTheme()->filter()->last(), $list->getLogo()->filter()->last() );
				$this->update( $id, $status );

				$str = sprintf( 'Sent order delivery e-mail for order "%1$s" and status "%2$s"', $item->getId(), $status );
				$context->logger()->info( $str, 'email/order/delivery' );
			}
			catch( \Exception $e )
			{
				$str = 'Error while trying to send delivery e-mail for order ID "%1$s" and status "%2$s": %3$s';
				$msg = sprintf( $str, $item->getId(), $item->getStatusPayment(), $e->getMessage() );
				$context->logger()->error( $msg . PHP_EOL . $e->getTraceAsString(), 'email/order/delivery' );
			}
		}
	}


	/**
	 * Sends the delivery related e-mail for a single order
	 *
	 * @param \Aimeos\MShop\Order\Item\Iface $order Order item
	 * @param string|null $theme Theme name or NULL for default theme
	 * @param string|null $logoPath Relative path to the logo in the fs-media file system
	 */
	protected function send( \Aimeos\MShop\Order\Item\Iface $order, string $theme = null, string $logoPath = null )
	{
		/** controller/jobs/order/email/delivery/template-html
		 * Relative path to the template for the HTML part of the delivery emails.
		 *
		 * The template file contains the HTML code and processing instructions
		 * to generate the result shown in the body of the frontend. The
		 * configuration string is the path to the template file relative
		 * to the templates directory (usually in templates/controller/jobs).
		 * You can overwrite the template file configuration in extensions and
		 * provide alternative templates.
		 *
		 * @param string Relative path to the template
		 * @since 2022.04
		 * @see controller/jobs/order/email/delivery/template-text
		 */

		/** controller/jobs/order/email/delivery/template-text
		 * Relative path to the template for the text part of the delivery emails.
		 *
		 * The template file contains the text and processing instructions
		 * to generate the result shown in the body of the frontend. The
		 * configuration string is the path to the template file relative
		 * to the templates directory (usually in templates/controller/jobs).
		 * You can overwrite the template file configuration in extensions and
		 * provide alternative templates.
		 *
		 * @param string Relative path to the template
		 * @since 2022.04
		 * @see controller/jobs/order/email/delivery/template-html
		 */

		$address = $this->address( $order );

		$context = $this->context();
		$context->locale()->setLanguageId( $address->getLanguageId() );

		$msg = $this->call( 'mailTo', $address );
		$msg = $this->attachments( $msg );

		$view = $this->view( $order, $theme );
		$view->logo = $msg->embed( $this->call( 'mailLogo', $logoPath ), basename( (string) $logoPath ) );
		$view->summaryBasket = $order;
		$view->addressItem = $address;
		$view->orderItem = $order;

		$config = $context->config();

		/** controller/jobs/order/email/delivery/cc-email
		 * E-Mail address all delivery e-mails should be also sent to
		 *
		 * Using this option you can send a copy of all delivery related e-mails
		 * to a second e-mail account. This can be handy for testing and checking
		 * the e-mails sent to customers.
		 *
		 * It also allows shop owners with a very small volume of orders to be
		 * notified about delivery changes. Be aware that this isn't useful if the
		 * order volumne is high or has peeks!
		 *
		 * @param string E-mail address or list of e-mail addresses
		 * @since 2023.10
		 */
		$msg->cc( $config->get( 'controller/jobs/order/email/delivery/cc-email', '' ) );

		/** controller/jobs/order/email/delivery/bcc-email
		 * Hidden e-mail address all delivery e-mails should be also sent to
		 *
		 * Using this option you can send a copy of all delivery related e-mails
		 * to a second e-mail account. This can be handy for testing and checking
		 * the e-mails sent to customers.
		 *
		 * It also allows shop owners with a very small volume of orders to be
		 * notified about delivery changes. Be aware that this isn't useful if the
		 * order volumne is high or has peeks!
		 *
		 * @param string|array E-mail address or list of e-mail addresses
		 * @since 2014.03
		 */
		$msg->bcc( $config->get( 'controller/jobs/order/email/delivery/bcc-email', [] ) );

		$msg->subject( sprintf( $context->translate( 'controller/jobs', 'Your order %1$s' ), $order->getInvoiceNumber() ) )
			->html( $view->render( $config->get( 'controller/jobs/order/email/delivery/template-html', 'order/email/delivery/html' ) ) )
			->text( $view->render( $config->get( 'controller/jobs/order/email/delivery/template-text', 'order/email/delivery/text' ) ) )
			->send();
	}


	/**
	 * Returns the site items for the given site codes
	 *
	 * @param iterable $siteIds List of site IDs
	 * @return \Aimeos\Map Site items with codes as keys
	 */
	protected function sites( iterable $siteIds ) : \Aimeos\Map
	{
		$map = [];
		$manager = \Aimeos\MShop::create( $this->context(), 'locale/site' );

		foreach( $siteIds as $siteId )
		{
			$list = explode( '.', trim( $siteId, '.' ) );
			$map[$siteId] = $manager->getPath( end( $list ) );
		}

		return map( $map );
	}


	/**
	 * Returns the list of delivery status values for which e-mails should be sent
	 *
	 * @return array List of delivery status values
	 */
	protected function status() : array
	{
		$default = [
			\Aimeos\MShop\Order\Item\Base::STAT_PROGRESS,
			\Aimeos\MShop\Order\Item\Base::STAT_DISPATCHED,
			\Aimeos\MShop\Order\Item\Base::STAT_REFUSED,
			\Aimeos\MShop\Order\Item\Base::STAT_RETURNED,
		];

		/** controller/jobs/order/email/delivery/status
		 * Only send order delivery notification e-mails for these delivery status values
		 *
		 * Notification e-mail about delivery status changes can be sent for these
		 * status values:
		 *
		 * * 0: deleted
		 * * 1: pending
		 * * 2: progress
		 * * 3: dispatched
		 * * 4: delivered
		 * * 5: lost
		 * * 6: refused
		 * * 7: returned
		 *
		 * User-defined status values are possible but should be in the private
		 * block of values between 30000 and 32767.
		 *
		 * @param integer Delivery status constant
		 * @since 2014.03
		 * @see controller/jobs/order/email/payment/status
		 * @see controller/jobs/order/email/delivery/limit-days
		 */
		return (array) $this->context()->config()->get( 'controller/jobs/order/email/delivery/status', $default );
	}


	/**
	 * Returns the status type for filtering the orders
	 *
	 * @return string Status type
	 */
	protected function type() : string
	{
		return \Aimeos\MShop\Order\Item\Status\Base::EMAIL_DELIVERY;
	}


	/**
	 * Adds the status of the delivered e-mail for the given order ID
	 *
	 * @param string $orderId Unique order ID
	 * @param int $value Status value
	 */
	protected function update( string $orderId, int $value )
	{
		$manager = \Aimeos\MShop::create( $this->context(), 'order/status' );

		$item = $manager->create()
			->setParentId( $orderId )
			->setType( $this->type() )
			->setValue( $value );

		$manager->save( $item );
	}


	/**
	 * Returns the view populated with common data
	 *
	 * @param \Aimeos\MShop\Order\Item\Iface $base Basket including addresses
	 * @param string|null $theme Theme name
	 * @return \Aimeos\Base\View\Iface View object
	 */
	protected function view( \Aimeos\MShop\Order\Item\Iface $base, string $theme = null ) : \Aimeos\Base\View\Iface
	{
		$address = $this->address( $base );
		$langId = $address->getLanguageId() ?: $base->locale()->getLanguageId();

		$view = $this->call( 'mailView', $langId );
		$view->intro = $this->call( 'mailIntro', $address );
		$view->css = $this->call( 'mailCss', $theme );
		$view->address = $address;
		$view->urlparams = [
			'currency' => $base->getPrice()->getCurrencyId(),
			'site' => $base->getSiteCode(),
			'locale' => $langId,
		];

		return $view;
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5			* @copyright Aimeos (aimeos.org), 2015-2024
6			* @package Controller
7			* @subpackage Order
8			*/
9
10
11			namespace Aimeos\Controller\Jobs\Order\Email\Delivery;
12
13
14			/**
15			* Order delivery e-mail job controller.
16			*
17			* @package Controller
18			* @subpackage Order
19			*/
20			class Standard
21			extends \Aimeos\Controller\Jobs\Base
22			implements \Aimeos\Controller\Jobs\Iface
23			{
24			/** controller/jobs/order/email/delivery/name
25			* Class name of the used order email delivery scheduler controller implementation
26			*
27			* Each default job controller can be replace by an alternative imlementation.
28			* To use this implementation, you have to set the last part of the class
29			* name as configuration value so the controller factory knows which class it
30			* has to instantiate.
31			*
32			* For example, if the name of the default class is
33			*
34			* \Aimeos\Controller\Jobs\Order\Email\Delivery\Standard
35			*
36			* and you want to replace it with your own version named
37			*
38			* \Aimeos\Controller\Jobs\Order\Email\Delivery\Mydelivery
39			*
40			* then you have to set the this configuration option:
41			*
42			* controller/jobs/order/email/delivery/name = Mydelivery
43			*
44			* The value is the last part of your own class name and it's case sensitive,
45			* so take care that the configuration value is exactly named like the last
46			* part of the class name.
47			*
48			* The allowed characters of the class name are A-Z, a-z and 0-9. No other
49			* characters are possible! You should always start the last part of the class
50			* name with an upper case character and continue only with lower case characters
51			* or numbers. Avoid chamel case names like "MyDelivery"!
52			*
53			* @param string Last part of the class name
54			* @since 2014.03
55			*/
56
57			/** controller/jobs/order/email/delivery/decorators/excludes
58			* Excludes decorators added by the "common" option from the order email delivery controllers
59			*
60			* Decorators extend the functionality of a class by adding new aspects
61			* (e.g. log what is currently done), executing the methods of the underlying
62			* class only in certain conditions (e.g. only for logged in users) or
63			* modify what is returned to the caller.
64			*
65			* This option allows you to remove a decorator added via
66			* "controller/jobs/common/decorators/default" before they are wrapped
67			* around the job controller.
68			*
69			* controller/jobs/order/email/delivery/decorators/excludes = array( 'decorator1' )
70			*
71			* This would remove the decorator named "decorator1" from the list of
72			* common decorators ("\Aimeos\Controller\Jobs\Common\Decorator\*") added via
73			* "controller/jobs/common/decorators/default" to this job controller.
74			*
75			* @param array List of decorator names
76			* @since 2015.09
77			* @see controller/jobs/common/decorators/default
78			* @see controller/jobs/order/email/delivery/decorators/global
79			* @see controller/jobs/order/email/delivery/decorators/local
80			*/
81
82			/** controller/jobs/order/email/delivery/decorators/global
83			* Adds a list of globally available decorators only to the order email delivery controllers
84			*
85			* Decorators extend the functionality of a class by adding new aspects
86			* (e.g. log what is currently done), executing the methods of the underlying
87			* class only in certain conditions (e.g. only for logged in users) or
88			* modify what is returned to the caller.
89			*
90			* This option allows you to wrap global decorators
91			* ("\Aimeos\Controller\Jobs\Common\Decorator\*") around the job controller.
92			*
93			* controller/jobs/order/email/delivery/decorators/global = array( 'decorator1' )
94			*
95			* This would add the decorator named "decorator1" defined by
96			* "\Aimeos\Controller\Jobs\Common\Decorator\Decorator1" only to this job controller.
97			*
98			* @param array List of decorator names
99			* @since 2015.09
100			* @see controller/jobs/common/decorators/default
101			* @see controller/jobs/order/email/delivery/decorators/excludes
102			* @see controller/jobs/order/email/delivery/decorators/local
103			*/
104
105			/** controller/jobs/order/email/delivery/decorators/local
106			* Adds a list of local decorators only to the order email delivery controllers
107			*
108			* Decorators extend the functionality of a class by adding new aspects
109			* (e.g. log what is currently done), executing the methods of the underlying
110			* class only in certain conditions (e.g. only for logged in users) or
111			* modify what is returned to the caller.
112			*
113			* This option allows you to wrap local decorators
114			* ("\Aimeos\Controller\Jobs\Order\Email\Delivery\Decorator\*") around this job controller.
115			*
116			* controller/jobs/order/email/delivery/decorators/local = array( 'decorator2' )
117			*
118			* This would add the decorator named "decorator2" defined by
119			* "\Aimeos\Controller\Jobs\Order\Email\Delivery\Decorator\Decorator2" only to this job
120			* controller.
121			*
122			* @param array List of decorator names
123			* @since 2015.09
124			* @see controller/jobs/common/decorators/default
125			* @see controller/jobs/order/email/delivery/decorators/excludes
126			* @see controller/jobs/order/email/delivery/decorators/global
127			*/
128
129
130			use \Aimeos\Controller\Jobs\Mail;
131
132
133			/**
134			* Returns the localized name of the job.
135			*
136			* @return string Name of the job
137			*/
138			public function getName() : string
139			{
140			return $this->context()->translate( 'controller/jobs', 'Order delivery related e-mails' );
141			}
142
143
144			/**
145			* Returns the localized description of the job.
146			*
147			* @return string Description of the job
148			*/
149			public function getDescription() : string
150			{
151			return $this->context()->translate( 'controller/jobs', 'Sends order delivery status update e-mails' );
152			}
153
154
155			/**
156			* Executes the job.
157			*
158			* @throws \Aimeos\Controller\Jobs\Exception If an error occurs
159			*/
160			public function run()
161			{
162			$context = $this->context();
163			$manager = \Aimeos\MShop::create( $context, 'order' );
164
165			foreach( $this->status() as $status )
166			{
167			$ref = ['order'] + $context->config()->get( 'mshop/order/manager/subdomains', [] );
168			$filter = $this->filter( $manager->filter(), $status );
169			$cursor = $manager->cursor( $filter );
170
171			while( $items = $manager->iterate( $cursor, $ref ) ) {
172			$this->notify( $items, $status );
173			}
174			}
175			}
176
177
178			/**
179			* Returns the address item from the order
180			*
181			* @param \Aimeos\MShop\Order\Item\Iface $basket Order including address items
182			* @return \Aimeos\MShop\Common\Item\Address\Iface Address item
183			* @throws \Aimeos\Controller\Jobs\Exception If no suitable address item is available
184			*/
185			protected function address( \Aimeos\MShop\Order\Item\Iface $basket ) : \Aimeos\MShop\Common\Item\Address\Iface
186			{
187			if( ( $addr = current( $basket->getAddress( 'delivery' ) ) ) !== false && $addr->getEmail() ) {
188			return $addr;
189			};
190
191			if( ( $addr = current( $basket->getAddress( 'payment' ) ) ) !== false && $addr->getEmail() ) {
192			return $addr;
193			};
194
195			$msg = sprintf( 'No address with e-mail found in order base with ID "%1$s"', $basket->getId() );
196			throw new \Aimeos\Controller\Jobs\Exception( $msg );
197			}
198
199
200			/**
201			* Adds the given list of files as attachments to the mail message object
202			*
203			* @param \Aimeos\Base\Mail\Message\Iface $msg Mail message
204			* @param array $files List of absolute file paths
205			*/
206			protected function attachments( \Aimeos\Base\Mail\Message\Iface $msg ) : \Aimeos\Base\Mail\Message\Iface
207			{
208			$context = $this->context();
209			$fs = $context->fs();
210
211			/** controller/jobs/order/email/delivery/attachments
212			* List of file paths whose content should be attached to all delivery e-mails
213			*
214			* This configuration option allows you to add files to the e-mails that are
215			* sent to the customer when the delivery status changes, e.g. for the order
216			* confirmation e-mail. These files can't be customer specific.
217			*
218			* @param array List of absolute file paths
219			* @since 2016.10
220			* @see controller/jobs/order/email/payment/attachments
221			*/
222			$files = $context->config()->get( 'controller/jobs/order/email/delivery/attachments', [] );
223
224			foreach( $files as $filepath )
225			{
226			if( $fs->has( $filepath ) ) {
227			$msg->attach( $fs->read( $filepath ), basename( $filepath ) );
228			}
229			}
230
231			return $msg;
232			}
233
234
235			/**
236			* Returns the filter for searching the appropriate orders
237			*
238			* @param \Aimeos\Base\Criteria\Iface $filter Order filter object
239			* @param int $status Delivery status value to search for
240			* @return \Aimeos\Base\Criteria\Iface Filter object with conditions set
241			*/
242			protected function filter( \Aimeos\Base\Criteria\Iface $filter, int $status ) : \Aimeos\Base\Criteria\Iface
243			{
244			$limitDate = date( 'Y-m-d H:i:s', time() - $this->limit() * 86400 );
245			$param = [$this->type(), (string) $status];
246
247			$filter->add( $filter->and( [
248			$filter->compare( '>=', 'order.mtime', $limitDate ),
249			$filter->compare( '==', 'order.statusdelivery', $status ),
250			$filter->compare( '==', $filter->make( 'order:status', $param ), 0 ),
251			] ) );
252
253			return $filter;
254			}
255
256
257			/**
258			* Returns the number of days after no e-mail will be sent anymore
259			*
260			* @return int Number of days
261			*/
262			protected function limit() : int
263			{
264			/** controller/jobs/order/email/delivery/limit-days
265			* Only send delivery e-mails of orders that were created in the past within the configured number of days
266			*
267			* The delivery e-mails are normally send immediately after the delivery
268			* status has changed. This option prevents e-mails for old order from
269			* being send in case anything went wrong or an update failed to avoid
270			* confusion of customers.
271			*
272			* @param integer Number of days
273			* @since 2014.03
274			* @see controller/jobs/order/email/delivery/limit-days
275			* @see controller/jobs/service/delivery/process/limit-days
276			*/
277			return (int) $this->context()->config()->get( 'controller/jobs/order/email/delivery/limit-days', 90 );
278			}
279
280
281			/**
282			* Sends the delivery e-mail for the given orders
283			*
284			* @param \Aimeos\Map $items List of order items implementing \Aimeos\MShop\Order\Item\Iface with their IDs as keys
285			* @param int $status Delivery status value
286			*/
287			protected function notify( \Aimeos\Map $items, int $status )
288			{
289			$context = $this->context();
290			$sites = $this->sites( $items->getSiteId()->unique() );
291
292			foreach( $items as $id => $item )
293			{
294			try
295			{
296			$list = $sites->get( $item->getSiteId(), map() );
297
298			$this->send( $item, $list->getTheme()->filter()->last(), $list->getLogo()->filter()->last() );
299			$this->update( $id, $status );
300
301			$str = sprintf( 'Sent order delivery e-mail for order "%1$s" and status "%2$s"', $item->getId(), $status );
302			$context->logger()->info( $str, 'email/order/delivery' );
303			}
304			catch( \Exception $e )
305			{
306			$str = 'Error while trying to send delivery e-mail for order ID "%1$s" and status "%2$s": %3$s';
307			$msg = sprintf( $str, $item->getId(), $item->getStatusPayment(), $e->getMessage() );
308			$context->logger()->error( $msg . PHP_EOL . $e->getTraceAsString(), 'email/order/delivery' );
309			}
310			}
311			}
312
313
314			/**
315			* Sends the delivery related e-mail for a single order
316			*
317			* @param \Aimeos\MShop\Order\Item\Iface $order Order item
318			* @param string\|null $theme Theme name or NULL for default theme
319			* @param string\|null $logoPath Relative path to the logo in the fs-media file system
320			*/
321			protected function send( \Aimeos\MShop\Order\Item\Iface $order, string $theme = null, string $logoPath = null )
322			{
323			/** controller/jobs/order/email/delivery/template-html
324			* Relative path to the template for the HTML part of the delivery emails.
325			*
326			* The template file contains the HTML code and processing instructions
327			* to generate the result shown in the body of the frontend. The
328			* configuration string is the path to the template file relative
329			* to the templates directory (usually in templates/controller/jobs).
330			* You can overwrite the template file configuration in extensions and
331			* provide alternative templates.
332			*
333			* @param string Relative path to the template
334			* @since 2022.04
335			* @see controller/jobs/order/email/delivery/template-text
336			*/
337
338			/** controller/jobs/order/email/delivery/template-text
339			* Relative path to the template for the text part of the delivery emails.
340			*
341			* The template file contains the text and processing instructions
342			* to generate the result shown in the body of the frontend. The
343			* configuration string is the path to the template file relative
344			* to the templates directory (usually in templates/controller/jobs).
345			* You can overwrite the template file configuration in extensions and
346			* provide alternative templates.
347			*
348			* @param string Relative path to the template
349			* @since 2022.04
350			* @see controller/jobs/order/email/delivery/template-html
351			*/
352
353			$address = $this->address( $order );
354
355			$context = $this->context();
356			$context->locale()->setLanguageId( $address->getLanguageId() );
357
358			$msg = $this->call( 'mailTo', $address );
359			$msg = $this->attachments( $msg );
360
361			$view = $this->view( $order, $theme );
362			$view->logo = $msg->embed( $this->call( 'mailLogo', $logoPath ), basename( (string) $logoPath ) );
363			$view->summaryBasket = $order;
364			$view->addressItem = $address;
365			$view->orderItem = $order;
366
367			$config = $context->config();
368
369			/** controller/jobs/order/email/delivery/cc-email
370			* E-Mail address all delivery e-mails should be also sent to
371			*
372			* Using this option you can send a copy of all delivery related e-mails
373			* to a second e-mail account. This can be handy for testing and checking
374			* the e-mails sent to customers.
375			*
376			* It also allows shop owners with a very small volume of orders to be
377			* notified about delivery changes. Be aware that this isn't useful if the
378			* order volumne is high or has peeks!
379			*
380			* @param string E-mail address or list of e-mail addresses
381			* @since 2023.10
382			*/
383			$msg->cc( $config->get( 'controller/jobs/order/email/delivery/cc-email', '' ) );
384
385			/** controller/jobs/order/email/delivery/bcc-email
386			* Hidden e-mail address all delivery e-mails should be also sent to
387			*
388			* Using this option you can send a copy of all delivery related e-mails
389			* to a second e-mail account. This can be handy for testing and checking
390			* the e-mails sent to customers.
391			*
392			* It also allows shop owners with a very small volume of orders to be
393			* notified about delivery changes. Be aware that this isn't useful if the
394			* order volumne is high or has peeks!
395			*
396			* @param string\|array E-mail address or list of e-mail addresses
397			* @since 2014.03
398			*/
399			$msg->bcc( $config->get( 'controller/jobs/order/email/delivery/bcc-email', [] ) );
400
401			$msg->subject( sprintf( $context->translate( 'controller/jobs', 'Your order %1$s' ), $order->getInvoiceNumber() ) )
402			->html( $view->render( $config->get( 'controller/jobs/order/email/delivery/template-html', 'order/email/delivery/html' ) ) )
403			->text( $view->render( $config->get( 'controller/jobs/order/email/delivery/template-text', 'order/email/delivery/text' ) ) )
404			->send();
405			}
406
407
408			/**
409			* Returns the site items for the given site codes
410			*
411			* @param iterable $siteIds List of site IDs
412			* @return \Aimeos\Map Site items with codes as keys
413			*/
414			protected function sites( iterable $siteIds ) : \Aimeos\Map
415			{
416			$map = [];
417			$manager = \Aimeos\MShop::create( $this->context(), 'locale/site' );
418
419			foreach( $siteIds as $siteId )
420			{
421			$list = explode( '.', trim( $siteId, '.' ) );
422			$map[$siteId] = $manager->getPath( end( $list ) );
423			}
424
425			return map( $map );
426			}
427
428
429			/**
430			* Returns the list of delivery status values for which e-mails should be sent
431			*
432			* @return array List of delivery status values
433			*/
434			protected function status() : array
435			{
436			$default = [
437			\Aimeos\MShop\Order\Item\Base::STAT_PROGRESS,
438			\Aimeos\MShop\Order\Item\Base::STAT_DISPATCHED,
439			\Aimeos\MShop\Order\Item\Base::STAT_REFUSED,
440			\Aimeos\MShop\Order\Item\Base::STAT_RETURNED,
441			];
442
443			/** controller/jobs/order/email/delivery/status
444			* Only send order delivery notification e-mails for these delivery status values
445			*
446			* Notification e-mail about delivery status changes can be sent for these
447			* status values:
448			*
449			* * 0: deleted
450			* * 1: pending
451			* * 2: progress
452			* * 3: dispatched
453			* * 4: delivered
454			* * 5: lost
455			* * 6: refused
456			* * 7: returned
457			*
458			* User-defined status values are possible but should be in the private
459			* block of values between 30000 and 32767.
460			*
461			* @param integer Delivery status constant
462			* @since 2014.03
463			* @see controller/jobs/order/email/payment/status
464			* @see controller/jobs/order/email/delivery/limit-days
465			*/
466			return (array) $this->context()->config()->get( 'controller/jobs/order/email/delivery/status', $default );
467			}
468
469
470			/**
471			* Returns the status type for filtering the orders
472			*
473			* @return string Status type
474			*/
475			protected function type() : string
476			{
477			return \Aimeos\MShop\Order\Item\Status\Base::EMAIL_DELIVERY;
478			}
479
480
481			/**
482			* Adds the status of the delivered e-mail for the given order ID
483			*
484			* @param string $orderId Unique order ID
485			* @param int $value Status value
486			*/
487			protected function update( string $orderId, int $value )
488			{
489			$manager = \Aimeos\MShop::create( $this->context(), 'order/status' );
490
491			$item = $manager->create()
492			->setParentId( $orderId )
493			->setType( $this->type() )
494			->setValue( $value );
495
496			$manager->save( $item );
497			}
498
499
500			/**
501			* Returns the view populated with common data
502			*
503			* @param \Aimeos\MShop\Order\Item\Iface $base Basket including addresses
504			* @param string\|null $theme Theme name
505			* @return \Aimeos\Base\View\Iface View object
506			*/
507			protected function view( \Aimeos\MShop\Order\Item\Iface $base, string $theme = null ) : \Aimeos\Base\View\Iface
508			{
509			$address = $this->address( $base );
510			$langId = $address->getLanguageId() ?: $base->locale()->getLanguageId();
511
512			$view = $this->call( 'mailView', $langId );
513			$view->intro = $this->call( 'mailIntro', $address );
514			$view->css = $this->call( 'mailCss', $theme );
515			$view->address = $address;
516			$view->urlparams = [
517			'currency' => $base->getPrice()->getCurrencyId(),
518			'site' => $base->getSiteCode(),
519			'locale' => $langId,
520			];
521
522			return $view;
523			}
524			}
525

aimeos / ai-controller-jobs

Push — master ( 863c7f...5d3493 )

Standard::type() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like