lordgurke/php-matrix-sdk

PHP SDK，用于与 Matrix/Synapse 交互。

维护者

详细信息

github.com/lordgurke/php-matrix-sdk

主页

源代码

问题

安装: 4

依赖: 0

建议者: 0

安全性: 0

星级: 0

关注者: 0

分支: 8

公开问题: 0

dev-master / 1.0.x-dev 2023-04-11 22:44 UTC

Requires

Requires (Dev)

Replaces

MIT 41ae5b6dab2ea6cec3c8dd0b9ad6a57916d7f486

  • Yoann Celton <aryess.woop@github.com>
  • Brad Jones <brad.woop@kinksters.dating>
  • Max Grobecker <max.woop@maxderdepp.de>

phpmatrixMatrix ChatSynapse

This package is auto-updated.

Last update: 2024-09-12 01:57:30 UTC

README

Software License Software License

这是一个针对 php 7.4+ 的 Matrix 客户端-服务器 SDK，最初是从 matrix-org/matrix-python-sdk 拷贝的，然后由 lordgurke 进行分支以添加改进和修复错误。

这个包仍在开发中，目前还没有完全移植

  • 缺少端到端加密，需要 OLM 库的 PHP 绑定
  • 实时同步
  • 客户端的单元测试

安装

目前不公开！

composer require lordgurke/php-matrix-sdk:master-dev

用法

客户端

require('vendor/autoload.php');
use MatrixPhp\MatrixClient;

$client = new MatrixClient("https://:8008");

// New user
$token = $client->registerWithPassword("foobar", "monkey");

// Existing user
$token = $client->login("foobar", "monkey");

$room = $client->createRoom("my_room_alias");
$room->sendText("Hello!");

API

require('vendor/autoload.php');
use MatrixPhp\MatrixHttpApi;

$matrix = new MatrixHttpApi("https://:8008", $sometoken);

$response = $matrix->sendMessage("!roomid:matrix.org", "Hello!");

结构

SDK 分为两个模块：api 和 client。

API

这包含原始的 HTTP API 调用，具有最少的业务逻辑。您还可以设置用于请求的访问令牌（token），以及设置自定义事务 ID（txn_id），该 ID 将在每次请求时递增。

客户端

这封装了 API 模块，并提供对象模型，如 Room。

贡献

有关详细信息，请参阅 CONTRIBUTING。

安全性

如果您发现任何安全相关的问题，请通过电子邮件 brad@kinksters.dating 而不是使用问题跟踪器。

鸣谢

许可证

MIT 许可证.