Add TelegramMessage::escapeMarkdown

sometimes we need to escape a part of a line, so TelegramMessage::escapedLine is not really suitable as it escapes the whole line.

Author: alies-dev

src/TelegramMessage.php

@@ -32,6 +32,16 @@ public static function create(string $content = ''): self
         return new self($content);
     }
 
+    /** @see https://core.telegram.org/bots/api#markdownv2-style */
+    public static function escapeMarkdown(string $content): ?string
+    {
+        return preg_replace_callback(
+            '/[_*[\]()~`>#\+\-=|{}.!]/',
+            fn ($matches): string => "\\$matches[0]",
+            $content
+        );
+    }
+
     public function content(string $content, ?int $limit = null): self
     {
         $this->payload['text'] = $content;
@@ -58,13 +68,9 @@ public function escapedLine(string $content): self
     {
         $content = str_replace('\\', '\\\\', $content);
 
-        $escapedContent = preg_replace_callback(
-            '/[_*[\]()~`>#\+\-=|{}.!]/',
-            fn ($matches): string => "\\$matches[0]",
-            $content
-        );
+        $escapedContent = self::escapeMarkdown($content) ?: $content;
 
-        return $this->line($escapedContent ?? $content);
+        return $this->line($escapedContent);
     }
 
     public function view(string $view, array $data = [], array $mergeData = []): self

tests/Feature/TelegramMessageTest.php

@@ -41,6 +41,27 @@
     expect($message->getPayloadValue('text'))->toEqual("Laravel Notification\_Channels are awesome\!\nTelegram Notification Channel is fantastic :)\n");
 });
 
+it('can escape markdown characters', function (string $input, string $expected) {
+    expect(TelegramMessage::escapeMarkdown($input))->toEqual($expected);
+})->with([
+    'special characters' => ['_*[]()~`>#+-=|{}.!', '\_\*\[\]\(\)\~\`\>\#\+\-\=\|\{\}\.\!'],
+    'a string with special characters' => ['Hello, _world_!', 'Hello, \_world\_\!'],
+    'a string with *' => ['*Hello, world!*', '\*Hello, world\!\*'],
+    'a string with []' => ['[Hello, world!]', '\[Hello, world\!\]'],
+    'a string with ()' => ['(Hello, world!)', '\(Hello, world\!\)'],
+    'a string with ~' => ['~Hello, world!~', '\~Hello, world\!\~'],
+    'a string with `' => ['`Hello, world!`', '\`Hello, world\!\`'],
+    'a string with >' => ['>Hello, world!', '\>Hello, world\!'],
+    'a string with #' => ['#Hello, world!', '\#Hello, world\!'],
+    'a string with +' => ['+Hello, world!', '\+Hello, world\!'],
+    'a string with -' => ['-Hello, world!', '\-Hello, world\!'],
+    'a string with =' => ['=Hello, world!', '\=Hello, world\!'],
+    'a string with |' => ['|Hello, world!', '\|Hello, world\!'],
+    'a string with {}' => ['{Hello, world!}', '\{Hello, world\!\}'],
+    'a string with .' => ['.Hello, world!', '\.Hello, world\!'],
+    'a string with !' => ['!Hello, world!', '\!Hello, world\!'],
+]);
+
 it('can attach a view as the content', function () {
     View::addLocation(__DIR__.'/../TestSupport');