feature #43139 [Notifier] Mattermost Notifier option to post in an other channel (nathanaelmartel)

fabpot · fabpot · commit f32af4683a04 · 2021-09-23T07:52:43.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [Notifier] Mattermost Notifier option to post in an other channel | Q | A | ------------- | --- | Branch? | 5.4 for features / 4.4 or 5.3 for bug fixes  | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | | License | MIT | Doc PR | symfony/symfony-docs#...  Commits ------- fdbb3d1 Mattermost Notifier option to post in an other channel
diff --git a/src/Symfony/Component/Notifier/Bridge/Mattermost/MattermostOptions.php b/src/Symfony/Component/Notifier/Bridge/Mattermost/MattermostOptions.php
@@ -0,0 +1,47 @@
+<?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\Mattermost;
+
+use Symfony\Component\Notifier\Message\MessageOptionsInterface;
+
+/**
+ * @author Nathanaël Martel <nat@nathanaelmartel.net>
+ */
+final class MattermostOptions implements MessageOptionsInterface
+{
+    private $options;
+
+    public function __construct(array $options = [])
+    {
+        $this->options = $options;
+    }
+
+    public function recipient(string $id): self
+    {
+        $this->options['recipient_id'] = $id;
+
+        return $this;
+    }
+
+    public function toArray(): array
+    {
+        $options = $this->options;
+        unset($options['recipient_id']);
+
+        return $options;
+    }
+
+    public function getRecipientId(): ?string
+    {
+        return $this->options['recipient_id'] ?? null;
+    }
+}
diff --git a/src/Symfony/Component/Notifier/Bridge/Mattermost/README.md b/src/Symfony/Component/Notifier/Bridge/Mattermost/README.md
@@ -7,14 +7,27 @@ DSN example
 -----------
 
 ```
-MATTERMOST_DSN=mattermost://ACCESS_TOKEN@HOST/PATH?channel=CHANNEL
+MATTERMOST_DSN=mattermost://ACCESS_TOKEN@HOST/PATH?channel=CHANNEL_ID
 ```
 
 where:
  - `ACCESS_TOKEN` is your Mattermost access token
  - `HOST` is your Mattermost host
  - `PATH` is your Mattermost sub-path (optional)
- - `CHANNEL` is your Mattermost channel
+ - `CHANNEL_ID` is your Mattermost default channel id
+
+Usage
+-----
+
+```
+// to post to another channel
+$options = new MattermostOptions();
+$options->recipient('{channel_id}');
+
+$message = (new ChatMessage($text))->options($options);
+
+$chatter->send($message);
+```
 
 Resources
 ---------
