danyspin97/php-bot-framework

PhpBotFramework is a framework for Telegram Bots' APIs.

v2.0.2 2017-05-31 21:01 UTC

This package is not auto-updated.

Last update: 2021-10-22 08:22:51 UTC


README

Total Downloads Latest Stable Version Build Status Codacy Badge Scrutinizer Code Quality Code Coverage PHPStan License

logo.png

PhpBotFramework is a reliable and complete framework for Telegram Bot API with support to Payments APIs.

Designed to be fast and easy to use, it provides all the features a user need in order to start developing Telegram bots.

Usage

<?php

// 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);

Features

  • Modular: take only what you need
  • Flexible HTTP requests with Guzzle
  • Designed to be fast and easy to use
  • Support for local updates and webhooks
  • Support for the most important API methods
  • Command-handle system for messages and callback queries
  • Update type based processing
  • Easy inline keyboard creation
  • Inline query results' handler
  • Database support and facilities
  • Redis support
  • Support for multilanguage bots
  • Support for bot states
  • Upload local files
  • Highly-documented

Requisites

  • PHP >= 7.0
  • php-mbstring
  • Composer (to install this package and the required ones)
  • Web server: required for webhook (we recommend nginx)
  • SSL certificate: required for webhook (follow these steps to make a self-signed certificate or use Let's Encrypt)

Installation

You can install PhpBotFramework using Composer.

Go to your project's folder and type:

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

Documentation

Check the documentation for learning more about PhpBotFramework.

FAQ

  • Why we don't implement asynchronous requests?

    We use Guzzle in order to fire HTTP requests to Telegram Bot API.

    Unfortunately it doesn't implement real asynchronous requests but a sort of.

    Take a look to this issue for more information.

  • Why there isn't a chat_id parameter to pass for API methods?

    PhpBotFramework is "smart" enough to set it as the current user, group or channel ID. Most of the frameworks out there requires you to specify the chat ID for every method's call but PhpBotFramework does it for you calling most API methods on the current chat.

Examples

You can find a list of examples bot right in examples/ folder.

All examples listed here are fully functional: you only need a valid Telegram bot token.

Made with PhpBotFramework

Testing

PhpBotFramework comes with a test suite you can run using PHPUnit.

You need to set MOCK_SERVER_PORT environment variable which tells PhpBotFramework on which port run the mock server that allows the tests to be executed.

export MOCK_SERVER_PORT=9696

Now you can run the run the mock server:

./start_mock_server.sh

And run the test suite:

php vendor/bin/phpunit

Author

This framework is developed and mantained by Danilo Spinella and Dom Corvasce.

License

PhpBotFramework is released under GNU Lesser General Public License v3.

You may copy, distribute and modify the software provided that modifications are described and licensed for free under LGPL-3. Derivatives works (including modifications) can only be redistributed under LGPL-3, but applications that use the framework don't have to be.