Skip to content
This repository has been archived by the owner on Nov 21, 2023. It is now read-only.
/ HardBotter Public archive

PHPが書けないと作れないTwitterボット作成支援ライブラリ

License

Notifications You must be signed in to change notification settings

mpyw-junks/HardBotter

Repository files navigation

HardBotter Build Status Coverage Status Scrutinizer Code Quality

「PHPが書けないと作れない」Cron系のTwitterボット作成支援ライブラリです.自由な書き方ができ,カスタマイズ性が高いのが特長です.

  • PHP 5.5 以降 で動作します.
  • Twitterクライアントとしては,TwistOAuth の後継である Cowitter を利用します.Generatorを活用して非同期処理をバリバリ書けます.
  • 「PHPが書けなくても作れる」と称するEasyBotterとは何の関係もありません.

インストール

composer require mpyw/hardbotter:^1.0

主なソースファイル

src/Bot.php

Bot クラスが記述されたファイルです.

  • このファイルを読む必要はありません.
  • このクラスは以下に示す2つのインタフェースを実装しています.

Bot クラスが実装している必須メソッド群です.

  • 説明書となるのでソースを読んでください.

Bot クラスが実装しているヘルパーメソッド群です.

  • 説明書となるのでソースを読んでください.
  • 必須ではありませんが,使用頻度が高いものも多く含みます.

サンプル

サンプルが examples/run.php にあります.設定ファイルには vlucas/phpdotenv を利用しています.

examples/.env を生成して

CONSUMER_KEY="****"
CONSUMER_SECRET="****"
ACCESS_TOKEN="****"
ACCESS_TOKEN_SECRET="****"
TIMEZONE="Asia/Tokyo"

のように編集した上で, examples/run.php を定期実行してください.

備考

このライブラリはcronで定期的に動作させるBot向けのものですが,ストリーミングAPIを利用したリアルタイム系のBotにも対応できます.