Merge pull request #62 from nutgram/helpers-page

Add "helpers" page

Author: sergix44

docs/usage/handlers.mdx

@@ -1233,121 +1233,3 @@ $bot->onCommand('start2 {param}', [$instance, 'handle']); // instance-method
 
 $bot->run();
 ```
-
-## Update Helpers
-
-When dealing with updates, sometimes you may need to access data that is nested in the update structure, which can be
-tedious and produce *a lot* of boilerplate, since the same objects can often be nested in other objects, depending on
-the type of update. For this reason, the framework provides a number of **support methods to quickly access the most
-used data, no matter the update type**, like this:
-
-```php
-use SergiX44\Nutgram\Nutgram;
-
-$bot = new Nutgram($_ENV['TOKEN']);
-
-$bot->onCommand('help', function (Nutgram $bot) {
-    // Get the Message object
-    $bot->message();
-
-    // Access the Chat object
-    $bot->chat();
-});
-
-$bot->onCommand('my_chat', function (Nutgram $bot) {
-    $bot->sendMessage('Your chat id is ' . $bot->chatId());
-});
-
-$bot->run();
-```
-
-### Available helpers
-
-| Method                 | Return type           | Description                                                                   |
-|------------------------|-----------------------|-------------------------------------------------------------------------------|
-| `update()`             | `?Update`             | The current `Update` object.                                                  |
-| `chatId()`             | `?int`                | The current `chat_id` if available, `null` otherwise.                         |
-| `chat()`               | `?Chat`               | The current `Chat` if available, `null` otherwise.                            |
-| `userId()`             | `?int`                | The current `from`.`id` if available, `null` otherwise.                       |
-| `user()`               | `?User`               | The current `User` (`from` Telegram's object) if available, `null` otherwise. |
-| `messageId()`          | `?int`                | The current `message`.`message_id` if available, `null` otherwise.            |
-| `message()`            | `?Message`            | The current `Message` if available, `null` otherwise.                         |
-| `isCallbackQuery()`    | `bool`                | If the current update contains a `callback_query`.                            |
-| `callbackQuery()`      | `?CallbackQuery`      | The current `CallbackQuery` if available, `null` otherwise.                   |
-| `isInlineQuery()`      | `bool`                | If the current update contains an `inline_query`.                             |
-| `inlineQuery()`        | `?InlineQuery`        | The current `InlineQuery` if available, `null` otherwise.                     |
-| `chosenInlineResult()` | `?ChosenInlineResult` | The current `ChosenInlineResult` if available, `null` otherwise.              |
-| `shippingQuery()`      | `?ShippingQuery`      | The current `ShippingQuery` if available, `null` otherwise.                   |
-| `isPreCheckoutQuery()` | `bool`                | If the current update contains a `pre_checkout_query`.                        |
-| `preCheckoutQuery()`   | `?PreCheckoutQuery`   | The current `PreCheckoutQuery` if available, `null` otherwise.                |
-| `poll()`               | `?Poll`               | The current `Poll` if available, `null` otherwise.                            |
-| `pollAnswer()`         | `?PollAnswer`         | The current `PollAnswer` if available, `null` otherwise.                      |
-| `isMyChatMember()`     | `bool`                | If the current `ChatMemberUpdated` is in the `my_chat_member`.                |
-| `chatMember()`         | `?ChatMemberUpdated`  | The current `ChatMemberUpdated` if available, `null` otherwise.               |
-
-## Persisting data
-
-The framework gives you the ability to store data based on the update context: you can store data as **globally**
-or **per-user**:
-
-```php
-use SergiX44\Nutgram\Nutgram;
-
-$bot = new Nutgram($_ENV['TOKEN']);
-
-$bot->setGlobalData('mykey', 'Hi!');
-$bot->setUserData('mykey', 'Ciao!', $userId);
-
-$value = $bot->getGlobalData('mykey'); // Hi!
-$value = $bot->getUserData('mykey', $userId); // Ciao!
-
-// when used inside a context, the $userId can be omitted.
-$bot->onCommand('help', function (Nutgram $bot) {
-    $bot->setUserData('mykey', 'called help!');
-    $value = $bot->getUserData('mykey'); // called help!
-});
-
-$bot->run();
-```
-
-:::tip
-If you need to persist data on disk, be sure to choose an appropriate cache adapter!
-:::
-
-### Available methods
-
-<div class="margin-bottom--md">
-    <img style={{verticalAlign: 'middle'}} src="https://img.shields.io/badge/-GLOBALLY-brightgreen"/>&nbsp;
-    <code>getGlobalData($key, $default = null)</code><br/>
-    Returns the data associated to the <code>$key</code>, if null <code>$default</code> is returned.
-</div>
-
-<div class="margin-bottom--md">
-    <img style={{verticalAlign: 'middle'}} src="https://img.shields.io/badge/-GLOBALLY-brightgreen"/>&nbsp;
-    <code>setGlobalData($key, $value, DateInterval|int|null $ttl = null)</code><br/>
-    Returns <code>bool</code>
-</div>
-
-<div class="margin-bottom--md">
-    <img style={{verticalAlign: 'middle'}} src="https://img.shields.io/badge/-GLOBALLY-brightgreen"/>&nbsp;
-    <code>deleteGlobalData($key)</code><br/>
-    Returns <code>bool</code>
-</div>
-
-<div class="margin-bottom--md">
-    <img style={{verticalAlign: 'middle'}} src="https://img.shields.io/badge/-PER--USER-blue"/>&nbsp;
-    <code>getUserData($key, ?int $userId = null, $default = null)</code><br/>
-    Returns the data associated to the <code>$key</code>, if null <code>$default</code> is returned.
-</div>
-
-<div class="margin-bottom--md">
-    <img style={{verticalAlign: 'middle'}} src="https://img.shields.io/badge/-PER--USER-blue"/>&nbsp;
-    <code>setUserData($key, $value, ?int $userId = null, DateInterval|int|null $ttl = null)</code><br/>
-    Returns <code>bool</code>
-</div>
-
-<div class="margin-bottom--md">
-    <img style={{verticalAlign: 'middle'}} src="https://img.shields.io/badge/-PER--USER-blue"/>&nbsp;
-    <code>deleteUserData($key, ?int $userId = null)</code><br/>
-    Returns <code>bool</code>
-</div>