PhpBotFramework

Phpボットフレームワーク

PhpBotFramework は、Payments APIをサポートする Telegram Bot 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 );

特徴

• モジュラー: 必要なものだけを取り出す
• Guzzle による柔軟な HTTP リクエスト
• 速くて使いやすいように設計されています
• ローカルアップデートとWebhookのサポート
• 最も重要な API メソッドのサポート
• メッセージおよびコールバック クエリ用のコマンド ハンドル システム
• 更新タイプベースの処理
• 簡単なインラインキーボード作成
• インラインクエリ結果のハンドラー
• データベースのサポートと機能
• Redisのサポート
• 多言語ボットのサポート
• ボット状態のサポート
• ローカルファイルをアップロードする
• 高度に文書化された

必要条件

• PHP >= 7.0
• php-mbstring
• Composer (このパッケージと必要なパッケージをインストールするため)
• Web サーバー: Webhook に必要(nginx を推奨)
• SSL 証明書: Webhook に必要(次の手順に従って自己署名証明書を作成するか、Let's Encrypt を使用します)

インストール

Composer を使用して PhpBotFramework をインストールできます。

プロジェクトのフォルダーに移動し、次のように入力します。

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

ドキュメント

PhpBotFramework の詳細については、ドキュメントを確認してください。

よくある質問

• なぜ非同期リクエストを実装しないのでしょうか?

  Telegram Bot API に HTTP リクエストを送信するために Guzzle を使用します。

  残念ながら、実際の非同期リクエストは実装されていませんが、一種の.

  詳細については、この問題を参照してください。

• API メソッドに渡すchat_idパラメーターがないのはなぜですか?

  PhpBotFramework は、現在のユーザー、グループ、またはチャネル ID として設定できるほど「賢い」です。世の中のほとんどのフレームワークでは、すべてのメソッド呼び出しに対してチャット ID を指定する必要がありますが、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

著者

このフレームワークは、Danilo Spinella と Dom Corvasce によって開発および管理されています。

ライセンス

PhpBotFramework は、GNU Lesser General Public License v3 に基づいてリリースされています。

LGPL-3 に基づいて変更内容が説明され、無償でライセンスが付与されている場合に限り、ソフトウェアをコピー、配布、変更することができます。派生作品 (改変を含む) は LGPL-3 の下でのみ再配布できますが、フレームワークを使用するアプリケーションはその必要はありません。