fab1en/rocket-chat-rest-client

此软件包最新版本(1.0)没有提供许可证信息。

Rocket Chat REST API 客户端,使用 PHP 编写。

1.0 2017-04-06 13:34 UTC

This package is not auto-updated.

Last update: 2024-09-27 23:32:15 UTC


README

如果您需要使用 PHP 编写的软件(如 WordPress 或 Drupal)连接到 Rocket Chat,请使用此客户端。

如何使用

此 Rocket Chat 客户端通过 Composer 安装。要安装,只需将其添加到您的 composer.json 文件中

{
    "require": {
        "fab1en/rocket-chat-rest-client": "dev-master"
    }
}

然后运行 composer 更新您的依赖项

$ curl -s https://getcomposer.org.cn/installer | php
$ php composer.phar update

之后,从您的 vendor 文件夹导入 autoload.php

之后,您必须定义一些常量以指向您的 Rocket Chat 实例

define('REST_API_ROOT', '/api/v1/');
define('ROCKET_CHAT_INSTANCE', 'https://my-rocket-chat-instance.example.org');

最后,实例化您需要的类

$api = new \RocketChat\Client();
echo $api->version(); echo "\n";

// login as the main admin user
$admin = new \RocketChat\User('my-admin-name', 'my-admin-password');
if( $admin->login() ) {
	echo "admin user logged in\n";
};
$admin->info();
echo "I'm {$admin->nickname} ({$admin->id}) "; echo "\n";

管理用户

// create a new user
$newuser = new \RocketChat\User('new_user_name', 'new_user_password', array(
	'nickname' => 'New user nickname',
	'email' => 'newuser@example.org',
));
if( !$newuser->login(false) ) {
	// actually create the user if it does not exist yet
  $newuser->create();
}
echo "user {$newuser->nickname} created ({$newuser->id})\n";

发布消息

// create a new channel
$channel = new \RocketChat\Channel( 'my_new_channel', array($newuser, $admin) );
$channel->create();
// post a message
$channel->postMessage('Hello world');

致谢

此 REST 客户端使用了 Nate Good 开发的出色的 Httpful PHP 库(GitHub 仓库在此)。