README

Warning

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

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

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

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

Текущая поддерживаемая версия Telegram bot API - v9.0.0

В фреймворке же будет чуть больше качества жизни - роуты, мидвари, хэндлеры. 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 = getenv('TELEGRAM_BOT_TOKEN'); // Ваш токен, полученный у @BotFather например 7245389610:AAFHBDYMKpWxYu5JrSnTlQRD9bvPz0OgHkLf

$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

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

Отправка локальных файлов

Из документации видно, что файлы можно отправлять 3 способами:

Указать URL
Указать ID файла
Загрузить локальный файл

С отправкой через URL и ID файла всё просто - укажите эти параметры в запросе строками. Загрузить локальный файл тоже просто, в фреймворке есть 3 способа это сделать:

Указать путь до файла в LocalFile
Передать (amphp поток)[https://amphp.org/byte-stream] в ReadableStreamFile
Отправить уже прочитанный файл в виде строки через BufferedFile

Рассмотрим отправку файлов на примере sendDocument.

// bot.php
<?php

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

use Phenogram\Framework\TelegramBot;
use Phenogram\Framework\Type\LocalFile;
use Phenogram\Framework\Type\ReadableStreamFile;
use Phenogram\Framework\Type\BufferedFile;

$token = getenv('TELEGRAM_BOT_TOKEN');
$bot = new TelegramBot($token);

$chatId = 123456789; // ID чата, куда отправляем файл

// 1. Отправка файла по локальному пути
$bot->api->sendDocument(
    chatId: $chatId,
    document: new LocalFile(
        filepath: '../../README.md'
//        // Необязательный параметр с именем файла. Если отсутствует, будет использовано имя файла из пути
//        filename: 'документация.md',
    ),
);

// 2. Отправка файла через поток
$bot->api->sendDocument(
    chatId: $chatId,
    document: new ReadableStreamFile(
        stream: \Amp\File\openFile('../../README.md', 'r'),
        filename: 'README.md', // Имя файла обязательно
    ),
);

// 3. Отправка файла через строку
$bot->api->sendDocument(
    chatId: $chatId,
    document: new BufferedFile(
        content: 'Здесь может быть ваша реклама',
        filename: 'README.md', // Имя файла обязательно
    ),
);

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

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

shanginn / telegram-bot-api-framework

Maintainers

Details