V1.6.0

Adicionado logs de interação.

Author: httd1

README.md

@@ -315,9 +315,30 @@ $file = Methods::getFile ([
 var_dump ($bot->saveFile ($file, __DIR__.'/music.mp3'));
 ```
 
-### 🔥 [Envie os seus](https://t.me/httd1) bots feito com esse pacote, ele pode ser listado aqui!
+## Logs
+Você pode obter logs de interação com o bot, basta usar a classe estática ```\TelegramPhp\Config\Logs```, por ela você pode definir uma ou mais classes que irão receber e processar os dados de interação do usuário.
+
+- Classe responsável por processar os logs.
+```php
+class LogCommands {
+  // method log is required
+  public function log ($telegramPhp, $action, $route, $data){
+    // process data
+  }
+}
+```
+
+- Definindo a classe que irá processar os logs.
+```php
+\TelegramPhp\Config\Logs::catchLogs ([
+  LogCommands::class,
+  // LogStatistics::class
+]);
+```
+
+### 🔥 [Envie os bots feitos com esse pacote](https://t.me/httd1), ele pode ser listado aqui!
 • J.M  
-- [@scdownbot](https://t.me/scdownbot) (+5K Usuários)
-- [@twitterdlrobot](https://t.me/twitterdlrobot) (+1K Usuários)
-- [@rastreiorobot](https://t.me/rastreiorobot) (+3K Usuários)
-- [@btn_bot](https://t.me/btn_bot) (+500 Usuários)
+- [@scdownbot](https://t.me/scdownbot) (+18K Usuários)
+- [@twitterdlrobot](https://t.me/twitterdlrobot) (+11K Usuários)
+- [@rastreiorobot](https://t.me/rastreiorobot) (+14K Usuários)
+- [@btn_bot](https://t.me/btn_bot) (+200 Usuários)

examples/MarkdownBot/MarkdownBot.php

@@ -1,6 +1,7 @@
 <?php
 
 use \TelegramPhp\Methods;
+use \TelegramPhp\Reaction;
 
 class MarkdownBot {
 

examples/MarkdownBot/bot.php

@@ -1,16 +1,19 @@
 <?php
 
 include __DIR__.'/../../vendor/autoload.php';
+include __DIR__.'/logs/LogComandos.php';
 include __DIR__.'/MarkdownBot.php';
 
 use \TelegramPhp\TelegramPhp;
-use \TelegramPhp\Methods;
-use \TelegramPhp\Buttons;
 
 \TelegramPhp\Config\Token::setToken ('343008038:AAGIgeZ6jG6EDJwxU5Slu1KrC2LHxwe1Nlk');
 
 $tlg = new TelegramPhp ();
 
+\TelegramPhp\Config\Logs::catchLogs ([
+    LogComandos::class,
+]);
+
 // debug
 $tlg->setContent ('{
 "update_id":264419866,
@@ -43,6 +46,6 @@
 
 $tlg->command ('/start', 'MarkdownBot:start');
 $tlg->command ('/help', 'MarkdownBot:help');
-$tlg->commandMatch ('/^[^\/]+/', 'MarkdownBot:markdownText');
+$tlg->commandMatch ('/^(?<texto>[^\/]+)/', 'MarkdownBot:markdownText');
 
 $tlg->commandDefault ('MarkdownBot:defaultResponse');

examples/MarkdownBot/logs/LogComandos.php

@@ -0,0 +1,25 @@
+<?php
+
+use \TelegramPhp\Methods;
+
+class LogComandos {
+
+    // method log required
+    public function log ($tlg, $action, $route, $data)
+    {
+
+        $log = "\n------- LOG ---------\n";
+        $log .= "Text: {$tlg->getText()}\n";
+        $log .= "Route: {$route}\n";
+        $log .= "Action: {$action}\n";
+        $log .= "Data: " . json_encode($data) . "\n";
+        $log .= "Usuário: {$tlg->getFirstName()} - {$tlg->getUserId()}\n";
+        
+        Methods::sendMessage ([
+            'chat_id' => '275123569',
+            'text' => $log
+        ]);
+
+    }
+
+}

src/Config/Logs.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace TelegramPhp\Config;
+
+class Logs {
+
+    /**
+     * @var array
+     */
+    static $logCommands = [];
+
+   /**
+    * Set the class to capture logs of commands.
+    * **It's required that you define the _log_ method in your class.**
+    *
+    * @param array|string $class
+    * 
+    * @return void
+    */
+    static function catchLogs (string|array $class) :void
+    {
+
+        if (!\is_array ($class)){
+            $class = [$class];
+        }
+        self::$logCommands = [...$class];
+
+    }
+}

src/Config/Token.php

@@ -4,6 +4,9 @@
 
 class Token {
 
+    /**
+     * @var string
+     */
     static $token;
 
     /**

src/Methods.php

@@ -88,7 +88,7 @@ public static function deleteWebhook (array $data) :array
      */
     public static function getWebhookInfo () :array
     {
-        return self::call (__FUNCTION__, $data);
+        return self::call (__FUNCTION__, []);
     }
 
     /**

src/Reaction.php

@@ -11,7 +11,7 @@ class Reaction {
      * 
      * @return string
      */
-    public static function reactionType (array $reaction)
+    public static function reactionType (array $reaction) :string
     {
         return \json_encode ($reaction);
     }
@@ -25,7 +25,7 @@ public static function reactionType (array $reaction)
      * 
      * @return array
      */
-    public static function reactionTypeEmoji (string $emoji)
+    public static function reactionTypeEmoji (string $emoji) :array
     {
         return [
             'type' => 'emoji',
@@ -42,7 +42,7 @@ public static function reactionTypeEmoji (string $emoji)
      * 
      * @return array
      */
-    public static function reactionTypeCustomEmoji (string $custom_emoji_id)
+    public static function reactionTypeCustomEmoji (string $custom_emoji_id) :array
     {
         return [
             'type' => 'custom_emoji',

src/TelegramPhp.php

@@ -3,7 +3,7 @@
 namespace TelegramPhp;
 
 use \TelegramPhp\Config\Token;
-use \TelegramPhp\Request\Request;
+use \TelegramPhp\Config\Logs;
 
 /**
  * Package for Telegram Bot API in php, TelegramPhp
@@ -39,7 +39,7 @@ function __construct ()
 
         if (!\version_compare (PHP_VERSION, 7.0, '>='))
         {
-            throw new Exception ('Unsupported version!');
+            throw new \Exception ('Unsupported version!');
         }
 
         $this->token = Token::$token;
@@ -58,15 +58,16 @@ public function initContent () :void
     /**
      * Command default executed when there aren't command defined.
      * 
-     * @param $action
+     * @param callable|string $action
      * 
      * @return void
      */
-    public function commandDefault ($action) :void
+    public function commandDefault (callable|string $action) :void
     {
 
         if ($this->hasCommand == false && !empty ($this->getText ())){
             $this->runAction ($action);
+            $this->callLogs ($action, 'default', []);
         }
 
     }
@@ -75,11 +76,11 @@ public function commandDefault ($action) :void
      * Execute a callback to a command.
      * 
      * @param string $route
-     * @param $action
+     * @param callable|string $action
      * 
      * @return void
      */
-    public function command (string $route, $action) :void
+    public function command (string $route, callable|string $action) :void
     {
 
         if (empty ($route)){
@@ -100,13 +101,15 @@ public function command (string $route, $action) :void
                 // /comando é o mesmo em $this->getText () e $route
                 if ($route_command ['command'] == $text_command ['command']){
                     $this->runAction ($action, $data);
+                    $this->callLogs ($action, $route, $data);
                     return;
                 }
             }
         }else {
             // é uma mensagem normal, compara com o route
             if ($this->getText () == $route){
                 $this->runAction ($action, []);
+                $this->callLogs ($action, $route, []);
                 return;
             }
         }
@@ -116,11 +119,11 @@ public function command (string $route, $action) :void
      * Executes a regular expression on a text sent to the bot.
      * 
      * @param string $regex
-     * @param $action
+     * @param callable|string $action
      * 
      * @return void
      */
-    public function commandMatch (string $regex, $action) :void
+    public function commandMatch (string $regex, callable|string $action) :void
     {
 
         if (empty ($regex)){
@@ -133,29 +136,63 @@ public function commandMatch (string $regex, $action) :void
 
             if (!empty ($match)){
                 $this->runAction ($action, $match);
+                $this->callLogs ($action, $regex, $match);
                 return;
             }
         }
 
     }
 
     /**
-     * @param $action
+     * @param callable|string $action
      * @param array $data
      */
-    function runAction ($action, array $data = [])
+    function runAction (callable|string $action, array $data = []) :void
     {
         if (is_callable ($action)){
             $action ($this, $data);
         }else {
-            list ($class, $method) = $this->match ('/[^:]+/', $action, true);
-            $obj = new $class;
-            $obj->$method ($this, $data);
+            list ($class, $method) = $this->match ('/[^:@]+/', $action, true);
+            // classe existe!
+            if (\class_exists ($class)){
+
+                $obj = new $class;
+
+                // método existe!
+                if (\method_exists ($obj, $method)){
+                    $obj->$method ($this, $data); //chama método
+                }else {
+                    throw new \Exception ("Method \"{$method}\" doesn't exist in '{$class}' class");
+                }
+
+            }else {
+                throw new \Exception ("Class \"{$class}\" doesn't exist");
+            }
         }
 
         if ($this->hasCommand == false) $this->hasCommand = true;
     }
 
+    /**
+     * Call log class
+     * 
+     * @param callable|string $action
+     * @param string $route
+     * @param array $data
+     * 
+     * @return void
+     */
+    public function callLogs (callable|string $action, string $route, array $data) :void
+    {
+
+        foreach (Logs::$logCommands as $log){
+            $clssLog = new $log;
+            $action = \is_callable ($action) ? 'function' : $action;
+            $clssLog->log ($this, $action, $route, $data);
+        }
+
+    }
+
     /**
      * Verifies the secret token sent in an “X-Telegram-Bot-Api-Secret-Token” header on each webhook request, from 1 to 256 characters.
      * The header is useful to ensure that the request comes from a webhook you define.
@@ -194,7 +231,7 @@ public function getSecretToken () :string
      * 
      * @return void
      */
-    public function setSecretToken (string $secretToken)
+    public function setSecretToken (string $secretToken) :void
     {
         $this->secret_token = $secretToken;
     }