move message content generator to Order Manager plugin
This commit is contained in:
parent
3c12bd79b5
commit
22a5b2a25c
GPG Key ID:
8A7C4C6ED1915C6F
|
|
@ -16,12 +16,12 @@ declare(strict_types=1);
|
|||
namespace D3\Linkmobility4Ordermanager\Application\Model\Actions;
|
||||
|
||||
use D3\Linkmobility4Ordermanager\Application\Model\d3linkmobility_ordermanager_sender;
|
||||
use D3\Linkmobility4Ordermanager\Application\Model\Exceptions\emptyMesageException;
|
||||
use D3\Linkmobility4OXID\Application\Model\Exceptions\noRecipientFoundException;
|
||||
use D3\ModCfg\Application\Model\Exception\d3_cfg_mod_exception;
|
||||
use D3\ModCfg\Application\Model\Exception\d3ParameterNotFoundException;
|
||||
use D3\ModCfg\Application\Model\Exception\d3ShopCompatibilityAdapterException;
|
||||
use D3\Ordermanager\Application\Model\Actions\d3ordermanager_action_abstract;
|
||||
use D3\Ordermanager\Application\Model\Exceptions\emptyMesageException;
|
||||
use D3\Ordermanager\Application\Model\d3ordermanager_conf;
|
||||
use D3\Ordermanager\Application\Model\Exceptions\d3ActionRequirementAbstract;
|
||||
use D3\Ordermanager\Application\Model\Exceptions\d3ordermanager_actionException;
|
||||
|
|
@ -204,6 +204,8 @@ class d3linkmobility_ordermanager_action extends d3ordermanager_action_abstract
|
|||
}
|
||||
|
||||
/**
|
||||
* @param bool $blExpected
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function hasRequiredValuesRecipient(bool $blExpected): bool
|
||||
|
|
|
|||
|
|
@ -1,27 +0,0 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*
|
||||
* https://www.d3data.de
|
||||
*
|
||||
* @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
|
||||
* @author D3 Data Development - Daniel Seifert <support@shopmodule.com>
|
||||
* @link https://www.oxidmodule.com
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace D3\Linkmobility4Ordermanager\Application\Model\Exceptions;
|
||||
|
||||
use OxidEsales\Eshop\Core\Exception\StandardException;
|
||||
|
||||
class emptyMesageException extends StandardException
|
||||
{
|
||||
public function __construct($sMessage = "not set", $iCode = 0, \Exception $previous = null)
|
||||
{
|
||||
$sMessage = 'empty message content in task '.$sMessage;
|
||||
parent::__construct($sMessage, $iCode, $previous);
|
||||
}
|
||||
}
|
||||
|
|
@ -1,319 +0,0 @@
|
|||
<?php
|
||||
|
||||
namespace D3\Linkmobility4Ordermanager\Application\Model;
|
||||
|
||||
use D3\Linkmobility4Ordermanager\Application\Model\Exceptions\emptyMesageException;
|
||||
use D3\ModCfg\Application\Model\d3str;
|
||||
use D3\Ordermanager\Application\Model\d3ordermanager as Manager;
|
||||
use D3\Ordermanager\Application\Model\d3ordermanager_renderererrorhandler;
|
||||
use D3\Ordermanager\Modules\Application\Model\d3_oxemail_ordermanager;
|
||||
use D3\Ordermanager\Modules\Application\Model\d3_oxorder_ordermanager as Item;
|
||||
use D3\OxidServiceBridges\Internal\Framework\Module\Path\ModulePathResolverBridgeInterface;
|
||||
use Exception;
|
||||
use InvalidArgumentException;
|
||||
use OxidEsales\Eshop\Application\Model\Basket;
|
||||
use OxidEsales\Eshop\Application\Model\Content;
|
||||
use OxidEsales\Eshop\Application\Model\Payment;
|
||||
use OxidEsales\Eshop\Application\Model\Shop;
|
||||
use OxidEsales\Eshop\Core\Email;
|
||||
use OxidEsales\Eshop\Core\Exception\ArticleException;
|
||||
use OxidEsales\Eshop\Core\Exception\ArticleInputException;
|
||||
use OxidEsales\Eshop\Core\Registry;
|
||||
use OxidEsales\EshopCommunity\Core\Controller\BaseController;
|
||||
use OxidEsales\EshopCommunity\Internal\Container\ContainerFactory;
|
||||
use OxidEsales\EshopCommunity\Internal\Framework\Templating\TemplateEngineInterface;
|
||||
use OxidEsales\EshopCommunity\Internal\Framework\Templating\TemplateRendererBridgeInterface;
|
||||
use OxidEsales\EshopCommunity\Internal\Framework\Templating\TemplateRendererInterface;
|
||||
use stdClass;
|
||||
|
||||
class MessageContentGenerator
|
||||
{
|
||||
public const TEMPLATE_FROM_ADMIN = 'fromAdmin';
|
||||
public const TEMPLATE_FROM_FRONTEND = 'fromFrontend';
|
||||
public const TEMPLATE_FROM_MODULE = 'fromModule';
|
||||
|
||||
private $templateFrom = self::TEMPLATE_FROM_ADMIN;
|
||||
private $tplModuleId;
|
||||
/** @var Manager */
|
||||
private $manager;
|
||||
/** @var Item */
|
||||
private $item;
|
||||
|
||||
/**
|
||||
* @param Manager $manager
|
||||
* @param Item $item
|
||||
* @throws ArticleException
|
||||
* @throws ArticleInputException
|
||||
*/
|
||||
public function __construct(Manager $manager, Item $item)
|
||||
{
|
||||
$this->setManager($manager);
|
||||
$this->prepareItem($item);
|
||||
$this->setItem($item);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $tplName
|
||||
* @return string
|
||||
* @throws emptyMesageException
|
||||
* @throws Exception
|
||||
*/
|
||||
public function generateFromTpl($tplName): string
|
||||
{
|
||||
[$iCurrentTplLang, $iCurrentBaseLang, $iCurrentCurrency] = $this->preGenerate();
|
||||
|
||||
$mail = $this->getMailer();
|
||||
$engine = $this->getTemplateEngine($mail);
|
||||
$content = $engine->render($tplName);
|
||||
|
||||
return $this->postGenerate($content, $iCurrentTplLang, $iCurrentBaseLang, $iCurrentCurrency);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $cmsIdent
|
||||
* @return string
|
||||
* @throws emptyMesageException
|
||||
* @throws Exception
|
||||
*/
|
||||
public function generateFromCms(string $cmsIdent): string
|
||||
{
|
||||
[$iCurrentTplLang, $iCurrentBaseLang, $iCurrentCurrency] = $this->preGenerate();
|
||||
|
||||
$mail = $this->getMailer();
|
||||
$engine = $this->getTemplateEngine($mail);
|
||||
|
||||
$oUtilsView = Registry::getUtilsView();
|
||||
$oContent = oxNew(Content::class);
|
||||
$oContent->loadInLang(
|
||||
$this->getItem()->getFieldData('oxlang'),
|
||||
$cmsIdent
|
||||
);
|
||||
|
||||
$content = $oUtilsView->getRenderedContent(
|
||||
$oContent->getFieldData('oxcontent'),
|
||||
$engine->getGlobals(),
|
||||
$oContent->getId() . 'oxcontent'
|
||||
);
|
||||
|
||||
return $this->postGenerate($content, $iCurrentTplLang, $iCurrentBaseLang, $iCurrentCurrency);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
* @throws Exception
|
||||
*/
|
||||
public function preGenerate(): array
|
||||
{
|
||||
Registry::getConfig()->setAdminMode($this->templateFrom === self::TEMPLATE_FROM_ADMIN);
|
||||
$iOrderLangId = $this->getItem()->getFieldData('oxlang');
|
||||
$oLang = Registry::getLang();
|
||||
/** @var int $iCurrentTplLang */
|
||||
$iCurrentTplLang = $oLang->getTplLanguage();
|
||||
/** @var int $iCurrentBaseLang */
|
||||
$iCurrentBaseLang = $oLang->getBaseLanguage();
|
||||
$oLang->setTplLanguage($iOrderLangId);
|
||||
$oLang->setBaseLanguage($iOrderLangId);
|
||||
|
||||
/** @var int $iCurrentCurrency */
|
||||
$iCurrentCurrency = Registry::getConfig()->getShopCurrency();
|
||||
/** @var stdClass $oOrderCurr */
|
||||
$oOrderCurr = $this->getItem()->getOrderCurrency();
|
||||
$iOrderCurr = $oOrderCurr->id;
|
||||
Registry::getConfig()->setActShopCurrency($iOrderCurr);
|
||||
|
||||
set_error_handler(
|
||||
[d3GetModCfgDIC()->get(d3ordermanager_renderererrorhandler::class), 'd3HandleTemplateEngineErrors']
|
||||
);
|
||||
|
||||
return array($iCurrentTplLang, $iCurrentBaseLang, $iCurrentCurrency);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $content
|
||||
* @param int $iCurrentTplLang
|
||||
* @param int $iCurrentBaseLang
|
||||
* @param int $iCurrentCurrency
|
||||
* @return string
|
||||
*/
|
||||
public function postGenerate(string $content, int $iCurrentTplLang, int $iCurrentBaseLang, int $iCurrentCurrency): string
|
||||
{
|
||||
restore_error_handler();
|
||||
|
||||
$oLang = Registry::getLang();
|
||||
$oLang->setTplLanguage($iCurrentTplLang);
|
||||
$oLang->setBaseLanguage($iCurrentBaseLang);
|
||||
Registry::getConfig()->setActShopCurrency($iCurrentCurrency);
|
||||
|
||||
Registry::getConfig()->setAdminMode(true);
|
||||
|
||||
if (false === (bool) strlen($content)) {
|
||||
throw oxNew(emptyMesageException::class, 'message content is empty', $this->getManager()->getFieldData('oxtitle'));
|
||||
}
|
||||
|
||||
return $content;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Item $item
|
||||
* @return void
|
||||
* @throws ArticleException
|
||||
* @throws ArticleInputException
|
||||
*/
|
||||
protected function prepareItem(Item $item)
|
||||
{
|
||||
/** @var Basket $oBasket */
|
||||
$oBasket = $item->d3getOrderBasket4OrderManager($this->getManager());
|
||||
|
||||
$oPayment = oxNew(Payment::class);
|
||||
$oPayment->loadInLang($item->getFieldData('oxlang'), $oBasket->getPaymentId());
|
||||
|
||||
$item->d3setBasket4OrderManager($oBasket);
|
||||
$item->d3setPayment4OrderManager($oPayment);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $from
|
||||
* @param string|null $moduleId
|
||||
* @return void
|
||||
*/
|
||||
public function setTemplateFrom(string $from, string $moduleId = null)
|
||||
{
|
||||
switch ($from) {
|
||||
case self::TEMPLATE_FROM_ADMIN:
|
||||
$this->templateFrom = self::TEMPLATE_FROM_ADMIN;
|
||||
return;
|
||||
case self::TEMPLATE_FROM_FRONTEND:
|
||||
$this->templateFrom = self::TEMPLATE_FROM_FRONTEND;
|
||||
return;
|
||||
case self::TEMPLATE_FROM_MODULE:
|
||||
if (is_null($moduleId)) throw oxNew(InvalidArgumentException::class, 'missing module');
|
||||
$this->templateFrom = self::TEMPLATE_FROM_MODULE;
|
||||
$this->tplModuleId = $moduleId;
|
||||
return;
|
||||
}
|
||||
|
||||
throw oxNew(InvalidArgumentException::class, 'unknown template source');
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Email $mail
|
||||
* @return TemplateEngineInterface
|
||||
*/
|
||||
protected function getTemplateEngine(Email $mail): TemplateEngineInterface
|
||||
{
|
||||
/** @var TemplateRendererInterface $renderer */
|
||||
$renderer = ContainerFactory::getInstance()->getContainer()
|
||||
->get(TemplateRendererBridgeInterface::class)
|
||||
->getTemplateRenderer();
|
||||
$engine = $renderer->getTemplateEngine();
|
||||
|
||||
// ToDo: check in TWIG and change to a generic solution (e.g. path names in template name)
|
||||
// Smarty only
|
||||
if (method_exists($engine, '__set')) {
|
||||
$engine->__set('template_dir', $this->getTemplateDir4OrderManager());
|
||||
}
|
||||
|
||||
foreach ($mail->getViewData() as $id => $value) {
|
||||
$engine->addGlobal($id, $value);
|
||||
}
|
||||
|
||||
return $engine;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getTemplateDir4OrderManager(): string
|
||||
{
|
||||
if ($this->templateFrom === self::TEMPLATE_FROM_MODULE) {
|
||||
/** @var ModulePathResolverBridgeInterface $pathResolverBridge */
|
||||
$pathResolverBridge = ContainerFactory::getInstance()->getContainer()->get(ModulePathResolverBridgeInterface::class);
|
||||
$sModulePath = $pathResolverBridge->getFullModulePathFromConfiguration(
|
||||
$this->tplModuleId,
|
||||
Registry::getConfig()->getShopId()
|
||||
);
|
||||
$sPath = (oxNew(d3str::class))->untrailingslashit($sModulePath);
|
||||
} else {
|
||||
$blAdmin = $this->templateFrom === self::TEMPLATE_FROM_ADMIN;
|
||||
$sPath = Registry::getConfig()->getTemplateDir($blAdmin);
|
||||
}
|
||||
return $sPath;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return d3_oxemail_ordermanager
|
||||
*/
|
||||
public function getMailer(): d3_oxemail_ordermanager
|
||||
{
|
||||
$mail = oxNew(Email::class);
|
||||
|
||||
$this->setViewData($mail);
|
||||
|
||||
return $mail;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Email $mail
|
||||
* @return void
|
||||
*/
|
||||
public function setViewData(Email $mail)
|
||||
{
|
||||
$oShop = $this->getShop();
|
||||
|
||||
$mail->setViewData("oShop", $oShop);
|
||||
$mail->setViewData("oViewConf", (oxNew(BaseController::class))->getViewConfig());
|
||||
$mail->setViewData("oOrder", $this->getItem());
|
||||
$mail->setViewData("oUser", $this->getItem()->getOrderUser());
|
||||
$mail->setViewData("shopTemplateDir", Registry::getConfig()->getTemplateDir());
|
||||
$mail->setViewData("charset", Registry::getLang()->translateString("charset"));
|
||||
|
||||
$mail->setViewData("shop", $oShop);
|
||||
$mail->setViewData("order", $this->getItem());
|
||||
$mail->setViewData("user", $this->getItem()->getOrderUser());
|
||||
$mail->setViewData("payment", $this->getItem()->d3getPayment4OrderManager());
|
||||
$mail->setViewData("oDelSet", $this->getItem()->getDelSet());
|
||||
$mail->setViewData("currency", $this->getItem()->getOrderCurrency());
|
||||
$mail->setViewData("basket", $this->getItem()->d3getBasket4OrderManager());
|
||||
$mail->setViewData("oEmailView", $mail);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Shop
|
||||
*/
|
||||
public function getShop(): Shop
|
||||
{
|
||||
return Registry::getConfig()->getActiveShop();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Item
|
||||
*/
|
||||
public function getItem(): Item
|
||||
{
|
||||
return $this->item;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Item $item
|
||||
*/
|
||||
public function setItem(Item $item): void
|
||||
{
|
||||
$this->item = $item;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Manager
|
||||
*/
|
||||
public function getManager(): Manager
|
||||
{
|
||||
return $this->manager;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Manager $manager
|
||||
*/
|
||||
public function setManager(Manager $manager): void
|
||||
{
|
||||
$this->manager = $manager;
|
||||
}
|
||||
}
|
||||
|
|
@ -15,7 +15,6 @@ declare(strict_types=1);
|
|||
|
||||
namespace D3\Linkmobility4Ordermanager\Application\Model;
|
||||
|
||||
use D3\Linkmobility4Ordermanager\Application\Model\Exceptions\emptyMesageException;
|
||||
use D3\Linkmobility4OXID\Application\Model\Exceptions\noRecipientFoundException;
|
||||
use D3\Linkmobility4OXID\Application\Model\MessageTypes\Sms;
|
||||
use D3\Linkmobility4OXID\Application\Model\OrderRecipients;
|
||||
|
|
@ -24,6 +23,8 @@ use D3\LinkmobilityClient\ValueObject\Recipient;
|
|||
use D3\ModCfg\Application\Model\Exception\d3ParameterNotFoundException;
|
||||
use D3\Ordermanager\Application\Model\d3ordermanager;
|
||||
use D3\Ordermanager\Application\Model\d3ordermanager as Manager;
|
||||
use D3\Ordermanager\Application\Model\Exceptions\emptyMesageException;
|
||||
use D3\Ordermanager\Application\Model\MessageContentGenerator;
|
||||
use OxidEsales\Eshop\Application\Model\Order;
|
||||
use OxidEsales\Eshop\Core\Exception\ArticleException;
|
||||
use OxidEsales\Eshop\Core\Exception\ArticleInputException;
|
||||
|
|
@ -90,7 +91,7 @@ class d3linkmobility_ordermanager_sender
|
|||
protected function getRecipients(): array
|
||||
{
|
||||
$recipients = [];
|
||||
if ((bool) $this->getManager()->getValue('blLinkMobilityMessageToCustomer')) {
|
||||
if ($this->getManager()->getValue('blLinkMobilityMessageToCustomer')) {
|
||||
try {
|
||||
$recipients[] = (oxNew(OrderRecipients::class, $this->getItem()))->getSmsRecipient();
|
||||
} catch (noRecipientFoundException $e) {
|
||||
|
|
@ -99,7 +100,7 @@ class d3linkmobility_ordermanager_sender
|
|||
$this->getManager()->getRemarkHandler()->addNote($note);
|
||||
}
|
||||
}
|
||||
if ((bool) $this->getManager()->getValue('blLinkMobilityMessageToCustom') &&
|
||||
if ($this->getManager()->getValue('blLinkMobilityMessageToCustom') &&
|
||||
strlen(trim($this->getManager()->getValue('sLinkMobilityMessageToCustomAddress')))
|
||||
) {
|
||||
foreach ($this->extractCustomAddresses() as $phoneNumber => $countryId) {
|
||||
|
|
|
|||
Loading…
Reference in New Issue