Add guard to block signatures on related entities without objects

Implemented a guard to prevent signatures on related entities that lack a stored object. It also includes corresponding tests and added translation for the error message in French.
This commit is contained in:
2024-11-12 18:14:30 +01:00
parent bfa58177e0
commit 79621e8ab7
5 changed files with 213 additions and 1 deletions

View File

@@ -61,6 +61,25 @@ class EntityWorkflowManager
return null;
}
/**
* Return true if the entityWorkflow may associate a stored object.
*
* Take care that, for various reasons, the method @see{getAssociatedStoredObject} may return null if, for
* various reasons, the associated stored object may not be retrieved.
*
* @return bool return true if the entityWorkflow may associate a stored object
*/
public function canAssociateStoredObject(EntityWorkflow $entityWorkflow): bool
{
foreach ($this->handlers as $handler) {
if ($handler instanceof EntityWorkflowWithStoredObjectHandlerInterface && $handler->supports($entityWorkflow)) {
return true;
}
}
return false;
}
/**
* @return list<EntityWorkflow>
*/

View File

@@ -0,0 +1,57 @@
<?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\Workflow\EntityWorkflow;
use Chill\MainBundle\Workflow\EntityWorkflowManager;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Workflow\Event\GuardEvent;
use Symfony\Component\Workflow\TransitionBlocker;
class BlockSignatureOnRelatedEntityWithoutAnyStoredObjectGuard implements EventSubscriberInterface
{
public function __construct(private EntityWorkflowManager $entityWorkflowManager) {}
public static function getSubscribedEvents()
{
return [
'workflow.guard' => [
['blockSignatureIfNoStoredObject', 0],
],
];
}
public function blockSignatureIfNoStoredObject(GuardEvent $event): void
{
$entityWorkflow = $event->getSubject();
if (!$entityWorkflow instanceof EntityWorkflow) {
return;
}
$metadataStore = $event->getWorkflow()->getMetadataStore();
foreach ($event->getTransition()->getTos() as $to) {
$placeMetadata = $metadataStore->getPlaceMetadata($to);
if ([] !== ($placeMetadata['isSignature'] ?? [])) {
if (!$this->entityWorkflowManager->canAssociateStoredObject($entityWorkflow)) {
$event->addTransitionBlocker(
new TransitionBlocker(
'workflow.May not associate a document',
'e8e28caa-a106-11ef-97e8-f3919e8b5c8a'
)
);
}
}
}
}
}

View File

@@ -33,7 +33,7 @@ class WorkflowNotificationHandler implements NotificationHandlerInterface
return [
'entity_workflow' => $entityWorkflow,
'handler' => null !== $entityWorkflow ? $this->entityWorkflowManager->getHandler($entityWorkflow): null,
'handler' => null !== $entityWorkflow ? $this->entityWorkflowManager->getHandler($entityWorkflow) : null,
'notificationCc' => $this->isNotificationCc($notification),
];
}