vendor/pimcore/pimcore/lib/Workflow/EventSubscriber/NotesSubscriber.php line 54

  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\Event\Workflow\GlobalActionEvent;
  20. use Pimcore\Event\WorkflowEvents;
  21. use Pimcore\Model\Element\ElementInterface;
  22. use Pimcore\Model\Element\ValidationException;
  23. use Pimcore\Workflow;
  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 NotesSubscriber implements EventSubscriberInterface
  33. {
  34.     const ADDITIONAL_DATA_NOTES_COMMENT = 'notes';
  36.     const ADDITIONAL_DATA_NOTES_ADDITIONAL_FIELDS = 'additional';
  38.     private TranslatorInterface $translator;
  40.     private bool $enabled = true;
  42.     private array $additionalData = [];
  44.     public function __construct(TranslatorInterface $translator)
  45.     {
  46.         $this->translator = $translator;
  47.     }
  49.     /**
  50.      * @param Event $event
  51.      *
  52.      * @throws ValidationException
  53.      */
  54.     public function onWorkflowEnter(Event $event): void
  55.     {
  56.         if (!$this->checkEvent($event)) {
  57.             return;
  58.         }
  60.         /** @var ElementInterface $subject */
  61.         $subject = $event->getSubject();
  62.         /** @var Transition $transition */
  63.         $transition = $event->getTransition();
  65.         $this->handleNotesPreWorkflow($transition, $subject);
  66.     }
  68.     public function onWorkflowCompleted(Event $event): void
  69.     {
  70.         if (!$this->checkEvent($event)) {
  71.             return;
  72.         }
  74.         /** @var ElementInterface $subject */
  75.         $subject = $event->getSubject();
  76.         /** @var Transition $transition */
  77.         $transition = $event->getTransition();
  79.         $this->handleNotesPostWorkflow($transition, $subject);
  80.     }
  82.     /**
  83.      * @param GlobalActionEvent $event
  84.      *
  85.      * @throws ValidationException
  86.      */
  87.     public function onPreGlobalAction(GlobalActionEvent $event): void
  88.     {
  89.         if (!$this->checkGlobalActionEvent($event)) {
  90.             return;
  91.         }
  93.         $subject = $event->getSubject();
  94.         $globalAction = $event->getGlobalAction();
  96.         $this->handleNotesPreWorkflow($globalAction, $subject);
  97.     }
  99.     public function onPostGlobalAction(GlobalActionEvent $event): void
  100.     {
  101.         if (!$this->checkGlobalActionEvent($event)) {
  102.             return;
  103.         }
  105.         $subject = $event->getSubject();
  106.         $globalAction = $event->getGlobalAction();
  108.         $this->handleNotesPostWorkflow($globalAction, $subject);
  109.     }
  111.     /**
  112.      * @throws ValidationException
  113.      */
  114.     private function handleNotesPreWorkflow(Workflow\Notes\NotesAwareInterface $notesAware, ElementInterface $subject): void
  115.     {
  116.         if (($setterFn = $notesAware->getNotesCommentSetterFn()) && ($notes = $this->getNotesComment())) {
  117.             $subject->$setterFn($notes);
  118.         }
  120.         foreach ($notesAware->getNotesAdditionalFields() as $additionalFieldConfig) {
  121.             $data = $this->getAdditionalDataForField($additionalFieldConfig);
  123.             //check required
  124.             if ($additionalFieldConfig['required'] && empty($data)) {
  125.                 $label = isset($additionalFieldConfig['title']) && strlen($additionalFieldConfig['title']) > 0
  126.                     ? $additionalFieldConfig['title']
  127.                     : $additionalFieldConfig['name'];
  129.                 throw new ValidationException(
  130.                     $this->translator->trans('workflow_notes_requred_field_message', [$label], 'admin')
  131.                 );
  132.             }
  134.             //work out whether or not to set the value directly to the object or to add it to the note data
  135.             if (!empty($additionalFieldConfig['setterFn'])) {
  136.                 $setterFn = $additionalFieldConfig['setterFn'];
  137.                 $subject->$setterFn($this->getAdditionalDataForField($additionalFieldConfig));
  138.             }
  139.         }
  140.     }
  142.     private function handleNotesPostWorkflow(Workflow\Notes\NotesAwareInterface $notesAware, ElementInterface $subject): void
  143.     {
  144.         $additionalFieldsData = [];
  145.         foreach ($notesAware->getNotesAdditionalFields() as $additionalFieldConfig) {
  146.             /**
  147.              * Additional Field example
  148.              * [
  149.             'name' => 'dateLastContacted',
  150.             'fieldType' => 'date',
  151.             'label' => 'Date of Conversation',
  152.             'required' => true,
  153.             'setterFn' => ''
  154.             ]
  155.              */
  157.             //work out whether or not to set the value directly to the object or to add it to the note data
  158.             if (empty($additionalFieldConfig['setterFn'])) {
  159.                 $additionalFieldsData[] = Workflow\Service::createNoteData($additionalFieldConfig, $this->getAdditionalDataForField($additionalFieldConfig));
  160.             }
  161.         }
  163.         Workflow\Service::createActionNote(
  164.             $subject,
  165.             $notesAware->getNotesType(),
  166.             $notesAware->getNotesTitle(),
  167.             $this->getNotesComment(),
  168.             $additionalFieldsData
  169.         );
  170.     }
  172.     /**
  173.      * check's if the event subscriber should be executed
  174.      */
  175.     private function checkEvent(Event $event): bool
  176.     {
  177.         return $this->isEnabled()
  178.                && $event->getTransition() instanceof Transition
  179.                && $event->getSubject() instanceof ElementInterface;
  180.     }
  182.     private function checkGlobalActionEvent(GlobalActionEvent $event): bool
  183.     {
  184.         return $this->isEnabled()
  185.                && $event->getSubject() instanceof ElementInterface;
  186.     }
  188.     public function isEnabled(): bool
  189.     {
  190.         return $this->enabled;
  191.     }
  193.     public function setEnabled(bool $enabled): void
  194.     {
  195.         $this->enabled = $enabled;
  196.     }
  198.     public function getAdditionalData(): array
  199.     {
  200.         return $this->additionalData;
  201.     }
  203.     public function setAdditionalData(array $additionalData = []): void
  204.     {
  205.         $this->additionalData = $additionalData;
  206.     }
  208.     /**
  209.      * @param array<string, mixed> $fieldConfig
  210.      */
  211.     private function getAdditionalDataForField(array $fieldConfig): mixed
  212.     {
  213.         $additional = $this->getAdditionalFields();
  215.         $data = $additional[$fieldConfig['name']];
  217.         if ($fieldConfig['fieldType'] === 'checkbox') {
  218.             return $data === 'true';
  219.         }
  221.         return $data;
  222.     }
  224.     private function getNotesComment(): string
  225.     {
  226.         return $this->additionalData[self::ADDITIONAL_DATA_NOTES_COMMENT] ?? '';
  227.     }
  229.     private function getAdditionalFields(): array
  230.     {
  231.         return $this->additionalData[self::ADDITIONAL_DATA_NOTES_ADDITIONAL_FIELDS] ?? [];
  232.     }
  234.     public static function getSubscribedEvents(): array
  235.     {
  236.         return [
  237.             'workflow.completed' => ['onWorkflowCompleted', 1],
  238.             'workflow.enter' => 'onWorkflowEnter',
  239.             WorkflowEvents::PRE_GLOBAL_ACTION => 'onPreGlobalAction',
  240.             WorkflowEvents::POST_GLOBAL_ACTION => 'onPostGlobalAction',
  241.         ];
  242.     }
  243. }