Add static method Entity::parseMarkdownV2 to handle MarkdownV2.

Author: noplanman

CHANGELOG.md

@@ -9,7 +9,9 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
 ### Added
 - Replaced 'generic' and 'genericmessage' strings with Telegram::GENERIC_COMMAND and Telegram::GENERIC_MESSAGE_COMMAND constants (@1int)
 - Bot API 4.8 (Extra Poll and Dice features).
+- New static method `Entity::parseMarkdownV2` for MarkdownV2.
 ### Changed
+- Made `Entity::parseMarkdown` static, to not require an `Entity` object.
 ### Deprecated
 ### Removed
 ### Fixed

src/Entities/Entity.php

@@ -193,13 +193,15 @@ protected function makePrettyObjectArray($class, $property)
     }
 
     /**
-     * Escape markdown special characters
+     * Escape markdown (v1) special characters
+     *
+     * @see https://core.telegram.org/bots/api#markdown-style
      *
      * @param string $string
      *
      * @return string
      */
-    public function escapeMarkdown($string)
+    public static function escapeMarkdown($string)
     {
         return str_replace(
             ['[', '`', '*', '_',],
@@ -208,12 +210,32 @@ public function escapeMarkdown($string)
         );
     }
 
+    /**
+     * Escape markdown (v2) special characters
+     *
+     * @see https://core.telegram.org/bots/api#markdownv2-style
+     *
+     * @param string $string
+     *
+     * @return string
+     */
+    public static function escapeMarkdownV2($string)
+    {
+        return str_replace(
+            ['_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!'],
+            ['\_', '\*', '\[', '\]', '\(', '\)', '\~', '\`', '\>', '\#', '\+', '\-', '\=', '\|', '\{', '\}', '\.', '\!'],
+            $string
+        );
+    }
+
     /**
      * Try to mention the user
      *
      * Mention the user with the username otherwise print first and last name
      * if the $escape_markdown argument is true special characters are escaped from the output
      *
+     * @todo What about MarkdownV2?
+     *
      * @param bool $escape_markdown
      *
      * @return string|null
@@ -239,7 +261,7 @@ public function tryMention($escape_markdown = false)
         }
 
         if ($escape_markdown) {
-            $name = $this->escapeMarkdown($name);
+            $name = self::escapeMarkdown($name);
         }
 
         return ($is_username ? '@' : '') . $name;

tests/unit/Entities/EntityTest.php

@@ -0,0 +1,37 @@
+<?php
+
+/**
+ * This file is part of the TelegramBot package.
+ *
+ * (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Longman\TelegramBot\Tests\Unit;
+
+use Longman\TelegramBot\Entities\Entity;
+
+/**
+ * @link            https://github.com/php-telegram-bot/core
+ * @author          Baev Nikolay <[email protected]>
+ * @copyright       Avtandil Kikabidze <[email protected]>
+ * @license         http://opensource.org/licenses/mit-license.php  The MIT License (MIT)
+ * @package         TelegramTest
+ */
+class EntityTest extends TestCase
+{
+    public function testEscapeMarkdown()
+    {
+        // Make sure all characters that need escaping are escaped.
+
+        // Markdown V1
+        self::assertEquals('\[\`\*\_', Entity::escapeMarkdown('[`*_'));
+        self::assertEquals('\*mark\*\_down\_~test~', Entity::escapeMarkdown('*mark*_down_~test~'));
+
+        // Markdown V2
+        self::assertEquals('\_\*\[\]\(\)\~\`\>\#\+\-\=\|\{\}\.\!', Entity::escapeMarkdownV2('_*[]()~`>#+-=|{}.!'));
+        self::assertEquals('\*mark\*\_down\_\~test\~', Entity::escapeMarkdownV2('*mark*_down_~test~'));
+    }
+}

tests/unit/Entities/UserTest.php

@@ -65,9 +65,6 @@ public function testEscapeMarkdown()
         $user = new User(['id' => 1, 'first_name' => 'John', 'last_name' => '`Taylor`']);
         self::assertEquals('John `Taylor`', $user->tryMention());
         self::assertEquals('John \`Taylor\`', $user->tryMention(true));
-
-        // Plain escapeMarkdown functionality.
-        self::assertEquals('a\`b\[c\*d\_e', $user->escapeMarkdown('a`b[c*d_e'));
     }
 
     public function testGetProperties()