PHP SDK for Matrix.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Chris Burgess df5e341a80 chore: Remove support for PHP < 7.4 5 months ago
src Fix misspellings and deprecations in HTTP API class 5 months ago
tests correct assertion to check string containment 5 months ago
.editorconfig Initial Commit 5 months ago
.gitattributes Initial Commit 5 months ago
.gitignore Adjusting settings 5 months ago
.scrutinizer.yml Initial Commit 5 months ago
.travis.yml chore: Remove support for PHP < 7.4 5 months ago
CHANGELOG.md Prefilling info 5 months ago
CODE_OF_CONDUCT.md Prefilling info 5 months ago
CONTRIBUTING.md Prefilling info 5 months ago
ISSUE_TEMPLATE.md Initial Commit 5 months ago
LICENSE.md Prefilling info 5 months ago
PULL_REQUEST_TEMPLATE.md Initial Commit 5 months ago
README.md Update README to reference packagist and replace must also be fully lowercase 5 months ago
composer.json PHP 8 5 months ago
phpunit.xml.dist Preparing for tests 5 months ago
prefill.php Initial Commit 5 months ago

README.md

Matrix client SDK for php

Software License

This is a Matrix client-server SDK for php 7.0+, mostly 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
  • No live sync, because I'm not going to go into php multithreading
  • Unit tests for the client

Installation

composer require aryess/php-matrix-sdk

Usage

Client:

require('vendor/autoload.php');
use Aryess\PhpMatrixSdk\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 Aryess\PhpMatrixSdk\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 aryess@github.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.