BotMan

如果你想学习如何自己创建可重用的PHP包，请查看我即将推出的PHP包开发视频课程。

关于BotMan

BotMan是一个与框架无关的PHP库，旨在简化为多个消息平台开发创新机器人任务，这些平台包括Slack、Telegram、Microsoft Bot Framework、Nexmo、HipChat、Facebook Messenger以及WeChat。

$botman->hears('我想用PHP开发跨平台机器人！', function (BotMan $bot) {
    $bot->reply('你来对地方了！');
});

如果你想学习如何自己创建可重用的PHP包，请查看我即将推出的PHP包开发视频课程。

文档

你可以在https://botman.io找到BotMan的文档。

独立配置

如果你在独立的Laravel应用中安装BotMan，可以使用以下命令发布配置文件：

php artisan vendor:publish --tag=config --provider="BotMan\BotMan\BotManServiceProvider"

支持开发

你喜欢这个项目吗？请通过捐赠来支持它

• PayPal: 捐赠
• Open Collective: 成为赞助者
• Patreon: 成为赞助者

贡献

详情请参阅CONTRIBUTING。

安全漏洞

如果你发现BotMan中的安全漏洞，请发送电子邮件至Marcel Pociot的邮箱m.pociot@gmail.com。所有安全漏洞都将得到及时处理。

许可证

BotMan是根据MIT许可证条款发布的自由软件。

BotMan 快速上手指南

BotMan 是一个与框架无关的 PHP 库，旨在简化为多个消息平台（如 Slack、Telegram、Facebook Messenger、微信等）开发聊天机器人的任务。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows (推荐 Linux/macOS 生产环境)
• PHP 版本：PHP 7.0 或更高版本
• 依赖管理：已安装 Composer
• 消息平台账号：根据目标平台（如 Telegram Bot Token, Facebook Page Access Token 等）准备好相应的凭证

国内加速建议：如果 Composer 下载速度慢，建议先配置国内镜像源（如阿里云或腾讯云镜像）。

composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/

安装步骤

1. 创建项目并安装 BotMan

您可以直接在现有项目中安装，或创建一个新项目。使用 Composer 安装核心包：

composer require botman/botman

2. 集成到 Laravel (可选但推荐)

如果您在 Laravel 项目中使用 BotMan，安装后需要发布配置文件和服务提供者。运行以下命令：

php artisan vendor:publish --tag=config --provider="BotMan\BotMan\BotManServiceProvider"

这将生成 config/botman.php 配置文件，您可以在其中设置不同驱动的参数。

3. 安装特定平台驱动

BotMan 核心包不包含具体平台的驱动，您需要根据目标平台安装对应的驱动包。例如：

• Telegram: composer require botman/driver-telegram
• Facebook Messenger: composer require botman/driver-facebook
• Slack: composer require botman/driver-slack

安装完成后，记得在 config/botman.php 中启用相应驱动并填入 API 密钥。

基本使用

BotMan 的核心逻辑非常简洁，主要通过 hears 方法监听用户消息并做出回复。以下是一个最基础的独立使用示例：

<?php

require_once 'vendor/autoload.php';

use BotMan\BotMan\BotMan;
use BotMan\BotMan\BotManFactory;

// 创建 BotMan 实例 (需配合具体的驱动配置数组)
$botman = BotManFactory::create([]);

// 定义监听规则
$botman->hears('I want cross-platform bots with PHP!', function (BotMan $bot) {
    $bot->reply('Look no further!');
});

// 处理所有其他消息的默认规则
$botman->fallback(function (BotMan $bot) {
    $bot->reply('Sorry, I did not understand that.');
});

// 运行机器人
$botman->listen();

代码说明：

1. 初始化：使用 BotManFactory::create() 创建实例，传入包含驱动配置的数组。
2. 监听消息：$botman->hears() 第一个参数是正则表达式或关键词，第二个参数是回调函数。
3. 回复消息：在回调函数中使用 $bot->reply() 发送响应。
4. 启动监听：调用 $botman->listen() 开始处理传入的请求（通常由 Webhook 触发）。

对于更复杂的对话流程、缓存集成或中间件使用，请参考官方文档：https://botman.io。