[Notifier] [Slack] Add button block element and emoji/verbatim options to section block

Author: cvergne

src/Symfony/Component/Notifier/Bridge/Slack/Block/SlackActionsBlock.php

@@ -30,21 +30,9 @@ public function button(string $text, string $url, ?string $style = null): static
             throw new \LogicException('Maximum number of buttons should not exceed 25.');
         }
 
-        $element = [
-            'type' => 'button',
-            'text' => [
-                'type' => 'plain_text',
-                'text' => $text,
-            ],
-            'url' => $url,
-        ];
+        $element = new SlackButtonBlockElement($text, $url, $style);
 
-        if ($style) {
-            // primary or danger
-            $element['style'] = $style;
-        }
-
-        $this->options['elements'][] = $element;
+        $this->options['elements'][] = $element->toArray();
 
         return $this;
     }

src/Symfony/Component/Notifier/Bridge/Slack/Block/SlackButtonBlockElement.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Notifier\Bridge\Slack\Block;
+
+/**
+ * @author Christophe Vergne <christophe.vergne@gmail.com>
+ */
+final class SlackButtonBlockElement extends AbstractSlackBlockElement
+{
+    public function __construct(string $text, string $url, ?string $style = null)
+    {
+        $this->options = [
+            'type' => 'button',
+            'text' => [
+                'type' => 'plain_text',
+                'text' => $text,
+            ],
+            'url' => $url,
+        ];
+
+        if ($style) {
+            // primary or danger
+            $this->options['style'] = $style;
+        }
+    }
+}

src/Symfony/Component/Notifier/Bridge/Slack/Block/SlackSectionBlock.php

@@ -24,30 +24,46 @@ public function __construct()
     /**
      * @return $this
      */
-    public function text(string $text, bool $markdown = true): static
+    public function text(string $text, bool $markdown = true, bool $emoji = true, bool $verbatim = false): static
     {
         $this->options['text'] = [
             'type' => $markdown ? 'mrkdwn' : 'plain_text',
             'text' => $text,
         ];
 
+        // verbatim is only available for markdown
+        if ($markdown) {
+            $this->options['text']['verbatim'] = $verbatim;
+        } else {
+            $this->options['text']['emoji'] = $emoji;
+        }
+
         return $this;
     }
 
     /**
      * @return $this
      */
-    public function field(string $text, bool $markdown = true): static
+    public function field(string $text, bool $markdown = true, bool $emoji = true, bool $verbatim = false): static
     {
         if (10 === \count($this->options['fields'] ?? [])) {
             throw new \LogicException('Maximum number of fields should not exceed 10.');
         }
 
-        $this->options['fields'][] = [
+        $field = [
             'type' => $markdown ? 'mrkdwn' : 'plain_text',
             'text' => $text,
         ];
 
+        // verbatim is only available for markdown
+        if ($markdown) {
+            $field['verbatim'] = $verbatim;
+        } else {
+            $field['emoji'] = $emoji;
+        }
+
+        $this->options['fields'][] = $field;
+
         return $this;
     }
 

src/Symfony/Component/Notifier/Bridge/Slack/CHANGELOG.md

@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+7.2
+---
+
+ * Add `SlackButtonBlockElement` to add button as accessory to a section block
+ * Add `emoji` and `verbatim` options to `text` and `field` methods in `SlackSectionBlock`
+
 6.3
 ---
 

src/Symfony/Component/Notifier/Bridge/Slack/Tests/Block/SlackSectionBlockTest.php

@@ -22,18 +22,32 @@ public function testCanBeInstantiated()
         $section = new SlackSectionBlock();
         $section->text('section text');
         $section->field('section field');
+        $section->field('section field with verbatim', true, true, false);
+        $section->field('section field in plain text with verbatim', false, true, true);
         $section->accessory(new SlackImageBlockElement('https://example.com/image.jpg', 'an image'));
 
         $this->assertSame([
             'type' => 'section',
             'text' => [
                 'type' => 'mrkdwn',
                 'text' => 'section text',
+                'verbatim' => false,
             ],
             'fields' => [
                 [
                     'type' => 'mrkdwn',
                     'text' => 'section field',
+                    'verbatim' => false,
+                ],
+                [
+                    'type' => 'mrkdwn',
+                    'text' => 'section field with verbatim',
+                    'verbatim' => false,
+                ],
+                [
+                    'type' => 'plain_text',
+                    'text' => 'section field in plain text with verbatim',
+                    'emoji' => true,
                 ],
             ],
             'accessory' => [

src/Symfony/Component/Notifier/Bridge/Slack/Tests/SlackOptionsTest.php

@@ -146,6 +146,7 @@ public static function fromNotificationProvider(): iterable
                         'text' => [
                             'type' => 'mrkdwn',
                             'text' => $subject,
+                            'verbatim' => false,
                         ],
                     ],
                 ],
@@ -162,13 +163,15 @@ public static function fromNotificationProvider(): iterable
                         'text' => [
                             'type' => 'mrkdwn',
                             'text' => $subject,
+                            'verbatim' => false,
                         ],
                     ],
                     [
                         'type' => 'section',
                         'text' => [
                             'type' => 'mrkdwn',
                             'text' => $content,
+                            'verbatim' => false,
                         ],
                     ],
                 ],