README

This package is a fork of the now-abandoned original by Yoann Celton. The architecture does not necessarily reflect best practice in the eyes of current maintainers. Incremental improvements are made as time and resources allow. Contributions are welcome.

Software License

This is a Matrix client-server SDK for php 7.4+, initially copied from matrix-org/matrix-python-sdk.

This package is still a work in progress, and at the current time, not everything has been ported:

Missing E2E encryption, need php bindings for the OLM library
Live sync
Unit tests for the client

Installation

composer require meet-kinksters/php-matrix-sdk

Usage

Client:

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

$client = new MatrixClient("http://localhost: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("http://localhost:8008", $sometoken);

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

Structure

The SDK is split into two modules: `api and client`.

API

This contains the raw HTTP API calls and has minimal business logic. You can set the access token (`token) to use for requests as well as set a custom transaction ID (txn_id`) which will be incremented for each request.

Client

This encapsulates the API module and provides object models such as `Room`.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email brad@kinksters.dating instead of using the issue tracker.

Credits

License

MIT License.

haydenwu / php-matrix-sdk

Maintainers

Details