Merge pull request #314 from TelegramBot/feature/botCommands

Add BotCommand type, setMyCommands and getMyCommands methods

Author: MyZik

src/BotApi.php

@@ -2,6 +2,7 @@
 
 namespace TelegramBot\Api;
 
+use TelegramBot\Api\Types\ArrayOfBotCommand;
 use TelegramBot\Api\Types\ArrayOfChatMemberEntity;
 use TelegramBot\Api\Types\ArrayOfMessageEntity;
 use TelegramBot\Api\Types\ArrayOfMessages;
@@ -1138,6 +1139,39 @@ public function answerCallbackQuery($callbackQueryId, $text = null, $showAlert =
         ]);
     }
 
+    /**
+     * Use this method to change the list of the bot's commands. Returns True on success.
+     *
+     * @param $commands
+     *
+     * @return mixed
+     * @throws Exception
+     * @throws HttpException
+     * @throws InvalidJsonException
+     */
+    public function setMyCommands($commands)
+    {
+        return $this->call(
+            'setMyCommands',
+            [
+                'commands' => json_encode($commands)
+            ]
+        );
+    }
+
+    /**
+     * Use this method to get the current list of the bot's commands. Requires no parameters.
+     * Returns Array of BotCommand on success.
+     *
+     * @return mixed
+     * @throws Exception
+     * @throws HttpException
+     * @throws InvalidJsonException
+     */
+    public function getMyCommands()
+    {
+        return ArrayOfBotCommand::fromResponse($this->call('getMyCommands'));
+    }
 
     /**
      * Use this method to edit text messages sent by the bot or via the bot

src/Types/ArrayOfBotCommand.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace TelegramBot\Api\Types;
+
+abstract class ArrayOfBotCommand
+{
+    public static function fromResponse($data)
+    {
+        $arrayOfBotCommand = [];
+        foreach ($data as $botCommand) {
+            $arrayOfBotCommand[] = BotCommand::fromResponse($botCommand);
+        }
+
+        return $arrayOfBotCommand;
+    }
+}

src/Types/BotCommand.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace TelegramBot\Api\Types;
+
+use TelegramBot\Api\BaseType;
+use TelegramBot\Api\TypeInterface;
+
+class BotCommand extends BaseType implements TypeInterface
+{
+    /**
+     * {@inheritdoc}
+     *
+     * @var array
+     */
+    static protected $requiredParams = ['command', 'description'];
+
+    /**
+     * {@inheritdoc}
+     *
+     * @var array
+     */
+    static protected $map = [
+        'command' => true,
+        'description' => true,
+    ];
+
+    /**
+     * Text of the command, 1-32 characters. Can contain only lowercase English letters, digits and underscores.
+     *
+     * @var string
+     */
+    protected $command;
+
+    /**
+     * Description of the command, 3-256 characters.
+     *
+     * @var string
+     */
+    protected $description;
+
+    /**
+     * @return string
+     */
+    public function getCommand()
+    {
+        return $this->command;
+    }
+
+    /**
+     * @param string $command
+     */
+    public function setCommand($command)
+    {
+        $this->command = $command;
+    }
+
+    /**
+     * @return string
+     */
+    public function getDescription()
+    {
+        return $this->description;
+    }
+
+    /**
+     * @param string $description
+     */
+    public function setDescription($description)
+    {
+        $this->description = $description;
+    }
+}

tests/BotCommandTest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace TelegramBot\Api\Test;
+
+use TelegramBot\Api\Types\BotCommand;
+
+class BotCommandTest extends \PHPUnit_Framework_TestCase
+{
+    public function testSetCommand()
+    {
+        $item = new BotCommand();
+        $item->setCommand('start');
+        $this->assertAttributeEquals('start', 'command', $item);
+    }
+
+    public function testGetCommand()
+    {
+        $item = new BotCommand();
+        $item->setCommand('start');
+        $this->assertEquals('start', $item->getCommand());
+    }
+
+    public function testSetDescription()
+    {
+        $item = new BotCommand();
+        $item->setDescription('This is a start command!');
+        $this->assertAttributeEquals('This is a start command!', 'description', $item);
+    }
+
+    public function testGetDescription()
+    {
+        $item = new BotCommand();
+        $item->setDescription('This is a start command!');
+        $this->assertEquals('This is a start command!', $item->getDescription());
+    }
+
+    public function testFromResponse()
+    {
+        $botCommand = BotCommand::fromResponse(
+            [
+                'command' => 'start',
+                'description' => 'This is a start command!',
+            ]
+        );
+
+        $this->assertInstanceOf('\TelegramBot\Api\Types\BotCommand', $botCommand);
+        $this->assertEquals('start', $botCommand->getCommand());
+        $this->assertEquals('This is a start command!', $botCommand->getDescription());
+    }
+}