Merge pull request #430 from lichtscheu/master

add functionality to allow hiding commands in /help command

Author: noplanman

src/Commands/Command.php

@@ -59,6 +59,13 @@ abstract class Command
      */
     protected $usage = 'Command usage';
 
+    /**
+     * Show in Help
+     *
+     * @var bool
+     */
+    protected $show_in_help = true;
+
     /**
      * Version
      *
@@ -252,6 +259,16 @@ public function getName()
         return $this->name;
     }
 
+    /**
+     * Get Show in Help
+     *
+     * @return bool
+     */
+    public function showInHelp()
+    {
+        return $this->show_in_help;
+    }
+
     /**
      * Check if command is enabled
      *

src/Commands/UserCommands/HelpCommand.php

@@ -69,6 +69,10 @@ public function execute()
             );
 
             foreach ($command_objs as $command) {
+                if (!$command->showInHelp()) {
+                    continue;
+                }
+
                 $text .= sprintf(
                     '/%s - %s' . PHP_EOL,
                     $command->getName(),

tests/unit/Commands/CommandTest.php

@@ -127,6 +127,12 @@ public function testDefaultCommandIsEnabled()
         $this->assertTrue($this->command_stub->isEnabled());
     }
 
+    public function testDefaultCommandShownInHelp()
+    {
+        $this->assertAttributeEquals(true, 'show_in_help', $this->command_stub);
+        $this->assertTrue($this->command_stub->showInHelp());
+    }
+
     public function testDefaultCommandNeedsMysql()
     {
         $this->assertAttributeEquals(false, 'need_mysql', $this->command_stub);

tests/unit/Commands/CommandTestCase.php

@@ -39,6 +39,9 @@ public function setUp()
     {
         $this->telegram = new Telegram('apikey', 'testbot');
         $this->telegram->addCommandsPath(BASE_COMMANDS_PATH . '/UserCommands');
+
+        // Add custom commands dedicated to do some tests.
+        $this->telegram->addCommandsPath(__DIR__ . '/CustomTestCommands');
         $this->telegram->getCommandsList();
     }
 

tests/unit/Commands/CustomTestCommands/HiddenCommand.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * This file is part of the TelegramBot package.
+ *
+ * (c) Avtandil Kikabidze aka LONGMAN <akalongman@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Longman\TelegramBot\Commands\UserCommands;
+
+use Longman\TelegramBot\Commands\UserCommand;
+use Longman\TelegramBot\Request;
+
+/**
+ * Test "/hidden" command to test $show_in_help
+ */
+class HiddenCommand extends UserCommand
+{
+    /**
+     * @var string
+     */
+    protected $name = 'hidden';
+
+    /**
+     * @var string
+     */
+    protected $description = 'This command is hidden in help';
+
+    /**
+     * @var string
+     */
+    protected $usage = '/hidden';
+
+    /**
+     * @var string
+     */
+    protected $version = '1.0.0';
+
+    /**
+     * @var bool
+     */
+    protected $show_in_help = false;
+
+    /**
+     * Command execute method
+     *
+     * @return mixed
+     * @throws \Longman\TelegramBot\Exception\TelegramException
+     */
+    public function execute()
+    {
+        return Request::emptyResponse();
+    }
+}

tests/unit/Commands/CustomTestCommands/VisibleCommand.php

@@ -0,0 +1,56 @@
+<?php
+/**
+ * This file is part of the TelegramBot package.
+ *
+ * (c) Avtandil Kikabidze aka LONGMAN <akalongman@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Longman\TelegramBot\Commands\UserCommands;
+
+use Longman\TelegramBot\Commands\UserCommand;
+use Longman\TelegramBot\Request;
+
+/**
+ * Test "/visible" command to test $show_in_help
+ */
+class VisibleCommand extends UserCommand
+{
+    /**
+     * @var string
+     */
+    protected $name = 'visible';
+
+    /**
+     * @var string
+     */
+    protected $description = 'This command is visible in help';
+
+    /**
+     * @var string
+     */
+    protected $usage = '/visible';
+
+    /**
+     * @var string
+     */
+    protected $version = '1.0.0';
+
+    /**
+     * @var bool
+     */
+    protected $show_in_help = true;
+
+    /**
+     * Command execute method
+     *
+     * @return mixed
+     * @throws \Longman\TelegramBot\Exception\TelegramException
+     */
+    public function execute()
+    {
+        return Request::emptyResponse();
+    }
+}

tests/unit/Commands/UserCommands/HelpCommandTest.php

@@ -10,9 +10,9 @@
 
 namespace Longman\TelegramBot\Tests\Unit\Commands\UserCommands;
 
+use Longman\TelegramBot\Commands\UserCommands\HelpCommand;
 use Longman\TelegramBot\Tests\Unit\Commands\CommandTestCase;
 use Longman\TelegramBot\Tests\Unit\TestHelpers;
-use Longman\TelegramBot\Commands\UserCommands\HelpCommand;
 
 /**
  * @package         TelegramTest
@@ -71,4 +71,15 @@ public function testHelpCommandExecuteWithParameterValidCommand()
             ->getText();
         $this->assertContains("Description: Show text\nUsage: /echo <text>", $text);
     }
+
+    public function testHelpCommandWithHiddenCommand()
+    {
+        $text = $this->command
+            ->setUpdate(TestHelpers::getFakeUpdateCommandObject('/help'))
+            ->execute()
+            ->getResult()
+            ->getText();
+        $this->assertContains('/visible', $text);
+        $this->assertNotContains('/hidden', $text);
+    }
 }