From b58dc8b2ed66ccb4e0193798df440531b5929771 Mon Sep 17 00:00:00 2001 From: Alex Date: Sat, 16 Aug 2025 21:07:17 +0300 Subject: [PATCH] Documentation --- README.md | 26 +++++++++++++++++++++++--- docs/README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 67 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b80ff1b..c99341c 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,20 @@ composer require bushlanov-dev/max-bot-api-client-php ``` +Пользователи Laravel могут зарегистрировать сервис провайдер и фасад в `config/app.php`: + +```php +'providers' => [ + // ... + BushlanovDev\MaxMessengerBot\Laravel\MaxBotServiceProvider::class, +], +// ... +'aliases' => [ + // ... + 'MaxBot' => BushlanovDev\MaxMessengerBot\Laravel\MaxBotFacade::class, +], +``` + ### Использование Отправка сообщения с клавиатурой @@ -51,6 +65,12 @@ $api->sendMessage( ); ``` +Отправка сообщения с использованием фасада Laravel + +```php +MaxBot::sendUserMessage(123456, 'Привет из Laravel!'); +``` + Создание универсального обработчика обновлений ```php @@ -101,12 +121,12 @@ $handler->handle(); #### Bots -- [x] `GET /me` (`getBotInfo`) - *Получение информации о боте.* -- [x] `PATCH /me` (`editBotInfo`) - *Редактирование информации о боте.* +- [x] `GET /me` (`getBotInfo`) - [*Получение информации о боте.*](./docs/README.md#Получение-информации-о-боте) +- [x] `PATCH /me` (`editBotInfo`) - [*Редактирование информации о боте.*](./docs/README.md#Редактирование-информации-о-боте) #### Chats -- [x] `GET /chats` (`getChats`) - *Получение списка всех чатов бота.* +- [x] `GET /chats` (`getChats`) - [*Получение списка всех чатов бота.*](./docs/README.md#Получение-списка-всех-чатов-бота) - [x] `GET /chats/{chatLink}` (`getChatByLink`) - *Получение информации о чате по ссылке.* - [x] `GET /chats/{chatId}` (`getChat`) - *Получение информации о чате по ID.* - [x] `PATCH /chats/{chatId}` (`editChat`) - *Редактирование информации о чате.* diff --git a/docs/README.md b/docs/README.md index 7ea73d2..62fdcd2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,12 +1,13 @@ - [Быстрый старт](#Быстрый-старт) - [Получение токена](#Получение-токена) - [Установка библиотеки](#Установка-библиотеки) + - [Установка библиотеки в Laravel](#Установка-библиотеки-в-Laravel) - [Инициализация бота](#Инициализация-бота) - [Информация о боте](#Информация-о-боте) - `GET /me` (`getBotInfo`) - [*Получение информации о боте.*](#Получение-информации-о-боте) - `PATCH /me` (`editBotInfo`) - [*Редактирование информации о боте.*](#Редактирование-информации-о-боте) -- Чаты - - `GET /chats` (`getChats`) - *Получение списка всех чатов бота.* +- [Чаты](#Чаты) + - `GET /chats` (`getChats`) - [*Получение списка всех чатов бота.*](#Получение-списка-всех-чатов-бота) - `GET /chats/{chatLink}` (`getChatByLink`) - *Получение информации о чате по ссылке.* - `GET /chats/{chatId}` (`getChat`) - *Получение информации о чате по ID.* - `PATCH /chats/{chatId}` (`editChat`) - *Редактирование информации о чате.* @@ -54,6 +55,36 @@ composer require bushlanov-dev/max-bot-api-client-php ``` +### Установка библиотеки в Laravel + +Пользователи Laravel могут зарегистрировать сервис провайдер и фасад в `config/app.php`: + +```php +'providers' => [ + // ... + BushlanovDev\MaxMessengerBot\Laravel\MaxBotServiceProvider::class, +], +// ... +'aliases' => [ + // ... + 'MaxBot' => BushlanovDev\MaxMessengerBot\Laravel\MaxBotFacade::class, +], +``` + +При не необходимости опубликовать конфиг выполните следующую команду + +```bash +php artisan vendor:publish --provider="BushlanovDev\MaxMessengerBot\Laravel\MaxBotServiceProvider" +``` + +Для работы вам потребуется внести следующие настройки в `.env` + +```env +MAXBOT_ACCESS_TOKEN=your_bot_access_token_here +MAXBOT_WEBHOOK_SECRET=your_webhook_secret_here +MAXBOT_LOGGING_ENABLED=true +``` + ### Инициализация бота Единственной обязательной настройкой является токен вашего бота. @@ -100,3 +131,14 @@ $botInfo = $api->editBotInfo( ) ); ``` + +## Чаты + +### Получение списка всех чатов бота + +```php +$api->getChats( + count: 10, // Количество запрашиваемых чатов + marker: 2, // Указатель на следующую страницу данных. Для первой страницы передайте null +); +```