Merge pull request #34 from nasserghiasi/master

[URGENT] BUGFIX: trim don't accept null argument

Author: noplanman

CHANGELOG.md

@@ -5,10 +5,13 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
 
 ## [Unreleased]
 ### Added
+- Custom output callback can be defined for getUpdates method.
 ### Changed
+- Default output of getUpdates method now shows the message type or query text, not the text message content.
 ### Deprecated
 ### Removed
 ### Fixed
+- GetUpdates method would crash if a non-text message was sent.
 ### Security
 
 ## [1.1.0] - 2017-05-23

README.md

@@ -325,6 +325,43 @@ $bot = new BotManager([
 
 Now, the updates can be done either through the [browser](#via-browser) or [via CLI](#via-cli).
 
+#### Custom getUpdates output
+
+A callback can be defined, to override the default output when updates are handled via getUpdates.
+
+Example of the default output:
+```
+...
+2017-07-10 14:59:25 - Updates processed: 1
+123456: <text>
+2017-07-10 14:59:27 - Updates processed: 0
+2017-07-10 14:59:30 - Updates processed: 0
+2017-07-10 14:59:32 - Updates processed: 0
+2017-07-10 14:59:34 - Updates processed: 1
+123456: <photo>
+2017-07-10 14:59:36 - Updates processed: 0
+...
+```
+
+Using custom callback that must return a string:
+```php
+// In manager.php after $bot has been defined:
+$bot->setCustomGetUpdatesCallback(function (ServerResponse $get_updates_response) {
+    $results = array_filter((array) $get_updates_response->getResult());
+
+    return sprintf('There are %d update(s)' . PHP_EOL, count($results));
+});
+```
+output:
+```
+...
+There are 0 update(s)
+There are 0 update(s)
+There are 2 update(s)
+There are 1 update(s)
+...
+```
+
 ## Development
 
 When running live bot tests on a fork, you must enter the following environment variables to your [repository settings][travis-repository-settings] on travis-ci.org:

src/BotManager.php

@@ -45,6 +45,11 @@ class BotManager
      */
     private $action;
 
+    /**
+     * @var callable
+     */
+    private $custom_get_updates_callback;
+
     /**
      * BotManager constructor.
      *
@@ -431,6 +436,19 @@ public function handleGetUpdatesLoop(int $loop_time_in_seconds, int $loop_interv
         return $this;
     }
 
+    /**
+     * Set a custom callback for handling the output of the getUpdates results.
+     *
+     * @param callable $callback
+     *
+     * @return \TelegramBot\TelegramBotManager\BotManager
+     */
+    public function setCustomGetUpdatesCallback(callable $callback): BotManager
+    {
+        $this->custom_get_updates_callback = $callback;
+        return $this;
+    }
+
     /**
      * Handle the updates using the getUpdates method.
      *
@@ -439,45 +457,61 @@ public function handleGetUpdatesLoop(int $loop_time_in_seconds, int $loop_interv
      */
     public function handleGetUpdates(): self
     {
-        $output = date('Y-m-d H:i:s', time()) . ' - ';
-
-        $response = $this->telegram->handleGetUpdates();
-        if ($response->isOk()) {
-            $results = array_filter((array) $response->getResult());
-
-            $output .= sprintf('Updates processed: %d' . PHP_EOL, count($results));
-
-            /** @var Entities\Update $result */
-            foreach ($results as $result) {
-                $chat_id = 0;
-                $text    = 'Nothing';
-
-                $update_content = $result->getUpdateContent();
-                if ($update_content instanceof Entities\Message) {
-                    $chat_id = $update_content->getFrom()->getId();
-                    $text    = $update_content->getText();
-                } elseif ($update_content instanceof Entities\InlineQuery ||
-                          $update_content instanceof Entities\ChosenInlineResult
-                ) {
-                    $chat_id = $update_content->getFrom()->getId();
-                    $text    = $update_content->getQuery();
-                }
+        $get_updates_response = $this->telegram->handleGetUpdates();
 
-                $output .= sprintf(
-                    '%d: %s' . PHP_EOL,
-                    $chat_id,
-                    preg_replace('/\s+/', ' ', trim($text))
-                );
-            }
+        // Check if the user has set a custom callback for handling the response.
+        if ($this->custom_get_updates_callback !== null) {
+            $this->handleOutput(call_user_func($this->custom_get_updates_callback, $get_updates_response));
         } else {
-            $output .= sprintf('Failed to fetch updates: %s' . PHP_EOL, $response->printError());
+            $this->handleOutput($this->defaultGetUpdatesCallback($get_updates_response));
         }
 
-        $this->handleOutput($output);
-
         return $this;
     }
 
+    /**
+     * Return the default output for getUpdates handling.
+     *
+     * @param Entities\ServerResponse $get_updates_response
+     *
+     * @return string
+     */
+    protected function defaultGetUpdatesCallback($get_updates_response): string
+    {
+        /** @var Entities\Update[] $results */
+        $results = array_filter((array) $get_updates_response->getResult());
+
+        $output = sprintf(
+            '%s - Updates processed: %d' . PHP_EOL,
+            date('Y-m-d H:i:s'),
+            count($results)
+        );
+
+        foreach ($results as $result) {
+            $chat_id = 0;
+            $text    = '<n/a>';
+
+            $update_content = $result->getUpdateContent();
+            if ($update_content instanceof Entities\Message) {
+                $chat_id = $update_content->getFrom()->getId();
+                $text    = sprintf('<%s>', $update_content->getType());
+            } elseif ($update_content instanceof Entities\InlineQuery ||
+                      $update_content instanceof Entities\ChosenInlineResult
+            ) {
+                $chat_id = $update_content->getFrom()->getId();
+                $text    = sprintf('<query> %s', $update_content->getQuery());
+            }
+
+            $output .= sprintf(
+                '%d: %s' . PHP_EOL,
+                $chat_id,
+                preg_replace('/\s+/', ' ', trim($text))
+            );
+        }
+
+        return $output;
+    }
+
     /**
      * Handle the updates using the Webhook method.
      *