vendor/pimcore/pimcore/lib/Workflow/EventSubscriber/NotificationEmailSubscriber.php line 80

Open in your IDE?
  1. <?php
  2. /**
  3.  * Pimcore
  4.  *
  5.  * This source file is available under two different licenses:
  6.  * - GNU General Public License version 3 (GPLv3)
  7.  * - Pimcore Enterprise License (PEL)
  8.  * Full copyright and license information is available in
  9.  * LICENSE.md which is distributed with this source code.
  10.  *
  11.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  12.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  13.  */
  15. namespace Pimcore\Workflow\EventSubscriber;
  17. use Pimcore\Model\Element\AbstractElement;
  18. use Pimcore\Model\Element\Service;
  19. use Pimcore\Model\Element\ValidationException;
  20. use Pimcore\Workflow;
  21. use Pimcore\Workflow\NotificationEmail\NotificationEmailService;
  22. use Pimcore\Workflow\Transition;
  23. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  24. use Symfony\Component\Translation\TranslatorInterface;
  25. use Symfony\Component\Workflow\Event\Event;
  27. class NotificationEmailSubscriber implements EventSubscriberInterface
  28. {
  29.     const MAIL_TYPE_TEMPLATE = 'template';
  30.     const MAIL_TYPE_DOCUMENT = 'pimcore_document';
  32.     const DEFAULT_MAIL_TEMPLATE_PATH = '@PimcoreCore/Workflow/NotificationEmail/notificationEmail.html.twig';
  34.     /**
  35.      * @var TranslatorInterface
  36.      */
  37.     private $mailService;
  39.     /**
  40.      * @var TranslatorInterface
  41.      */
  42.     private $translator;
  44.     /**
  45.      * @var bool
  46.      */
  47.     private $enabled = true;
  49.     /**
  50.      * @var Workflow\ExpressionService
  51.      */
  52.     private $expressionService;
  54.     /**
  55.      * @var Workflow\Manager
  56.      */
  57.     private $workflowManager;
  59.     /**
  60.      * NotificationEmailSubscriber constructor.
  61.      *
  62.      * @param NotificationEmailService $mailService
  63.      * @param TranslatorInterface $translator
  64.      * @param Workflow\ExpressionService $expressionService
  65.      * @param Workflow\Manager $manager
  66.      */
  67.     public function __construct(NotificationEmailService $mailService, TranslatorInterface $translator, Workflow\ExpressionService $expressionService, Workflow\Manager $manager)
  68.     {
  69.         $this->mailService = $mailService;
  70.         $this->translator = $translator;
  71.         $this->expressionService = $expressionService;
  72.         $this->workflowManager = $manager;
  73.     }
  75.     /**
  76.      * @param Event $event
  77.      *
  78.      * @throws ValidationException
  79.      */
  80.     public function onWorkflowCompleted(Event $event)
  81.     {
  82.         if (!$this->checkEvent($event)) {
  83.             return;
  84.         }
  86.         /**
  87.          * @var AbstractElement $subject
  88.          * @var Transition $transition
  89.          */
  90.         $subject = $event->getSubject();
  91.         $transition = $event->getTransition();
  92.         $workflow = $this->workflowManager->getWorkflowByName($event->getWorkflowName());
  94.         $notificationSettings = $transition->getNotificationSettings();
  95.         foreach ($notificationSettings as $notificationSetting) {
  96.             $condition = $notificationSetting['condition'];
  98.             if (empty($condition) || $this->expressionService->evaluateExpression($workflow, $subject, $condition)) {
  99.                 $notifyUsers = $notificationSetting['notifyUsers'] ?? [];
  100.                 $notifyRoles = $notificationSetting['notifyRoles'] ?? [];
  102.                 $this->handleNotifyPostWorkflow($transition, $workflow, $subject, $notificationSetting['mailType'], $notificationSetting['mailPath'], $notifyUsers, $notifyRoles);
  103.             }
  104.         }
  105.     }
  107.     /**
  108.      * @param Transition $notifyEmail
  109.      * @param \Pimcore\Model\Workflow $workflow
  110.      * @param AbstractElement $subject
  111.      * @param string $mailType
  112.      * @param string $mailPath
  113.      */
  114.     private function handleNotifyPostWorkflow(Transition $transition, \Symfony\Component\Workflow\Workflow $workflow, AbstractElement $subject, string $mailType, string $mailPath, array $notifyUsers, array $notifyRoles)
  115.     {
  116.         //notify users
  117.         $subjectType = (Service::getType($subject) == 'object' ? $subject->getClassName() : Service::getType($subject));
  119.         $this->mailService->sendWorkflowEmailNotification(
  120.             $notifyUsers,
  121.             $notifyRoles,
  122.             $workflow,
  123.             $subjectType,
  124.             $subject,
  125.             $transition->getLabel(),
  126.             $mailType,
  127.             $mailPath
  128.         );
  129.     }
  131.     /**
  132.      * check's if the event subscriber should be executed
  133.      *
  134.      * @param Event $event
  135.      *
  136.      * @return bool
  137.      */
  138.     private function checkEvent(Event $event): bool
  139.     {
  140.         return $this->isEnabled()
  141.             && $event->getTransition() instanceof Transition
  142.             && $event->getSubject() instanceof AbstractElement;
  143.     }
  145.     /**
  146.      * @return bool
  147.      */
  148.     public function isEnabled(): bool
  149.     {
  150.         return $this->enabled;
  151.     }
  153.     /**
  154.      * @param bool $enabled
  155.      */
  156.     public function setEnabled(bool $enabled): void
  157.     {
  158.         $this->enabled = $enabled;
  159.     }
  161.     public static function getSubscribedEvents()
  162.     {
  163.         return [
  164.             'workflow.completed' => ['onWorkflowCompleted', 0]
  165.         ];
  166.     }
  167. }