Added Translator class

Author: SebaOfficial

composer.json

@@ -23,7 +23,10 @@
     "autoload": {
         "psr-4": {
             "TelegramSDK\\BotAPI\\": "src/"
-        }
+        },
+        "files": [
+            "src/Utils/functions.php"
+        ]
     },
     "autoload-dev": {
         "psr-4": {

docs/00-introduction.md

@@ -18,7 +18,7 @@ use TelegramSDK\BotAPI\Telegram\Bot;
 $bot = new Bot("YOUR_BOT_TOKEN"); // Your bot token
 
 $bot->sendMessage([ // Send a message
-    "chat_id" => 123 // Your chat id
+    "chat_id" => 123, // Your chat id
     "text" => "A message"
 ]);
 ```

docs/02-translating.md

@@ -0,0 +1,49 @@
+# Translating
+This library provides a class to translate texts from a given object.
+
+## How to use
+Assuming you have a file called `locales/en.json`:
+```json
+{
+    "start":{
+        "text": "<b>Hi {{MENTION}}!</b>",
+        "keyboard": {
+            "inline_keyboard": [
+                [{
+                    "text": "Awesome Library",
+                    "url": "https://github.com/TelegramSDK/BotAPI"
+                }]
+            ]
+        }
+    }
+}
+```
+
+
+```php
+<?php
+use TelegramSDK\BotAPI\Utils\Translator;
+
+$user = $updates->message->from;
+
+$user_language = $user->language_code ?? "en";
+
+if(file_exists("locales/$user_language.json")){
+    $file_texts = json_decode(file_get_contents("locales/$user_language.json"));
+} else{
+    $file_texts = json_decode(file_get_contents("locales/en.json"));
+}
+
+$translator = new Translator($file_texts, [
+    "{{MENTION}}" => "<a href='tg://user?id=$user->id'>$user->first_name</a>"
+]);
+
+$bot->sendMessage([
+    "chat_id" => $user->id,
+    "text" => $translator->start->text,
+    "reply_markup" => json_encode($translator->texts->start->keyboard), // Calling $translator->texts doesn't translate the string and doesn't return a new instance of Translator
+    "parse_mode" => "HTML"
+]);
+
+```
+

src/Telegram/Bot.php

@@ -13,7 +13,6 @@
 
 namespace TelegramSDK\BotAPI\Telegram;
 
-use TelegramSDK\BotAPI\Utils;
 use TelegramSDK\BotAPI\Exceptions\TelegramException;
 use GuzzleHttp\Client as Guzzle;
 use GuzzleHttp\Exception\RequestException;
@@ -39,7 +38,7 @@ class Bot{
      */
     public function __construct(string $token, int $updatesMethod = self::NO_UPDATES){
         $this->token = $token;
-        $this->isProduction = Utils::isProduction();
+        $this->isProduction = \TelegramSDK\BotAPI\Utils\isProduction();
         $this->updatesMethod = $updatesMethod;
 
         if(!$this->isProduction){ // Assuming that you've tested the bot before pushing to production

src/Utils.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * Translator class.
+ * This class provides a way to translate texts by replacing specific strings with their corresponding translations.
+ *
+ * @author Sebastiano Racca
+ * @package TelegramSDK\BotAPI\Utils
+ * @see docs/02-translating.md
+ */
+
+declare(strict_types=1);
+namespace TelegramSDK\BotAPI\Utils;
+
+
+class Translator{
+    public ?object $texts;
+    public ?array $translations;
+
+    /**
+     * Translator constructor.
+     *
+     * @param object $texts              The object containing the original texts.
+     * @param array|null $translations   Associative array of the translations to be applied.
+     */
+    public function __construct(object $texts, ?array $translations = null){
+        $this->translations = $translations;
+        $this->texts = $texts;
+    }
+
+    /**
+     * Translates the given string.
+     *
+     * @param string $text   The text to be translated.
+     * @return string        The translated text.
+     */
+    public function translate(string $text): string{
+        return strtr($text, $this->translations);
+    }
+
+    /**
+     * Magic method to dynamically access properties.
+     *
+     * @param string $name   The name of the property.
+     * @return mixed         The value of the property, translated if applicable.
+     */
+    public function __get(string $name): mixed{
+        if(!property_exists($this->texts, $name))
+            return null;
+
+        $propertyValue = $this->texts->$name;
+
+        if(is_string($propertyValue))
+            return $this->translate($propertyValue);
+
+        if(is_object($propertyValue) || is_array($propertyValue)){
+            $translator = new Translator($this->texts, $this->translations);
+            $translator->texts = $propertyValue;
+            return $translator;
+        }
+
+        return $propertyValue;
+    }
+
+}

src/Utils/Translator.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * This file provides a set of util functions for the library.
+ *
+ * @author Sebastiano Racca
+ * @package TelegramSDK\BotAPI\Utils
+ */
+
+declare(strict_types=1);
+
+namespace TelegramSDK\BotAPI\Utils;
+
+
+/**
+ * Checks if the application is running in production mode.
+ *
+ * @return bool True if in production mode, false otherwise.
+ */
+function isProduction(): bool{
+    return (defined('\PRODUCTION') && \PRODUCTION === true);
+}