PhpBotFramework

Cadre de robot Php

PhpBotFramework est un framework fiable et complet pour l'API Telegram Bot avec prise en charge des API de paiement .

Conçu pour être rapide et facile à utiliser, il fournit toutes les fonctionnalités dont un utilisateur a besoin pour commencer à développer des robots Telegram.

Usage

 

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

Caractéristiques

• Modulaire : prenez uniquement ce dont vous avez besoin
• Requêtes HTTP flexibles avec Guzzle
• Conçu pour être rapide et facile à utiliser
• Prise en charge des mises à jour locales et des webhooks
• Prise en charge des méthodes API les plus importantes
• Système de poignée de commande pour les messages et les requêtes de rappel
• Traitement basé sur le type de mise à jour
• Création facile d'un clavier en ligne
• Gestionnaire des résultats de requête en ligne
• Support et installations de base de données
• Prise en charge de Redis
• Prise en charge des robots multilingues
• Prise en charge des états des robots
• Télécharger des fichiers locaux
• Très documenté

Conditions requises

• PHP >= 7.0
• php-mbstring
• Composer (pour installer ce package et ceux requis)
• Serveur Web : requis pour le webhook (nous recommandons nginx)
• Certificat SSL : requis pour le webhook (suivez ces étapes pour créer un certificat auto-signé ou utilisez Let's Encrypt)

Installation

Vous pouvez installer PhpBotFramework à l'aide de Composer .

Allez dans le dossier de votre projet et tapez :

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

Documentation

Consultez la documentation pour en savoir plus sur PhpBotFramework.

FAQ

• Pourquoi n'implémentons-nous pas de requêtes asynchrones ?

  Nous utilisons Guzzle afin de lancer des requêtes HTTP vers l'API Telegram Bot.

  Malheureusement, il n'implémente pas de véritables requêtes asynchrones mais une sorte de .

  Jetez un œil à ce problème pour plus d’informations.

• Pourquoi n'y a-t-il pas de paramètre chat_id à transmettre pour les méthodes API ?

  PhpBotFramework est suffisamment "intelligent" pour le définir comme ID d'utilisateur, de groupe ou de canal actuel. La plupart des frameworks vous obligent à spécifier l'ID de chat pour chaque appel de méthode, mais PhpBotFramework le fait pour vous en appelant la plupart des méthodes API sur le chat en cours.

Exemples

Vous pouvez trouver une liste d’exemples de robots directement dans le dossier examples/ .

Tous les exemples répertoriés ici sont entièrement fonctionnels : vous n'avez besoin que d'un jeton de bot Telegram valide.

Réalisé avec PhpBotFramework

• MyAddressBookBot : essayez-le sur Telegram
• Giveaways_Bot : essayez-le sur Telegram

Essai

PhpBotFramework est livré avec une suite de tests que vous pouvez exécuter à l'aide de PHPUnit .

Vous devez définir la variable d'environnement MOCK_SERVER_PORT qui indique à PhpBotFramework sur quel port exécute le serveur fictif qui permet d'exécuter les tests.

 export MOCK_SERVER_PORT=9696

Vous pouvez maintenant exécuter le serveur fictif :

./start_mock_server.sh

Et exécutez la suite de tests :

php vendor/bin/phpunit

Auteur

Ce cadre est développé et maintenu par Danilo Spinella et Dom Corvasce.

Licence

PhpBotFramework est publié sous GNU Lesser General Public License v3.

Vous pouvez copier, distribuer et modifier le logiciel à condition que les modifications soient décrites et sous licence gratuite sous LGPL-3. Les travaux dérivés (y compris les modifications) ne peuvent être redistribués que sous LGPL-3, mais les applications qui utilisent le framework ne sont pas obligées de l'être.