shanginn/telegram-bot-api-framework

Telegram bot API framework

5.0.0 2024-12-22 06:07 UTC

README

Warning

Проект находится в активной разработке и не рекомендуется к использованию в продакшене.

Это простой фреймворк для создания Telegram ботов любой сложности на PHP.

Главной мотивацией было написание инструмента для работы с API Telegram со строгой типизацией.

Все типы для API лежат в соседнем проекте: bindings и могут быть использованы и без этого фреймворка. Их будет достаточно, если вы хотите отправлять запросы и получать типизированные ответы.

В фреймворке же будет чуть больше качества жизни - роуты, мидвари, хэндлеры. Event loop для работы в режиме long-polling.

Приоритет в разработке - простота использования и производительность. Есть возможность писать асинхронные хэндлеры, так как под капотом работает amphp и файберы.

Установка

composer require phenogram/framework

Использование

Простейший пример

// bot.php
<?php

require_once __DIR__ . '/vendor/autoload.php';

use Phenogram\Framework\TelegramBot;
use Phenogram\Bindings\Types\Interfaces\UpdateInterface;

$token = ''; // Ваш токен

$bot = new TelegramBot($token);
$bot->addHandler(fn (UpdateInterface $update, TelegramBot $bot) => $bot->api->sendMessage(
        chatId: $update->message->chat->id,
        text: $update->message->text
    ))
    ->supports(fn (UpdateInterface $update) => $update->message?->text !== null);

$bot->run();

Запускать через php bot.php

Вы ничего не увидите на экране, потому что даже логгер не настроен. Но бот будет работать и отвечать на любые сообщения.

TODO: дописать ридми и доку

А пока пример бота посложнее (на очень старой версии фреймворка) вы можете найти здесь