Custom notification message

loic425 · loic425 · commit e7040eaca86a · 2025-02-28T09:45:03.000+01:00
diff --git a/src/Component/spec/Symfony/Session/Flash/FlashHelperSpec.php b/src/Component/spec/Symfony/Session/Flash/FlashHelperSpec.php
@@ -91,6 +91,31 @@ function it_adds_success_flashes_with_fallback_message(
         $this->addSuccessFlash($operation, $context);
     }
 
+    function it_adds_success_flashes_with_custom_message(
+        Request $request,
+        SessionInterface $session,
+        FlashBagInterface $flashBag,
+        TranslatorBagInterface $translator,
+        MessageCatalogueInterface $messageCatalogue,
+    ): void {
+        $operation = (new Create(notificationMessage: 'app.dummy.shipped'))->withResource(new ResourceMetadata(alias: 'app.dummy', name: 'dummy', applicationName: 'app'));
+        $context = new Context(new RequestOption($request->getWrappedObject()));
+
+        $request->getSession()->willReturn($session);
+
+        $session->getBag('flashes')->willReturn($flashBag);
+
+        $translator->getCatalogue()->willReturn($messageCatalogue);
+
+        $messageCatalogue->has('app.dummy.shipped', 'flashes')->willReturn(true)->shouldBeCalled();
+
+        $translator->trans('app.dummy.shipped', ['%resource%' => 'Dummy'], 'flashes')->willReturn('Dummy was shipped successfully.')->shouldBeCalled();
+
+        $flashBag->add('success', 'Dummy was shipped successfully.')->shouldBeCalled();
+
+        $this->addSuccessFlash($operation, $context);
+    }
+
     function it_adds_success_flashes_with_default_message_when_translator_is_not_a_bag(
         Request $request,
         SessionInterface $session,
diff --git a/src/Component/src/Metadata/Api/Delete.php b/src/Component/src/Metadata/Api/Delete.php
@@ -45,6 +45,7 @@ public function __construct(
         ?array $denormalizationContext = null,
         ?array $validationContext = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         ?string $redirectToRoute = null,
     ) {
         parent::__construct(
@@ -71,6 +72,7 @@ public function __construct(
             denormalizationContext: $denormalizationContext,
             validationContext: $validationContext,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
             redirectToRoute: $redirectToRoute,
         );
     }
diff --git a/src/Component/src/Metadata/Api/Get.php b/src/Component/src/Metadata/Api/Get.php
@@ -45,6 +45,7 @@ public function __construct(
         ?array $denormalizationContext = null,
         ?array $validationContext = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         ?string $redirectToRoute = null,
     ) {
         parent::__construct(
@@ -71,6 +72,7 @@ public function __construct(
             denormalizationContext: $denormalizationContext,
             validationContext: $validationContext,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
             redirectToRoute: $redirectToRoute,
         );
     }
diff --git a/src/Component/src/Metadata/Api/GetCollection.php b/src/Component/src/Metadata/Api/GetCollection.php
@@ -45,6 +45,7 @@ public function __construct(
         ?array $denormalizationContext = null,
         ?array $validationContext = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         ?string $redirectToRoute = null,
     ) {
         parent::__construct(
@@ -71,6 +72,7 @@ public function __construct(
             denormalizationContext: $denormalizationContext,
             validationContext: $validationContext,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
             redirectToRoute: $redirectToRoute,
         );
     }
diff --git a/src/Component/src/Metadata/Api/Patch.php b/src/Component/src/Metadata/Api/Patch.php
@@ -45,6 +45,7 @@ public function __construct(
         ?array $denormalizationContext = null,
         ?array $validationContext = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         ?string $redirectToRoute = null,
     ) {
         parent::__construct(
@@ -71,6 +72,7 @@ public function __construct(
             denormalizationContext: $denormalizationContext,
             validationContext: $validationContext,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
             redirectToRoute: $redirectToRoute,
         );
     }
diff --git a/src/Component/src/Metadata/Api/Post.php b/src/Component/src/Metadata/Api/Post.php
@@ -45,6 +45,7 @@ public function __construct(
         ?array $denormalizationContext = null,
         ?array $validationContext = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         ?string $redirectToRoute = null,
     ) {
         parent::__construct(
@@ -71,6 +72,7 @@ public function __construct(
             denormalizationContext: $denormalizationContext,
             validationContext: $validationContext,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
             redirectToRoute: $redirectToRoute,
         );
     }
diff --git a/src/Component/src/Metadata/Api/Put.php b/src/Component/src/Metadata/Api/Put.php
@@ -45,6 +45,7 @@ public function __construct(
         ?array $denormalizationContext = null,
         ?array $validationContext = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         ?string $redirectToRoute = null,
     ) {
         parent::__construct(
@@ -71,6 +72,7 @@ public function __construct(
             denormalizationContext: $denormalizationContext,
             validationContext: $validationContext,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
             redirectToRoute: $redirectToRoute,
         );
     }
diff --git a/src/Component/src/Metadata/ApplyStateMachineTransition.php b/src/Component/src/Metadata/ApplyStateMachineTransition.php
@@ -36,6 +36,7 @@ public function __construct(
         ?bool $validate = null,
         ?string $formType = null,
         ?array $formOptions = null,
+        ?string $notificationMessage = null,
         ?string $redirectToRoute = null,
         private ?string $stateMachineComponent = null,
         private ?string $stateMachineTransition = null,
@@ -58,6 +59,7 @@ public function __construct(
             validate: $validate ?? false,
             formType: $formType,
             formOptions: $formOptions,
+            notificationMessage: $notificationMessage,
             redirectToRoute: $redirectToRoute,
         );
     }
diff --git a/src/Component/src/Metadata/BulkDelete.php b/src/Component/src/Metadata/BulkDelete.php
@@ -37,6 +37,7 @@ public function __construct(
         ?string $formType = null,
         ?array $formOptions = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         ?string $redirectToRoute = null,
         ?array $redirectArguments = null,
         ?array $vars = null,
@@ -59,6 +60,7 @@ public function __construct(
             formType: $formType,
             formOptions: $formOptions,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
             redirectToRoute: $redirectToRoute,
             redirectArguments: $redirectArguments,
             vars: $vars,
diff --git a/src/Component/src/Metadata/BulkUpdate.php b/src/Component/src/Metadata/BulkUpdate.php
@@ -41,6 +41,7 @@ public function __construct(
         ?array $formOptions = null,
         ?array $validationContext = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         ?string $redirectToRoute = null,
         ?array $redirectArguments = null,
         ?array $vars = null,
@@ -70,6 +71,7 @@ public function __construct(
             formOptions: $formOptions,
             validationContext: $validationContext,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
             redirectToRoute: $redirectToRoute,
             redirectArguments: $redirectArguments,
             vars: $vars,
diff --git a/src/Component/src/Metadata/Create.php b/src/Component/src/Metadata/Create.php
@@ -47,6 +47,7 @@ public function __construct(
         ?array $formOptions = null,
         ?array $validationContext = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         string|callable|null $twigContextFactory = null,
         ?string $redirectToRoute = null,
         ?array $redirectArguments = null,
@@ -77,6 +78,7 @@ public function __construct(
             formOptions: $formOptions,
             validationContext: $validationContext,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
             twigContextFactory: $twigContextFactory,
             redirectToRoute: $redirectToRoute,
             redirectArguments: $redirectArguments,
diff --git a/src/Component/src/Metadata/Delete.php b/src/Component/src/Metadata/Delete.php
@@ -41,6 +41,7 @@ public function __construct(
         ?array $formOptions = null,
         ?array $validationContext = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         string|callable|null $twigContextFactory = null,
         ?string $redirectToRoute = null,
         ?array $redirectArguments = null,
@@ -68,6 +69,7 @@ public function __construct(
             formOptions: $formOptions,
             validationContext: $validationContext,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
             twigContextFactory: $twigContextFactory,
             redirectToRoute: $redirectToRoute,
             redirectArguments: $redirectArguments,
diff --git a/src/Component/src/Metadata/HttpOperation.php b/src/Component/src/Metadata/HttpOperation.php
@@ -46,6 +46,7 @@ public function __construct(
         ?array $denormalizationContext = null,
         ?array $validationContext = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         string|callable|null $twigContextFactory = null,
         protected ?string $redirectToRoute = null,
         protected ?array $redirectArguments = null,
@@ -72,6 +73,7 @@ public function __construct(
             denormalizationContext: $denormalizationContext,
             validationContext: $validationContext,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
         );
 
         $this->twigContextFactory = $twigContextFactory;
diff --git a/src/Component/src/Metadata/Index.php b/src/Component/src/Metadata/Index.php
@@ -40,6 +40,7 @@ public function __construct(
         ?string $formType = null,
         ?array $formOptions = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         ?array $validationContext = null,
         string|callable|null $twigContextFactory = null,
         ?string $redirectToRoute = null,
@@ -68,6 +69,7 @@ public function __construct(
             formOptions: $formOptions,
             validationContext: $validationContext,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
             twigContextFactory: $twigContextFactory,
             redirectToRoute: $redirectToRoute,
             vars: $vars,
diff --git a/src/Component/src/Metadata/Operation.php b/src/Component/src/Metadata/Operation.php
@@ -53,6 +53,7 @@ public function __construct(
         protected ?array $denormalizationContext = null,
         protected ?array $validationContext = null,
         protected ?string $eventShortName = null,
+        protected ?string $notificationMessage = null,
     ) {
         $this->provider = $provider;
         $this->processor = $processor;
@@ -332,4 +333,17 @@ public function withEventShortName(string $eventShortName): self
 
         return $self;
     }
+
+    public function getNotificationMessage(): ?string
+    {
+        return $this->notificationMessage;
+    }
+
+    public function withNotificationMessage(string $notificationMessage): self
+    {
+        $self = clone $this;
+        $self->notificationMessage = $notificationMessage;
+
+        return $self;
+    }
 }
diff --git a/src/Component/src/Metadata/Show.php b/src/Component/src/Metadata/Show.php
@@ -41,6 +41,7 @@ public function __construct(
         ?array $formOptions = null,
         ?array $validationContext = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         string|callable|null $twigContextFactory = null,
         ?string $redirectToRoute = null,
         ?array $vars = null,
@@ -67,6 +68,7 @@ public function __construct(
             formOptions: $formOptions,
             validationContext: $validationContext,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
             twigContextFactory: $twigContextFactory,
             redirectToRoute: $redirectToRoute,
             vars: $vars,
diff --git a/src/Component/src/Metadata/Update.php b/src/Component/src/Metadata/Update.php
@@ -41,6 +41,7 @@ public function __construct(
         ?array $formOptions = null,
         ?array $validationContext = null,
         ?string $eventShortName = null,
+        ?string $notificationMessage = null,
         string|callable|null $twigContextFactory = null,
         ?string $redirectToRoute = null,
         ?array $redirectArguments = null,
@@ -71,6 +72,7 @@ public function __construct(
             formOptions: $formOptions,
             validationContext: $validationContext,
             eventShortName: $eventShortName,
+            notificationMessage: $notificationMessage,
             twigContextFactory: $twigContextFactory,
             redirectToRoute: $redirectToRoute,
             redirectArguments: $redirectArguments,
diff --git a/src/Component/src/Symfony/Session/Flash/FlashHelper.php b/src/Component/src/Symfony/Session/Flash/FlashHelper.php
@@ -74,7 +74,7 @@ private function buildOperationMessage(Operation $operation, string $type): stri
         $resource = $operation->getResource();
         Assert::notNull($resource);
 
-        $key = sprintf('%s.%s.%s', $resource->getApplicationName() ?? '', $resource->getName() ?? '', $operation->getShortName() ?? '');
+        $key = $operation->getNotificationMessage() ?? sprintf('%s.%s.%s', $resource->getApplicationName() ?? '', $resource->getName() ?? '', $operation->getShortName() ?? '');
         $fallbackKey = sprintf('sylius.resource.%s', $operation->getShortName() ?? '');
 
         $parameters = $this->getTranslationParameters($operation);
diff --git a/tests/Bundle/Command/DebugResourceCommandTest.php b/tests/Bundle/Command/DebugResourceCommandTest.php
@@ -308,6 +308,7 @@ public function it_displays_the_metadata_for_given_resource_operation(): void
               denormalizationContext   null                      
               validationContext        null                      
               eventShortName           "register"                
+              notificationMessage      null                      
              ------------------------ -------------------------- 
             
             
