PhpBotFramework

PHP-бот-фреймворк

PhpBotFramework — это надежная и полная платформа для Telegram Bot API с поддержкой API платежей .

Разработанный как быстрый и простой в использовании, он предоставляет все функции, необходимые пользователю для начала разработки ботов Telegram.

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

 

// Include the framework
require ' ./vendor/autoload.php ' ;

// Create a bot
$ bot = new PhpBotFramework  Bot ( " token " );

// Create a command that will be triggered everytime the user send `/start`
$ start_command = new PhpBotFramework  Commands  MessageCommand ( " start " ,
    function ( $ bot , $ message ) {
        // Reply with a message
        $ bot -> sendMessage ( " Hello, folks! " );
    }
);

$ bot -> addCommand ( $ start_command );

// A shortcut for message commands.

$ bot -> addMessageCommand ( ' about ' , function ( $ bot , $ message ) {
  $ bot -> sendMessage ( ' Powered by PhpBotFramework ' );
});

// Receive updates from Telegram using getUpdates
$ bot -> run ( GETUPDATES );

Функции

• Модульность: берите только то, что вам нужно
• Гибкие HTTP-запросы с Guzzle
• Создан для быстрого и простого использования
• Поддержка локальных обновлений и веб-перехватчиков
• Поддержка наиболее важных методов API
• Система команд-дескрипторов для сообщений и запросов обратного вызова
• Обработка на основе типа обновления
• Простое создание встроенной клавиатуры
• Обработчик результатов встроенного запроса
• Поддержка и возможности базы данных
• Поддержка Redis
• Поддержка многоязычных ботов
• Поддержка состояний ботов
• Загрузить локальные файлы
• Хорошо документировано

Реквизиты

• PHP >= 7.0
• php-mbstring
• Composer (для установки этого пакета и необходимых)
• Веб-сервер: требуется для веб-перехватчика (мы рекомендуем nginx)
• Сертификат SSL: требуется для веб-перехватчика (выполните следующие действия, чтобы создать самозаверяющий сертификат или использовать Let’s Encrypt).

Установка

Вы можете установить PhpBotFramework с помощью Composer .

Перейдите в папку вашего проекта и введите:

composer require danyspin97/php-bot-framework
composer install --no-dev

Документация

Ознакомьтесь с документацией, чтобы узнать больше о PhpBotFramework.

Часто задаваемые вопросы

• Почему мы не реализуем асинхронные запросы?

  Мы используем Guzzle для отправки HTTP-запросов к Telegram Bot API.

  К сожалению, он реализует не настоящие асинхронные запросы, а своего рода .

  Ознакомьтесь с этой проблемой для получения дополнительной информации.

• Почему для методов API не передается chat_id ?

  PhpBotFramework достаточно «умен», чтобы установить его в качестве текущего идентификатора пользователя, группы или канала. Большинство существующих фреймворков требуют указания идентификатора чата для каждого вызова метода, но PhpBotFramework делает это для вызова большинства методов API в текущем чате.

Примеры

Список примеров бота вы можете найти прямо в папке examples/ .

Все приведенные здесь примеры полностью функциональны: вам нужен только действующий токен бота Telegram .

Сделано с помощью PhpBotFramework.

• MyAddressBookBot: попробуйте в Telegram
• Giveaways_Bot: попробуйте в Telegram

Тестирование

PhpBotFramework поставляется с набором тестов, который можно запустить с помощью PHPUnit .

Вам необходимо установить переменную среды MOCK_SERVER_PORT , которая сообщает PhpBotFramework, на каком порту запускать макетный сервер , позволяющий выполнять тесты.

 export MOCK_SERVER_PORT=9696

Теперь вы можете запустить макет сервера:

./start_mock_server.sh

И запустите набор тестов:

php vendor/bin/phpunit

Автор

Эта структура разработана и поддерживается Данило Спинеллой и Домом Корваске.

Лицензия

PhpBotFramework выпускается под лицензией GNU Lesser General Public License v3.

Вы можете копировать, распространять и модифицировать программное обеспечение при условии, что модификации описаны и лицензируются бесплатно в соответствии с LGPL-3. Производные работы (включая модификации) могут распространяться только в соответствии с LGPL-3, но приложения, использующие эту структуру, не обязаны.