Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
Namespaces | |
namespace | communication_matrix |
| |
namespace | communication_matrix\local |
| |
namespace | communication_matrix\local\spec |
| |
namespace | communication_matrix\local\spec\features\matrix |
| |
namespace | communication_matrix\local\spec\features\synapse |
| |
namespace | communication_matrix\privacy |
| |
Functions | |
communication_matrix::backoffice_create_users_and_rooms (array $users=[], array $rooms=[],) | |
A backoffice method to create users and rooms on our mock server. | |
communication_matrix::backoffice_get_all_rooms () | |
Fetch all rooms from the back office. | |
communication_matrix::backoffice_get_all_users () | |
A backoffice call to get all registered users from our mock server. | |
communication_matrix::backoffice_get_room () | |
Return the first room from the server. | |
communication_matrix::create_matrix_room (?string $component='core_course', ?string $itemtype='example', ?int $itemid=1, ?string $roomname=null, ?string $roomtopic=null, ?\stored_file $roomavatar=null, array $members=[], ?context $context=null,) | |
Helper to create a room. | |
communication_matrix::get_backoffice_uri (string $endpoint) | |
Get the URI of a backoffice endpoint on the mock server. | |
communication_matrix::get_matrix_access_token () | |
Get the matrix access token. | |
communication_matrix::get_matrix_room_data (string $roomid) | |
Get matrix room data from matrix server. | |
communication_matrix::get_matrix_server_url () | |
Get the mock server url. | |
communication_matrix::get_matrix_user_data (string $roomid, string $matrixuserid) | |
Get matrix user data from matrix server. | |
communication_matrix::initialise_mock_configs () | |
Initialize the mock configs in settings. | |
communication_matrix::initialise_mock_server () | |
This test requires mock server to be present. | |
communication_matrix::request (array $jsonarray=[], array $headers=[]) | |
The http request for the api call. | |
communication_matrix::reset_mock () | |
Reset the mock server. | |
xmldb_communication_matrix_upgrade ($oldversion) | |
Upgrade procedures for the matrix plugin. | |
Variables | |
$capabilities | |
$definitions | |
string string | communication_matrix::$matrixhomeserverurl |
$matrixhomeserverurl The server url of matrix synapse server | |
$plugin = 2023100400 | |
$plugin | component = 'communication_matrix' |
trait | communication_matrix::matrix_test_helper_trait |
$plugin | maturity = MATURITY_ALPHA |
$plugin | version = 2023100900 |
communication_matrix\backoffice_create_users_and_rooms | ( | array | $users = [], |
array | $rooms = [] ) |
A backoffice method to create users and rooms on our mock server.
array | $users | |
array | $rooms |
communication_matrix\backoffice_get_all_rooms | ( | ) |
Fetch all rooms from the back office.
array |
communication_matrix\backoffice_get_all_users | ( | ) |
A backoffice call to get all registered users from our mock server.
array |
communication_matrix\backoffice_get_room | ( | ) |
Return the first room from the server.
In most cases there is only one room.
stdClass |
|
protected |
Helper to create a room.
null | string | $component | |
null | string | $itemtype | |
null | int | $itemid | |
null | string | $roomname | |
null | string | $roomtopic | |
null | stored_file | $roomavatar | |
array | $members |
api |
|
protected |
Get the URI of a backoffice endpoint on the mock server.
string | $endpoint |
string |
communication_matrix\get_matrix_access_token | ( | ) |
Get the matrix access token.
string |
communication_matrix\get_matrix_room_data | ( | string | $roomid | ) |
Get matrix room data from matrix server.
string | $roomid | The id of the room |
stdClass |
communication_matrix\get_matrix_server_url | ( | ) |
Get the mock server url.
string |
communication_matrix\get_matrix_user_data | ( | string | $roomid, |
string | $matrixuserid ) |
Get matrix user data from matrix server.
string | $roomid | The id of the room |
string | $matrixuserid | The id of the user |
stdClass |
|
protected |
Initialize the mock configs in settings.
void |
|
protected |
This test requires mock server to be present.
void |
communication_matrix\request | ( | array | $jsonarray = [], |
array | $headers = [] ) |
The http request for the api call.
array | $jsonarray | The array of json |
array | $headers | The array of headers |
core\http_client |
communication_matrix\reset_mock | ( | ) |
Reset the mock server.
void |
xmldb_communication_matrix_upgrade | ( | $oldversion | ) |
Upgrade procedures for the matrix plugin.
bool |
$capabilities |
$definitions |
trait communication_matrix\matrix_test_helper_trait |