[Notifier] Add support for confirm option in Slack buttons API

Taras Hinyk · fabpot · commit c9602f0230f3 · 2025-10-12T08:58:50.000+02:00
diff --git a/src/Symfony/Component/Notifier/Bridge/Slack/Block/SlackActionsBlock.php b/src/Symfony/Component/Notifier/Bridge/Slack/Block/SlackActionsBlock.php
@@ -24,13 +24,13 @@ public function __construct()
     /**
      * @return $this
      */
-    public function button(string $text, ?string $url = null, ?string $style = null, ?string $value = null): static
+    public function button(string $text, ?string $url = null, ?string $style = null, ?string $value = null, ?array $confirm = null): static
     {
         if (25 === \count($this->options['elements'] ?? [])) {
             throw new \LogicException('Maximum number of buttons should not exceed 25.');
         }
 
-        $element = new SlackButtonBlockElement($text, $url, $style, $value);
+        $element = new SlackButtonBlockElement($text, $url, $style, $value, $confirm);
 
         $this->options['elements'][] = $element->toArray();
 
diff --git a/src/Symfony/Component/Notifier/Bridge/Slack/Block/SlackButtonBlockElement.php b/src/Symfony/Component/Notifier/Bridge/Slack/Block/SlackButtonBlockElement.php
@@ -16,7 +16,7 @@
  */
 final class SlackButtonBlockElement extends AbstractSlackBlockElement
 {
-    public function __construct(string $text, ?string $url = null, ?string $style = null, ?string $value = null)
+    public function __construct(string $text, ?string $url = null, ?string $style = null, ?string $value = null, ?array $confirm = null)
     {
         $this->options = [
             'type' => 'button',
@@ -38,5 +38,9 @@ public function __construct(string $text, ?string $url = null, ?string $style =
         if ($value) {
             $this->options['value'] = $value;
         }
+
+        if ($confirm) {
+            $this->options['confirm'] = $confirm;
+        }
     }
 }
diff --git a/src/Symfony/Component/Notifier/Bridge/Slack/CHANGELOG.md b/src/Symfony/Component/Notifier/Bridge/Slack/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.4
+---
+
+ * Add `confirm` option to `button` method in `SlackActionsBlock` block
+
 7.2
 ---
 
diff --git a/src/Symfony/Component/Notifier/Bridge/Slack/README.md b/src/Symfony/Component/Notifier/Bridge/Slack/README.md
@@ -52,7 +52,14 @@ $contributeToSymfonyBlocks = (new SlackActionsBlock())
     ->button(
         'Report bugs',
         'https://symfony.com/doc/current/contributing/code/bugs.html',
-        'danger'
+        'danger',
+        null,
+        [
+            'title' => ['type' => 'plaint_text', 'text' => 'Report a bug'],
+            'text' => ['type' => 'plaint_text', 'text' => 'By proceeding I confirm I\'ve read the guidelines.'],
+            'confirm' => ['type' => 'plaint_text', 'text' => 'Proceed'],
+            'deny' => ['type' => 'plaint_text', 'text' => 'Go back to reading']
+        ]
     );
 
 $slackOptions = (new SlackOptions())
diff --git a/src/Symfony/Component/Notifier/Bridge/Slack/Tests/Block/SlackActionsBlockTest.php b/src/Symfony/Component/Notifier/Bridge/Slack/Tests/Block/SlackActionsBlockTest.php
@@ -22,6 +22,31 @@ public function testCanBeInstantiated()
         $actions->button('first button text', 'https://example.org', null, 'test-value')
             ->button('second button text', 'https://example.org/slack', 'danger')
             ->button('third button text', null, null, 'test-value-3')
+            ->button(
+                'fourth button text',
+                null,
+                null,
+                'test-value-4',
+                [
+                    'title' => [
+                        'type' => 'plain_text',
+                        'text' => 'test-confirm-title-4',
+                    ],
+                    'text' => [
+                        'type' => 'plain_text',
+                        'text' => 'test-confirm-text-4',
+                    ],
+                    'confirm' => [
+                        'type' => 'plain_text',
+                        'text' => 'test-confirm-confirm-4',
+                    ],
+                    'deny' => [
+                        'type' => 'plain_text',
+                        'text' => 'test-confirm-deny-4',
+                    ],
+                    'style' => 'danger',
+                ]
+            )
         ;
 
         $this->assertSame([
@@ -53,6 +78,33 @@ public function testCanBeInstantiated()
                     ],
                     'value' => 'test-value-3',
                 ],
+                [
+                    'type' => 'button',
+                    'text' => [
+                        'type' => 'plain_text',
+                        'text' => 'fourth button text',
+                    ],
+                    'value' => 'test-value-4',
+                    'confirm' => [
+                        'title' => [
+                            'type' => 'plain_text',
+                            'text' => 'test-confirm-title-4',
+                        ],
+                        'text' => [
+                            'type' => 'plain_text',
+                            'text' => 'test-confirm-text-4',
+                        ],
+                        'confirm' => [
+                            'type' => 'plain_text',
+                            'text' => 'test-confirm-confirm-4',
+                        ],
+                        'deny' => [
+                            'type' => 'plain_text',
+                            'text' => 'test-confirm-deny-4',
+                        ],
+                        'style' => 'danger',
+                    ],
+                ],
             ],
         ], $actions->toArray());
     }

Original file line number	Diff line number	Diff line change
`@@ -24,13 +24,13 @@ public function __construct()`
`24`	`24`	`/**`
`25`	`25`	`* @return $this`
`26`	`26`	`*/`
`27`		`- public function button(string $text, ?string $url = null, ?string $style = null, ?string $value = null): static`
	`27`	`+ public function button(string $text, ?string $url = null, ?string $style = null, ?string $value = null, ?array $confirm = null): static`
`28`	`28`	`{`
`29`	`29`	`if (25 === \count($this->options['elements'] ?? [])) {`
`30`	`30`	`throw new \LogicException('Maximum number of buttons should not exceed 25.');`
`31`	`31`	`}`
`32`	`32`
`33`		`- $element = new SlackButtonBlockElement($text, $url, $style, $value);`
	`33`	`+ $element = new SlackButtonBlockElement($text, $url, $style, $value, $confirm);`
`34`	`34`
`35`	`35`	`$this->options['elements'][] = $element->toArray();`
`36`	`36`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`*/`
`17`	`17`	`final class SlackButtonBlockElement extends AbstractSlackBlockElement`
`18`	`18`	`{`
`19`		`- public function __construct(string $text, ?string $url = null, ?string $style = null, ?string $value = null)`
	`19`	`+ public function __construct(string $text, ?string $url = null, ?string $style = null, ?string $value = null, ?array $confirm = null)`
`20`	`20`	`{`
`21`	`21`	`$this->options = [`
`22`	`22`	`'type' => 'button',`
`@@ -38,5 +38,9 @@ public function __construct(string $text, ?string $url = null, ?string $style =`
`38`	`38`	`if ($value) {`
`39`	`39`	`$this->options['value'] = $value;`
`40`	`40`	`}`
	`41`	`+`
	`42`	`+ if ($confirm) {`
	`43`	`+ $this->options['confirm'] = $confirm;`
	`44`	`+ }`
`41`	`45`	`}`
`42`	`46`	`}`