vendor/pimcore/pimcore/lib/Workflow/EventSubscriber/NotificationSubscriber.php line 65

  1. <?php
  2. declare(strict_types=1);
  4. /**
  5.  * Pimcore
  6.  *
  7.  * This source file is available under two different licenses:
  8.  * - GNU General Public License version 3 (GPLv3)
  9.  * - Pimcore Commercial License (PCL)
  10.  * Full copyright and license information is available in
  11.  * LICENSE.md which is distributed with this source code.
  12.  *
  13.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  14.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  15.  */
  17. namespace Pimcore\Workflow\EventSubscriber;
  19. use Pimcore\Model\DataObject\Concrete;
  20. use Pimcore\Model\Element\ElementInterface;
  21. use Pimcore\Model\Element\Service;
  22. use Pimcore\Workflow;
  23. use Pimcore\Workflow\Notification\NotificationEmailService;
  24. use Pimcore\Workflow\Transition;
  25. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  26. use Symfony\Component\Workflow\Event\Event;
  27. use Symfony\Contracts\Translation\TranslatorInterface;
  29. /**
  30.  * @internal
  31.  */
  32. class NotificationSubscriber implements EventSubscriberInterface
  33. {
  34.     const MAIL_TYPE_TEMPLATE = 'template';
  36.     const MAIL_TYPE_DOCUMENT = 'pimcore_document';
  38.     const NOTIFICATION_CHANNEL_MAIL = 'mail';
  40.     const NOTIFICATION_CHANNEL_PIMCORE_NOTIFICATION = 'pimcore_notification';
  42.     const DEFAULT_MAIL_TEMPLATE_PATH = '@PimcoreCore/Workflow/NotificationEmail/notificationEmail.html.twig';
  44.     protected NotificationEmailService $mailService;
  46.     protected Workflow\Notification\PimcoreNotificationService $pimcoreNotificationService;
  48.     protected TranslatorInterface $translator;
  50.     protected bool $enabled = true;
  52.     protected Workflow\ExpressionService $expressionService;
  54.     protected Workflow\Manager $workflowManager;
  56.     public function __construct(NotificationEmailService $mailService, Workflow\Notification\PimcoreNotificationService $pimcoreNotificationService, TranslatorInterface $translator, Workflow\ExpressionService $expressionService, Workflow\Manager $workflowManager)
  57.     {
  58.         $this->mailService = $mailService;
  59.         $this->pimcoreNotificationService = $pimcoreNotificationService;
  60.         $this->translator = $translator;
  61.         $this->expressionService = $expressionService;
  62.         $this->workflowManager = $workflowManager;
  63.     }
  65.     public function onWorkflowCompleted(Event $event): void
  66.     {
  67.         if (!$this->checkEvent($event)) {
  68.             return;
  69.         }
  71.         /** @var ElementInterface $subject */
  72.         $subject = $event->getSubject();
  73.         /** @var Transition $transition */
  74.         $transition = $event->getTransition();
  75.         $workflow = $this->workflowManager->getWorkflowByName($event->getWorkflowName());
  77.         $notificationSettings = $transition->getNotificationSettings();
  78.         foreach ($notificationSettings as $notificationSetting) {
  79.             $condition = $notificationSetting['condition'] ?? null;
  81.             if (empty($condition) || $this->expressionService->evaluateExpression($workflow, $subject, $condition)) {
  82.                 $notifyUsers = $notificationSetting['notifyUsers'] ?? [];
  83.                 $notifyRoles = $notificationSetting['notifyRoles'] ?? [];
  85.                 if (in_array(self::NOTIFICATION_CHANNEL_MAIL, $notificationSetting['channelType'])) {
  86.                     $this->handleNotifyPostWorkflowEmail($transition, $workflow, $subject, $notificationSetting['mailType'], $notificationSetting['mailPath'], $notifyUsers, $notifyRoles);
  87.                 }
  89.                 if (in_array(self::NOTIFICATION_CHANNEL_PIMCORE_NOTIFICATION, $notificationSetting['channelType'])) {
  90.                     $this->handleNotifyPostWorkflowPimcoreNotification($transition, $workflow, $subject, $notifyUsers, $notifyRoles);
  91.                 }
  92.             }
  93.         }
  94.     }
  96.     private function handleNotifyPostWorkflowEmail(Transition $transition, \Symfony\Component\Workflow\Workflow $workflow, ElementInterface $subject, string $mailType, string $mailPath, array $notifyUsers, array $notifyRoles): void
  97.     {
  98.         //notify users
  99.         $subjectType = ($subject instanceof Concrete ? $subject->getClassName() : Service::getElementType($subject));
  101.         $this->mailService->sendWorkflowEmailNotification(
  102.             $notifyUsers,
  103.             $notifyRoles,
  104.             $workflow,
  105.             $subjectType,
  106.             $subject,
  107.             $transition->getLabel(),
  108.             $mailType,
  109.             $mailPath
  110.         );
  111.     }
  113.     private function handleNotifyPostWorkflowPimcoreNotification(Transition $transition, \Symfony\Component\Workflow\Workflow $workflow, ElementInterface $subject, array $notifyUsers, array $notifyRoles): void
  114.     {
  115.         $subjectType = ($subject instanceof Concrete ? $subject->getClassName() : Service::getElementType($subject));
  116.         $this->pimcoreNotificationService->sendPimcoreNotification(
  117.             $notifyUsers,
  118.             $notifyRoles,
  119.             $workflow,
  120.             $subjectType,
  121.             $subject,
  122.             $transition->getLabel()
  123.         );
  124.     }
  126.     /**
  127.      * check's if the event subscriber should be executed
  128.      */
  129.     private function checkEvent(Event $event): bool
  130.     {
  131.         return $this->isEnabled()
  132.             && $event->getTransition() instanceof Transition
  133.             && $event->getSubject() instanceof ElementInterface;
  134.     }
  136.     public function isEnabled(): bool
  137.     {
  138.         return $this->enabled;
  139.     }
  141.     public function setEnabled(bool $enabled): void
  142.     {
  143.         $this->enabled = $enabled;
  144.     }
  146.     public static function getSubscribedEvents(): array
  147.     {
  148.         return [
  149.             'workflow.completed' => ['onWorkflowCompleted', 0],
  150.         ];
  151.     }
  152. }