Issue #1205

Optimize addCommandsClass method
Add constants for auth names
Update tests

Author: sedovserge

src/Telegram.php

@@ -30,6 +30,19 @@
 
 class Telegram
 {
+    /**
+     * Auth name for user commands
+     */
+    const AUTH_USER   = 'User';
+    /**
+     * Auth name tof system commands
+     */
+    const AUTH_SYSTEM = 'System';
+    /**
+     * Auth name for admin commands
+     */
+    const AUTH_ADMIN = 'Admin';
+
     /**
      * Version
      *
@@ -86,9 +99,9 @@ class Telegram
      * @var array
      */
     protected $commandsClasses = [
-        'User' => [],
-        'Admin' => [],
-        'System' => [],
+        self::AUTH_USER => [],
+        self::AUTH_ADMIN => [],
+        self::AUTH_SYSTEM => [],
     ];
 
     /**
@@ -340,9 +353,9 @@ public function getCommandObject(string $command, string $filepath = ''): ?Comma
             return $this->commands_objects[$command];
         }
 
-        $which = ['System'];
-        $this->isAdmin() && $which[] = 'Admin';
-        $which[] = 'User';
+        $which = [self::AUTH_SYSTEM];
+        $this->isAdmin() && $which[] = self::AUTH_ADMIN;
+        $which[] = self::AUTH_USER;
 
         foreach ($which as $auth)
         {
@@ -360,19 +373,19 @@ public function getCommandObject(string $command, string $filepath = ''): ?Comma
                 $command_obj = new $command_class($this, $this->update);
 
                 switch ($auth) {
-                    case 'System':
+                    case self::AUTH_SYSTEM:
                         if ($command_obj instanceof SystemCommand) {
                             return $command_obj;
                         }
                         break;
 
-                    case 'Admin':
+                    case self::AUTH_ADMIN:
                         if ($command_obj instanceof AdminCommand) {
                             return $command_obj;
                         }
                         break;
 
-                    case 'User':
+                    case self::AUTH_USER:
                         if ($command_obj instanceof UserCommand) {
                             return $command_obj;
                         }
@@ -766,36 +779,48 @@ public function isDbEnabled(): bool
     /**
      * Add a single custom commands class
      *
-     * @param string $command   Set command name
      * @param string $className Set full classname
-     * @param string $auth Set Auth for command. Default is User
-     *
      * @return Telegram
      */
-    public function addCommandsClass(string $command, string $className, $auth = 'User'): Telegram
+    public function addCommandsClass(string $className): Telegram
     {
-        if (!class_exists($className))
+        if (!$className || !class_exists($className))
         {
             $error = 'Command class name: "' . $className . '" does not exist.';
             TelegramLog::error($error);
             throw new InvalidArgumentException($error);
         }
-        if (empty($command))
-        {
-            $error = 'Command Name "' . $command . '" not set.';
-            TelegramLog::error($error);
-            throw new InvalidArgumentException($error);
-        }
 
         if (!is_array($this->commandsClasses))
         {
             $this->commandsClasses = [];
         }
 
-        $command = mb_strtolower($command);
-        $auth = $this->ucFirstUnicode($auth);
+        if (!is_a($className, Command::class, true)) {
+            $error = 'Command class is not a base command class';
+            TelegramLog::error($error);
+            throw new InvalidArgumentException($error);
+        }
 
-        $this->commandsClasses[$auth][$command] = $className;
+        $commandObject = new $className($this);
+
+        $command = $commandObject->getName();
+        $auth = null;
+        switch (true) {
+            case $commandObject->isSystemCommand():
+                $auth = self::AUTH_SYSTEM;
+                break;
+            case $commandObject->isAdminCommand():
+                $auth = self::AUTH_ADMIN;
+                break;
+            case $commandObject->isUserCommand():
+                $auth = self::AUTH_USER;
+                break;
+        }
+
+        if ($auth) {
+            $this->commandsClasses[$auth][$command] = $className;
+        }
 
         return $this;
     }

tests/Unit/TelegramTest.php

@@ -13,6 +13,7 @@
 
 use DMS\PHPUnitExtensions\ArraySubset\ArraySubsetAsserts;
 use Exception;
+use Longman\TelegramBot\Commands\AdminCommands\WhoisCommand;
 use Longman\TelegramBot\Commands\UserCommands\StartCommand;
 use Longman\TelegramBot\Entities\Update;
 use Longman\TelegramBot\Exception\TelegramException;
@@ -139,25 +140,26 @@ public function testAddCustomCommandsClass(): void
     {
         $tg = $this->telegram;
         $class = StartCommand::class;
+        $aClass = WhoisCommand::class;
 
         self::assertCount(3, $tg->getCommandsClasses());
 
         try {
-            $tg->addCommandsClass('test', 'not\exist\Class', 'user');
+            $tg->addCommandsClass('not\exist\Class');
         }
         catch (\Exception $ex){}
         self::assertCount(0, $tg->getCommandsClasses()['User']);
 
         try {
-            $tg->addCommandsClass('', $class, 'user');
+            $tg->addCommandsClass('');
         }
         catch (\Exception $ex){}
         self::assertCount(0, $tg->getCommandsClasses()['User']);
 
-        $tg->addCommandsClass('test', $class, 'user');
+        $tg->addCommandsClass($class);
         self::assertCount(1, $tg->getCommandsClasses()['User']);
 
-        $tg->addCommandsClass('testadmin', $class, 'admin');
+        $tg->addCommandsClass($aClass);
         self::assertCount(1, $tg->getCommandsClasses()['Admin']);
 
     }
@@ -191,9 +193,10 @@ public function testGetCommandClass(): void
         $class = $this->telegram->getCommandClassName('user', 'notexist');
         self::assertNull($class);
 
-        $this->telegram->addCommandsClass('test', $className, 'user');
-        $class = $this->telegram->getCommandClassName('user', 'test');
+        $this->telegram->addCommandsClass($className);
+        $class = $this->telegram->getCommandClassName('user', 'start');
         self::assertNotNull($class);
+
         self::assertSame($className, $class);
 
     }