meet-kinksters / php-matrix-sdk
PHP SDK,用于与 Matrix/Synapse 交互。
dev-master / 1.0.x-dev
2024-06-24 17:03 UTC
Requires
- php: ~7.4|^8
- ext-json: *
- guzzlehttp/guzzle: ^6.3|^7
- rappasoft/laravel-helpers: ^1.0
Requires (Dev)
- phpunit/phpunit: >=5.4.3
Replaces
- aryess/php-matrix-sdk: dev-master
- aryess/phpmatrixsdk: dev-master
This package is auto-updated.
Last update: 2024-09-24 17:32:28 UTC
README
此包是已废弃的原始版本Yoann Celton的分支。其架构不一定反映当前维护者的最佳实践。随着时间的推移和资源的允许,将逐步改进。欢迎贡献。
这是一个针对php 7.4+的Matrix客户端-服务器SDK,最初是从matrix-org/matrix-python-sdk复制过来的。
此包仍在开发中,目前并非所有内容都已移植
- 缺少端到端加密,需要OLM库的PHP绑定
- 实时同步
- 客户端的单元测试
安装
composer require meet-kinksters/php-matrix-sdk
用法
客户端
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将在每个请求中递增。
###Client 该模块封装API模块,并提供诸如Room
等对象模型。
贡献
请参阅CONTRIBUTING 和 CODE_OF_CONDUCT以获取详细信息。
安全
如果您发现任何安全相关的问题,请通过电子邮件brad@kinksters.dating而不是使用问题跟踪器。
致谢
- Brad Jones 在 Meet Kinksters
- Yoann Celton(初始移植)
- 所有贡献者