mirror of
https://gitlab.com/Chill-Projet/chill-bundles.git
synced 2025-06-12 13:24:25 +00:00
Julien Fastré
7f3de62b2c
The main update is in the setStep method of EntityWorkflow, where parameters are added to capture the transition details. These include the exact transition, the user who made the transition and the time of transition. The WorkflowController extracts this information and put it into the transition's context. The MarkingStore transfer it to the EntityWorkflow::setStep method, and all metadata are recorded within the entities themselve.
121 lines
4.0 KiB
PHP
121 lines
4.0 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/*
|
|
* Chill is a software for social workers
|
|
*
|
|
* For the full copyright and license information, please view
|
|
* the LICENSE file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Chill\MainBundle\Workflow\EventSubscriber;
|
|
|
|
use Chill\MainBundle\Entity\User;
|
|
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
|
|
use Chill\MainBundle\Templating\Entity\UserRender;
|
|
use Psr\Log\LoggerInterface;
|
|
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
|
use Symfony\Component\Security\Core\Security;
|
|
use Symfony\Component\Workflow\Event\Event;
|
|
use Symfony\Component\Workflow\Event\GuardEvent;
|
|
use Symfony\Component\Workflow\TransitionBlocker;
|
|
|
|
final readonly class EntityWorkflowTransitionEventSubscriber implements EventSubscriberInterface
|
|
{
|
|
public function __construct(
|
|
private LoggerInterface $chillLogger,
|
|
private Security $security,
|
|
private UserRender $userRender
|
|
) {}
|
|
|
|
public static function getSubscribedEvents(): array
|
|
{
|
|
return [
|
|
'workflow.transition' => 'onTransition',
|
|
'workflow.completed' => [
|
|
['markAsFinal', 2048],
|
|
],
|
|
'workflow.guard' => [
|
|
['guardEntityWorkflow', 0],
|
|
],
|
|
];
|
|
}
|
|
|
|
public function guardEntityWorkflow(GuardEvent $event)
|
|
{
|
|
if (!$event->getSubject() instanceof EntityWorkflow) {
|
|
return;
|
|
}
|
|
|
|
/** @var EntityWorkflow $entityWorkflow */
|
|
$entityWorkflow = $event->getSubject();
|
|
|
|
if ($entityWorkflow->isFinal()) {
|
|
$event->addTransitionBlocker(
|
|
new TransitionBlocker(
|
|
'workflow.The workflow is finalized',
|
|
'd6306280-7535-11ec-a40d-1f7bee26e2c0'
|
|
)
|
|
);
|
|
|
|
return;
|
|
}
|
|
|
|
if (!$entityWorkflow->getCurrentStep()->getAllDestUser()->contains($this->security->getUser())) {
|
|
if (!$event->getMarking()->has('initial')) {
|
|
$event->addTransitionBlocker(new TransitionBlocker(
|
|
'workflow.You are not allowed to apply a transition on this workflow. Only those users are allowed: %users%',
|
|
'f3eeb57c-7532-11ec-9495-e7942a2ac7bc',
|
|
[
|
|
'%users%' => implode(
|
|
', ',
|
|
$entityWorkflow->getCurrentStep()->getAllDestUser()->map(fn (User $u) => $this->userRender->renderString($u, []))->toArray()
|
|
),
|
|
]
|
|
));
|
|
}
|
|
}
|
|
}
|
|
|
|
public function markAsFinal(Event $event): void
|
|
{
|
|
// NOTE: it is not possible to move this method to the marking store, because
|
|
// there is dependency between the Workflow definition and the MarkingStoreInterface (the workflow
|
|
// constructor need a MarkingStoreInterface)
|
|
|
|
if (!$event->getSubject() instanceof EntityWorkflow) {
|
|
return;
|
|
}
|
|
|
|
/** @var EntityWorkflow $entityWorkflow */
|
|
$entityWorkflow = $event->getSubject();
|
|
$step = $entityWorkflow->getCurrentStep();
|
|
|
|
$placeMetadata = $event->getWorkflow()->getMetadataStore()
|
|
->getPlaceMetadata($step->getCurrentStep());
|
|
|
|
if (\array_key_exists('isFinal', $placeMetadata) && true === $placeMetadata['isFinal']) {
|
|
$step->setIsFinal(true);
|
|
}
|
|
}
|
|
|
|
public function onTransition(Event $event): void
|
|
{
|
|
if (!$event->getSubject() instanceof EntityWorkflow) {
|
|
return;
|
|
}
|
|
|
|
/** @var EntityWorkflow $entityWorkflow */
|
|
$entityWorkflow = $event->getSubject();
|
|
|
|
$this->chillLogger->info('[workflow] apply transition on entityWorkflow', [
|
|
'relatedEntityClass' => $entityWorkflow->getRelatedEntityClass(),
|
|
'relatedEntityId' => $entityWorkflow->getRelatedEntityId(),
|
|
'transition' => $event->getTransition()->getName(),
|
|
'by_user' => $this->security->getUser(),
|
|
'entityWorkflow' => $entityWorkflow->getId(),
|
|
]);
|
|
}
|
|
}
|