HipChat PHP 库技术文档

1. 安装指南

使用 Composer 安装

HipChat-PHP 库可以通过 Composer 进行安装。首先，确保你已经安装了 Composer。然后，在你的 composer.json 文件中添加以下内容：

{
    "require": {
        "hipchat/hipchat-php": ">=1.0.0"
    }
}

保存文件后，运行以下命令来安装依赖：

composer install

Composer 会自动处理自动加载，因此你无需手动加载库文件。

2. 项目使用说明

初始化 HipChat 客户端

首先，你需要获取一个 API Token。然后，使用该 Token 初始化 HipChat 客户端：

$token = '<your api token>';
$hc = new HipChat\HipChat($token);

获取房间列表

你可以使用以下代码获取所有房间的列表：

foreach ($hc->get_rooms() as $room) {
  echo " - $room->room_id = $room->name\n";
}

发送消息到房间

你可以使用 message_room 方法向指定房间发送消息：

$hc->message_room('Development', 'API', 'This is just a test message!');

3. 项目 API 使用文档

get_rooms()

获取所有房间的列表。返回一个包含房间信息的数组。

message_room($room, $from, $message)

向指定房间发送消息。

• $room：目标房间的名称或 ID。
• $from：发送者的名称。
• $message：要发送的消息内容。

4. 项目安装方式

HipChat-PHP 库的安装方式非常简单，只需通过 Composer 进行安装。具体步骤如下：

1. 在 composer.json 文件中添加依赖：

   {
       "require": {
           "hipchat/hipchat-php": ">=1.0.0"
       }
   }
   

2. 运行 composer install 命令进行安装。

安装完成后，你就可以在项目中使用 HipChat-PHP 库来与 HipChat 的 REST API 进行交互了。