ALL commands now return a ServerResponse object instead of a bool.

noplanman · noplanman · commit 4ed9660b404a · 2016-02-21T00:37:44.000+01:00
diff --git a/src/Commands/AdminCommands/ChatsCommand.php b/src/Commands/AdminCommands/ChatsCommand.php
@@ -31,9 +31,7 @@ class ChatsCommand extends AdminCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
     public function execute()
     {
@@ -85,6 +83,6 @@ public function execute()
             'text'    => $text,
         ];
 
-        return Request::sendMessage($data)->isOk();
+        return Request::sendMessage($data);
     }
 }
diff --git a/src/Commands/AdminCommands/SendtoallCommand.php b/src/Commands/AdminCommands/SendtoallCommand.php
@@ -95,6 +95,6 @@ public function execute()
             'text'    => $text,
         ];
 
-        return Request::sendMessage($data)->isOk();
+        return Request::sendMessage($data);
     }
 }
diff --git a/src/Commands/AdminCommands/SendtochannelCommand.php b/src/Commands/AdminCommands/SendtochannelCommand.php
@@ -52,8 +52,7 @@ public function execute()
                 'text'    => $text,
             ];
 
-            $result = Request::sendMessage($data);
-            if ($result->isOk()) {
+            if (Request::sendMessage($data)->isOk()) {
                 $text_back = 'Message sent succesfully to: ' . $your_channel;
             } else {
                 $text_back = 'Sorry message not sent to: ' . $your_channel;
@@ -65,6 +64,6 @@ public function execute()
             'text'    => $text_back,
         ];
 
-        return Request::sendMessage($data)->isOk();
+        return Request::sendMessage($data);
     }
 }
diff --git a/src/Commands/Command.php b/src/Commands/Command.php
@@ -122,7 +122,7 @@ public function setUpdate(Update $update = null)
     /**
      * Pre-execute command
      *
-     * @return mixed
+     * @return Entities\ServerResponse
      */
     public function preExecute()
     {
@@ -134,13 +134,15 @@ public function preExecute()
 
     /**
      * Execute command
+     *
+     * @return Entities\ServerResponse
      */
     abstract public function execute();
 
     /**
      * Execution if MySQL is required but not available
      *
-     * @return boolean
+     * @return Entities\ServerResponse
      */
     public function executeNoDB()
     {
@@ -153,7 +155,7 @@ public function executeNoDB()
             'text'    => 'Sorry no database connection, unable to execute "' . $this->name . '" command.',
         ];
 
-        return Request::sendMessage($data)->isOk();
+        return Request::sendMessage($data);
     }
 
 
diff --git a/src/Commands/SystemCommand.php b/src/Commands/SystemCommand.php
@@ -10,6 +10,8 @@
 
 namespace Longman\TelegramBot\Commands;
 
+use Longman\TelegramBot\Entities\ServerResponse;
+
 /**
  * Abstract System Command Class
  */
@@ -18,14 +20,14 @@ abstract class SystemCommand extends Command
     /**
      * A system command just executes
      *
-     * Although system commands should just work and return 'true',
+     * Although system commands should just work and return a successful ServerResponse,
      * each system command can override this method to add custom functionality.
      *
-     * @return bool
+     * @return Entities\ServerResponse
      */
     public function execute()
     {
-        //System command, do nothing
-        return true;
+        //System command, return successful ServerResponse
+        return new ServerResponse(['ok' => true, 'result' => true], null);
     }
 }
diff --git a/src/Commands/SystemCommands/ChannelchatcreatedCommand.php b/src/Commands/SystemCommands/ChannelchatcreatedCommand.php
@@ -26,16 +26,11 @@ class ChannelchatcreatedCommand extends SystemCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
-    public function execute()
+    /*public function execute()
     {
         //$message = $this->getMessage();
         //$channel_chat_created = $message->getChannelChatCreated();
-
-        //System command, do nothing
-        return true;
-    }
+    }*/
 }
diff --git a/src/Commands/SystemCommands/ChoseninlineresultCommand.php b/src/Commands/SystemCommands/ChoseninlineresultCommand.php
@@ -26,18 +26,13 @@ class ChoseninlineresultCommand extends SystemCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
-    public function execute()
+    /*public function execute()
     {
         //Information about chosen result is returned
         //$update = $this->getUpdate();
         //$inline_query = $update->getChosenInlineResult();
         //$query = $inline_query->getQuery();
-
-        //System command, do nothing
-        return true;
-    }
+    }*/
 }
diff --git a/src/Commands/SystemCommands/DeletechatphotoCommand.php b/src/Commands/SystemCommands/DeletechatphotoCommand.php
@@ -26,16 +26,11 @@ class DeletechatphotoCommand extends SystemCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
-    public function execute()
+    /*public function execute()
     {
         //$message = $this->getMessage();
         //$delete_chat_photo = $message->getDeleteChatPhoto();
-
-        //System command, do nothing
-        return true;
-    }
+    }*/
 }
diff --git a/src/Commands/SystemCommands/GenericCommand.php b/src/Commands/SystemCommands/GenericCommand.php
@@ -27,9 +27,7 @@ class GenericCommand extends SystemCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
     public function execute()
     {
@@ -44,6 +42,6 @@ public function execute()
             'text'    => 'Command /' . $command . ' not found.. :(',
         ];
 
-        return Request::sendMessage($data)->isOk();
+        return Request::sendMessage($data);
     }
 }
diff --git a/src/Commands/SystemCommands/GenericmessageCommand.php b/src/Commands/SystemCommands/GenericmessageCommand.php
@@ -26,13 +26,10 @@ class GenericmessageCommand extends SystemCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
-    public function execute()
+    /*public function execute()
     {
-        //System command, do nothing
-        return true;
-    }
+
+    }*/
 }
diff --git a/src/Commands/SystemCommands/GroupchatcreatedCommand.php b/src/Commands/SystemCommands/GroupchatcreatedCommand.php
@@ -26,16 +26,11 @@ class GroupchatcreatedCommand extends SystemCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
-    public function execute()
+    /*public function execute()
     {
         //$message = $this->getMessage();
         //$group_chat_created = $message->getGroupChatCreated();
-
-        //System command, do nothing
-        return true;
-    }
+    }*/
 }
diff --git a/src/Commands/SystemCommands/InlinequeryCommand.php b/src/Commands/SystemCommands/InlinequeryCommand.php
@@ -28,9 +28,7 @@ class InlinequeryCommand extends SystemCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
     public function execute()
     {
@@ -52,6 +50,6 @@ public function execute()
         }
         $data['results'] = '[' . implode(',', $array_article) . ']';
 
-        return Request::answerInlineQuery($data)->isOk();
+        return Request::answerInlineQuery($data);
     }
 }
diff --git a/src/Commands/SystemCommands/LeftchatparticipantCommand.php b/src/Commands/SystemCommands/LeftchatparticipantCommand.php
@@ -26,16 +26,11 @@ class LeftchatparticipantCommand extends SystemCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
-    public function execute()
+    /*public function execute()
     {
         //$message = $this->getMessage();
         //$participant = $message->getLeftChatParticipant();
-
-        //System command, do nothing
-        return true;
-    }
+    }*/
 }
diff --git a/src/Commands/SystemCommands/NewchatparticipantCommand.php b/src/Commands/SystemCommands/NewchatparticipantCommand.php
@@ -27,9 +27,7 @@ class NewchatparticipantCommand extends SystemCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
     public function execute()
     {
@@ -49,6 +47,6 @@ public function execute()
             'text'    => $text,
         ];
 
-        return Request::sendMessage($data)->isOk();
+        return Request::sendMessage($data);
     }
 }
diff --git a/src/Commands/SystemCommands/NewchattitleCommand.php b/src/Commands/SystemCommands/NewchattitleCommand.php
@@ -26,16 +26,11 @@ class NewchattitleCommand extends SystemCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
-    public function execute()
+    /*public function execute()
     {
         //$message = $this->getMessage();
         //$new_chat_title = $message->getNewChatTitle();
-
-        //System command, do nothing
-        return true;
-    }
+    }*/
 }
diff --git a/src/Commands/SystemCommands/StartCommand.php b/src/Commands/SystemCommands/StartCommand.php
@@ -28,9 +28,7 @@ class StartCommand extends SystemCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
     public function execute()
     {
@@ -44,6 +42,6 @@ public function execute()
             'text'    => $text,
         ];
 
-        return Request::sendMessage($data)->isOk();
+        return Request::sendMessage($data);
     }
 }
diff --git a/src/Commands/SystemCommands/SupergroupchatcreatedCommand.php b/src/Commands/SystemCommands/SupergroupchatcreatedCommand.php
@@ -27,9 +27,7 @@ class SupergroupchatcreatedCommand extends SystemCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
     public function execute()
     {
@@ -48,6 +46,6 @@ public function execute()
             'text'    => $text,
         ];
 
-        return Request::sendMessage($data)->isOk();
+        return Request::sendMessage($data);
     }
 }
diff --git a/src/Commands/UserCommands/DateCommand.php b/src/Commands/UserCommands/DateCommand.php
@@ -175,9 +175,7 @@ private function request($url)
     }
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
     public function execute()
     {
@@ -204,6 +202,6 @@ public function execute()
             'text'                => $text,
         ];
 
-        return Request::sendMessage($data)->isOk();
+        return Request::sendMessage($data);
     }
 }
diff --git a/src/Commands/UserCommands/EchoCommand.php b/src/Commands/UserCommands/EchoCommand.php
@@ -28,9 +28,7 @@ class EchoCommand extends UserCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
     public function execute()
     {
@@ -47,6 +45,6 @@ public function execute()
             'text'    => $text,
         ];
 
-        return Request::sendMessage($data)->isOk();
+        return Request::sendMessage($data);
     }
 }
diff --git a/src/Commands/UserCommands/HelpCommand.php b/src/Commands/UserCommands/HelpCommand.php
@@ -28,9 +28,7 @@ class HelpCommand extends UserCommand
     /**#@-*/
 
     /**
-     * Execute command
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
     public function execute()
     {
@@ -72,6 +70,6 @@ public function execute()
             'text'                => $text,
         ];
 
-        return Request::sendMessage($data)->isOk();
+        return Request::sendMessage($data);
     }
 }
diff --git a/src/Commands/UserCommands/SlapCommand.php b/src/Commands/UserCommands/SlapCommand.php
diff --git a/src/Commands/UserCommands/WeatherCommand.php b/src/Commands/UserCommands/WeatherCommand.php
diff --git a/src/Commands/UserCommands/WhoamiCommand.php b/src/Commands/UserCommands/WhoamiCommand.php

Original file line number	Diff line number	Diff line change
`@@ -31,9 +31,7 @@ class ChatsCommand extends AdminCommand`
`31`	`31`	`/*#@-/`
`32`	`32`
`33`	`33`	`/**`
`34`		`- * Execute command`
`35`		`- *`
`36`		`- * @return boolean`
	`34`	`+ * {@inheritdoc}`
`37`	`35`	`*/`
`38`	`36`	`public function execute()`
`39`	`37`	`{`
`@@ -85,6 +83,6 @@ public function execute()`
`85`	`83`	`'text' => $text,`
`86`	`84`	`];`
`87`	`85`
`88`		`- return Request::sendMessage($data)->isOk();`
	`86`	`+ return Request::sendMessage($data);`
`89`	`87`	`}`
`90`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,6 +95,6 @@ public function execute()`
`95`	`95`	`'text' => $text,`
`96`	`96`	`];`
`97`	`97`
`98`		`- return Request::sendMessage($data)->isOk();`
	`98`	`+ return Request::sendMessage($data);`
`99`	`99`	`}`
`100`	`100`	`}`
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ public function setUpdate(Update $update = null)`
`122`	`122`	`/**`
`123`	`123`	`* Pre-execute command`
`124`	`124`	`*`
`125`		`- * @return mixed`
	`125`	`+ * @return Entities\ServerResponse`
`126`	`126`	`*/`
`127`	`127`	`public function preExecute()`
`128`	`128`	`{`
`@@ -134,13 +134,15 @@ public function preExecute()`
`134`	`134`
`135`	`135`	`/**`
`136`	`136`	`* Execute command`
	`137`	`+ *`
	`138`	`+ * @return Entities\ServerResponse`
`137`	`139`	`*/`
`138`	`140`	`abstract public function execute();`
`139`	`141`
`140`	`142`	`/**`
`141`	`143`	`* Execution if MySQL is required but not available`
`142`	`144`	`*`
`143`		`- * @return boolean`
	`145`	`+ * @return Entities\ServerResponse`
`144`	`146`	`*/`
`145`	`147`	`public function executeNoDB()`
`146`	`148`	`{`
`@@ -153,7 +155,7 @@ public function executeNoDB()`
`153`	`155`	`'text' => 'Sorry no database connection, unable to execute "' . $this->name . '" command.',`
`154`	`156`	`];`
`155`	`157`
`156`		`- return Request::sendMessage($data)->isOk();`
	`158`	`+ return Request::sendMessage($data);`
`157`	`159`	`}`
`158`	`160`
`159`	`161`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@`
`10`	`10`
`11`	`11`	`namespace Longman\TelegramBot\Commands;`
`12`	`12`
	`13`	`+use Longman\TelegramBot\Entities\ServerResponse;`
	`14`	`+`
`13`	`15`	`/**`
`14`	`16`	`* Abstract System Command Class`
`15`	`17`	`*/`
`@@ -18,14 +20,14 @@ abstract class SystemCommand extends Command`
`18`	`20`	`/**`
`19`	`21`	`* A system command just executes`
`20`	`22`	`*`
`21`		`- * Although system commands should just work and return 'true',`
	`23`	`+ * Although system commands should just work and return a successful ServerResponse,`
`22`	`24`	`* each system command can override this method to add custom functionality.`
`23`	`25`	`*`
`24`		`- * @return bool`
	`26`	`+ * @return Entities\ServerResponse`
`25`	`27`	`*/`
`26`	`28`	`public function execute()`
`27`	`29`	`{`
`28`		`- //System command, do nothing`
`29`		`- return true;`
	`30`	`+ //System command, return successful ServerResponse`
	`31`	`+ return new ServerResponse(['ok' => true, 'result' => true], null);`
`30`	`32`	`}`
`31`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,9 +27,7 @@ class GenericCommand extends SystemCommand`
`27`	`27`	`/*#@-/`
`28`	`28`
`29`	`29`	`/**`
`30`		`- * Execute command`
`31`		`- *`
`32`		`- * @return boolean`
	`30`	`+ * {@inheritdoc}`
`33`	`31`	`*/`
`34`	`32`	`public function execute()`
`35`	`33`	`{`
`@@ -44,6 +42,6 @@ public function execute()`
`44`	`42`	`'text' => 'Command /' . $command . ' not found.. :(',`
`45`	`43`	`];`
`46`	`44`
`47`		`- return Request::sendMessage($data)->isOk();`
	`45`	`+ return Request::sendMessage($data);`
`48`	`46`	`}`
`49`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,9 +28,7 @@ class InlinequeryCommand extends SystemCommand`
`28`	`28`	`/*#@-/`
`29`	`29`
`30`	`30`	`/**`
`31`		`- * Execute command`
`32`		`- *`
`33`		`- * @return boolean`
	`31`	`+ * {@inheritdoc}`
`34`	`32`	`*/`
`35`	`33`	`public function execute()`
`36`	`34`	`{`
`@@ -52,6 +50,6 @@ public function execute()`
`52`	`50`	`}`
`53`	`51`	`$data['results'] = '[' . implode(',', $array_article) . ']';`
`54`	`52`
`55`		`- return Request::answerInlineQuery($data)->isOk();`
	`53`	`+ return Request::answerInlineQuery($data);`
`56`	`54`	`}`
`57`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,9 +27,7 @@ class NewchatparticipantCommand extends SystemCommand`
`27`	`27`	`/*#@-/`
`28`	`28`
`29`	`29`	`/**`
`30`		`- * Execute command`
`31`		`- *`
`32`		`- * @return boolean`
	`30`	`+ * {@inheritdoc}`
`33`	`31`	`*/`
`34`	`32`	`public function execute()`
`35`	`33`	`{`
`@@ -49,6 +47,6 @@ public function execute()`
`49`	`47`	`'text' => $text,`
`50`	`48`	`];`
`51`	`49`
`52`		`- return Request::sendMessage($data)->isOk();`
	`50`	`+ return Request::sendMessage($data);`
`53`	`51`	`}`
`54`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,9 +28,7 @@ class StartCommand extends SystemCommand`
`28`	`28`	`/*#@-/`
`29`	`29`
`30`	`30`	`/**`
`31`		`- * Execute command`
`32`		`- *`
`33`		`- * @return boolean`
	`31`	`+ * {@inheritdoc}`
`34`	`32`	`*/`
`35`	`33`	`public function execute()`
`36`	`34`	`{`
`@@ -44,6 +42,6 @@ public function execute()`
`44`	`42`	`'text' => $text,`
`45`	`43`	`];`
`46`	`44`
`47`		`- return Request::sendMessage($data)->isOk();`
	`45`	`+ return Request::sendMessage($data);`
`48`	`46`	`}`
`49`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,9 +27,7 @@ class SupergroupchatcreatedCommand extends SystemCommand`
`27`	`27`	`/*#@-/`
`28`	`28`
`29`	`29`	`/**`
`30`		`- * Execute command`
`31`		`- *`
`32`		`- * @return boolean`
	`30`	`+ * {@inheritdoc}`
`33`	`31`	`*/`
`34`	`32`	`public function execute()`
`35`	`33`	`{`
`@@ -48,6 +46,6 @@ public function execute()`
`48`	`46`	`'text' => $text,`
`49`	`47`	`];`
`50`	`48`
`51`		`- return Request::sendMessage($data)->isOk();`
	`49`	`+ return Request::sendMessage($data);`
`52`	`50`	`}`
`53`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -175,9 +175,7 @@ private function request($url)`
`175`	`175`	`}`
`176`	`176`
`177`	`177`	`/**`
`178`		`- * Execute command`
`179`		`- *`
`180`		`- * @return boolean`
	`178`	`+ * {@inheritdoc}`
`181`	`179`	`*/`
`182`	`180`	`public function execute()`
`183`	`181`	`{`
`@@ -204,6 +202,6 @@ public function execute()`
`204`	`202`	`'text' => $text,`
`205`	`203`	`];`
`206`	`204`
`207`		`- return Request::sendMessage($data)->isOk();`
	`205`	`+ return Request::sendMessage($data);`
`208`	`206`	`}`
`209`	`207`	`}`