vendor/ibexa/workflow/src/lib/Event/Subscriber/TimelineTransitionEntriesSubscriber.php line 69

Open in your IDE?
  1. <?php
  3. /**
  4. * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5. * @license For full copyright and license information view LICENSE file distributed with this source code.
  6. */
  7. declare(strict_types=1);
  9. namespace Ibexa\Workflow\Event\Subscriber;
  11. use Ibexa\Contracts\Workflow\Event\TimelineEntryRenderEvent;
  12. use Ibexa\Contracts\Workflow\Event\TimelineEvent;
  13. use Ibexa\Contracts\Workflow\Event\TimelineEvents;
  14. use Ibexa\Contracts\Workflow\Registry\WorkflowDefinitionMetadataRegistryInterface;
  15. use Ibexa\Core\Base\Exceptions\BadStateException;
  16. use Ibexa\Workflow\Value\WorkflowDefinitionMetadata;
  17. use Ibexa\Workflow\WorkflowTimeline\Value\TransitionEntry;
  18. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  19. use Symfony\Component\Workflow\Transition;
  21. class TimelineTransitionEntriesSubscriber implements EventSubscriberInterface
  22. {
  23. /** @var \Ibexa\Contracts\Workflow\Registry\WorkflowDefinitionMetadataRegistryInterface */
  24. private $workflowDefinitionMetadataRegistry;
  26. /**
  27. * @param \Ibexa\Contracts\Workflow\Registry\WorkflowDefinitionMetadataRegistryInterface $workflowDefinitionMetadataRegistry
  28. */
  29. public function __construct(
  30. WorkflowDefinitionMetadataRegistryInterface $workflowDefinitionMetadataRegistry
  31. ) {
  32. $this->workflowDefinitionMetadataRegistry = $workflowDefinitionMetadataRegistry;
  33. }
  35. /**
  36. * {@inheritdoc}
  37. */
  38. public static function getSubscribedEvents(): array
  39. {
  40. return [
  41. TimelineEvents::COLLECT_ENTRIES => ['onEntriesCollect'],
  42. TimelineEvents::ENTRY_RENDER => ['onEntryRender'],
  43. ];
  44. }
  46. /**
  47. * @param \Ibexa\Contracts\Workflow\Event\TimelineEvent $event
  48. */
  49. public function onEntriesCollect(TimelineEvent $event): void
  50. {
  51. $workflowMetadata = $event->getWorkflowMetadata();
  53. foreach ($workflowMetadata->transitions as $transitionMetadata) {
  54. $event->addEntry(
  55. new TransitionEntry(
  56. $workflowMetadata,
  57. $transitionMetadata
  58. )
  59. );
  60. }
  61. }
  63. /**
  64. * @param \Ibexa\Contracts\Workflow\Event\TimelineEntryRenderEvent $event
  65. *
  66. * @throws \Ibexa\Workflow\Exception\NotFoundException
  67. * @throws \Ibexa\Contracts\Core\Repository\Exceptions\BadStateException
  68. */
  69. public function onEntryRender(TimelineEntryRenderEvent $event): void
  70. {
  71. /** @var \Ibexa\Workflow\WorkflowTimeline\Value\TransitionEntry $entry */
  72. $entry = $event->getEntry();
  74. if ($entry->getIdentifier() !== 'transition') {
  75. return;
  76. }
  78. $parameters = $event->getParameters();
  79. $workflowMetadata = $entry->getWorkflowMetadata();
  80. $definition = $workflowMetadata->workflow->getDefinition();
  82. $transitions = $definition->getTransitions();
  83. $transition = $this->findTransition($transitions, $entry->getTransitionMetadata()->name);
  85. $workflowDefinitionMetadata = $this->workflowDefinitionMetadataRegistry->getWorkflowMetadata($workflowMetadata->name);
  86. $transitionDefinitionMetadata = $workflowDefinitionMetadata->getTransitionMetadata($entry->getTransitionMetadata()->name);
  87. $stagesDefinitionMetadataList = $this->getStageDefinitionMetadataList($transition, $workflowDefinitionMetadata);
  88. $stageNames = $this->getStageNames($stagesDefinitionMetadataList);
  90. $parameters['workflow_definition_metadata'] = $workflowDefinitionMetadata;
  91. $parameters['transition_definition_metadata'] = $transitionDefinitionMetadata;
  92. $parameters['transition_metadata'] = $entry->getTransitionMetadata();
  93. $parameters['stages_definition_metadata_list'] = $stagesDefinitionMetadataList;
  94. $parameters['stage_names'] = $stageNames;
  96. $event->setParameters($parameters);
  97. }
  99. /**
  100. * @param \Symfony\Component\Workflow\Transition[] $transitions
  101. * @param string $name
  102. *
  103. * @return \Symfony\Component\Workflow\Transition
  104. *
  105. * @throws \Ibexa\Contracts\Core\Repository\Exceptions\BadStateException
  106. */
  107. private function findTransition(array $transitions, string $name): Transition
  108. {
  109. foreach ($transitions as $transition) {
  110. if ($transition->getName() === $name) {
  111. return $transition;
  112. }
  113. }
  115. throw new BadStateException('$transitions', "Could not find transition '{$name}'.");
  116. }
  118. /**
  119. * @param \Symfony\Component\Workflow\Transition $transition
  120. * @param \Ibexa\Workflow\Value\WorkflowDefinitionMetadata $workflowDefinitionMetadata
  121. *
  122. * @return \Ibexa\Workflow\Value\WorkflowStageDefinitionMetadata[]
  123. */
  124. private function getStageDefinitionMetadataList(
  125. Transition $transition,
  126. WorkflowDefinitionMetadata $workflowDefinitionMetadata
  127. ): array {
  128. return array_combine(
  129. $transition->getTos(),
  130. array_map([$workflowDefinitionMetadata, 'getStageMetadata'], $transition->getTos())
  131. );
  132. }
  134. /**
  135. * @param \Ibexa\Workflow\Value\WorkflowStageDefinitionMetadata[] $stagesDefinitionMetadataList
  136. *
  137. * @return string[]
  138. */
  139. private function getStageNames(array $stagesDefinitionMetadataList): array
  140. {
  141. $stageNames = [];
  142. foreach ($stagesDefinitionMetadataList as $key => $stageDefinitionMetadata) {
  143. $stageNames[$key] = $stageDefinitionMetadata->getLabel();
  144. }
  146. return $stageNames;
  147. }
  148. }
  150. class_alias(TimelineTransitionEntriesSubscriber::class, 'EzSystems\EzPlatformWorkflow\Event\Subscriber\TimelineTransitionEntriesSubscriber');