Merge pull request #369 from defstudio/#368_implementig_with_data_method

#368 implementing withData() method

docs/content/en/features/attachments.md

@@ -9,6 +9,15 @@ position: 36
 
 Telegraph supports different types of attachments both from local files, remote urls and existing files on Telegram servers (using their file_id)
 
+## Optional parameters
+
+Attachments methods only supports required parameters, optional parameters can be sent through Telegraph `->withData()` method:
+
+```php
+Telegraph::message('hi')->withData('caption', 'test')->send();
+Telegraph::withData('caption', 'test')->message('hi')->send();
+```
+
 ## Attachment types
 
 ### Photos

docs/content/en/features/telegram-api-calls.md

@@ -549,3 +549,12 @@ print a `dd()` of the current api call status for testing purposes
 ```php
 Telegraph::message('test')->dd();
 ```
+
+
+## withData
+
+set custom Telegraph data attribute
+
+```php
+Telegraph::withData('key', 'value');
+```

docs/content/en/models/telegraph-chat.md

@@ -62,6 +62,15 @@ Retrieves the chat member count from telegram
 $telegraphChat->info(); /* 42 */
 ```
 
+## Optional parameters
+
+Attachments methods only supports required parameters, optional parameters can be sent through Telegraph `->withData()` method:
+
+```php
+$telegraphChat->message('hi')->withData('caption', 'test')->send();
+$telegraphChat->withData('caption', 'test')->message('hi')->send();
+```
+
 ### `message()`
 
 Starts a `Telegraph` call to send a message

src/Facades/Telegraph.php

@@ -17,6 +17,7 @@
  * @method static \DefStudio\Telegraph\Telegraph  bot(TelegraphBot|string $bot)
  * @method static \DefStudio\Telegraph\Telegraph  chat(TelegraphChat|string $chat)
  * @method static \DefStudio\Telegraph\Telegraph  message(string $message)
+ * @method static \DefStudio\Telegraph\Telegraph  withData(string $key, mixed $value)
  * @method static \DefStudio\Telegraph\Telegraph  html(string $message)
  * @method static \DefStudio\Telegraph\Telegraph  reply(int $messageId)
  * @method static \DefStudio\Telegraph\Telegraph  edit(string $messageId)

src/Models/TelegraphChat.php

@@ -94,6 +94,11 @@ public function memberCount(): int
         return $reply->json('result');
     }
 
+    public function withData(string $key, mixed $value): Telegraph
+    {
+        return TelegraphFacade::chat($this)->withData($key, $value);
+    }
+
     public function message(string $message): Telegraph
     {
         return TelegraphFacade::chat($this)->message($message);

src/Telegraph.php

@@ -160,4 +160,13 @@ public function dump(): Telegraph
 
         return $this;
     }
+
+    public function withData(string $key, mixed $value): static
+    {
+        $telegraph = clone $this;
+
+        data_set($telegraph->data, $key, $value);
+
+        return $telegraph;
+    }
 }

tests/Unit/Models/TelegraphChatTest.php

@@ -651,3 +651,27 @@
         ],
     ]);
 });
+
+it('can edit Telegraph data before sending a media ', function () {
+    Telegraph::fake();
+    $chat = make_chat();
+
+    $chat->withData('caption', 'test')->video('test.url')->send();
+
+    Telegraph::assertSentData(\DefStudio\Telegraph\Telegraph::ENDPOINT_SEND_VIDEO, [
+        'video' => 'test.url',
+        'caption' => 'test',
+    ]);
+});
+
+it('can edit Telegraph data after sending a media ', function () {
+    Telegraph::fake();
+    $chat = make_chat();
+
+    $chat->video('test.url')->withData('caption', 'test')->send();
+
+    Telegraph::assertSentData(\DefStudio\Telegraph\Telegraph::ENDPOINT_SEND_VIDEO, [
+        'video' => 'test.url',
+        'caption' => 'test',
+    ]);
+});