communication_matrix

Topics
	cache
	test

Directories
directory	features

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

Classes
class	communication_matrix\communication_feature
	class communication_feature to handle matrix specific actions. More...
class	communication_matrix\local\command
	A command to be sent to the Matrix server. More...
class	communication_matrix\local\spec\v1p1
	Matrix API to support version v1.1 of the Matrix specification. More...
class	communication_matrix\local\spec\v1p2
	Matrix API to support version v1.2 of the Matrix specification. More...
class	communication_matrix\local\spec\v1p3
	Matrix API to support version v1.3 of the Matrix specification. More...
class	communication_matrix\local\spec\v1p4
	Matrix API to support version v1.4 of the Matrix specification. More...
class	communication_matrix\local\spec\v1p5
	Matrix API to support version v1.5 of the Matrix specification. More...
class	communication_matrix\local\spec\v1p6
	Matrix API to support version v1.6 of the Matrix specification. More...
class	communication_matrix\local\spec\v1p7
	Matrix API to support version v1.7 of the Matrix specification. More...
class	communication_matrix\matrix_client
	The abstract class for a versioned API client for Matrix. More...
class	communication_matrix\matrix_constants
	class matrix_constants to have one location to store all constants related to matrix. More...
class	communication_matrix\matrix_room
	Class to manage the updates to the room information in db. More...
class	communication_matrix\matrix_user_manager
	class matrix_user_manager to handle specific actions. More...
class	communication_matrix\privacy\provider
	Privacy Subsystem for communication_matrix implementing null_provider. More...

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)
	Install steps for communication_matrix.

Variables
	$capabilities
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
	Trait matrix_helper_trait to generate initial setup for matrix mock and associated helpers.
$plugin	maturity = MATURITY_ALPHA
$plugin	version = 2023100900

Detailed Description

Function Documentation

backoffice_create_users_and_rooms()

communication_matrix\backoffice_create_users_and_rooms	(	array	$users = [],
		array	$rooms = [] )

A backoffice method to create users and rooms on our mock server.

Parameters

array	$users
array	$rooms

backoffice_get_all_rooms()

communication_matrix\backoffice_get_all_rooms

(

)

Fetch all rooms from the back office.

Return values

array

backoffice_get_all_users()

communication_matrix\backoffice_get_all_users

(

)

A backoffice call to get all registered users from our mock server.

Return values

array

backoffice_get_room()

communication_matrix\backoffice_get_room

(

)

Return the first room from the server.

In most cases there is only one room.

Return values

stdClass

create_matrix_room()

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 )

protected

Helper to create a room.

Parameters

null | string	$component
null | string	$itemtype
null | int	$itemid
null | string	$roomname
null | string	$roomtopic
null | stored_file	$roomavatar
array	$members

Return values

api

get_backoffice_uri()

communication_matrix\get_backoffice_uri ( string $endpoint )

protected

Get the URI of a backoffice endpoint on the mock server.

Parameters

string

$endpoint

Return values

string

get_matrix_access_token()

communication_matrix\get_matrix_access_token

(

)

Get the matrix access token.

Return values

string

get_matrix_room_data()

communication_matrix\get_matrix_room_data

(

string

$roomid

)

Get matrix room data from matrix server.

Parameters

string

$roomid

The id of the room

Return values

stdClass

get_matrix_server_url()

communication_matrix\get_matrix_server_url

(

)

Get the mock server url.

Return values

string

get_matrix_user_data()

communication_matrix\get_matrix_user_data	(	string	$roomid,
		string	$matrixuserid )

Get matrix user data from matrix server.

Parameters

string	$roomid	The id of the room
string	$matrixuserid	The id of the user

Return values

stdClass

initialise_mock_configs()

communication_matrix\initialise_mock_configs ( )

protected

Initialize the mock configs in settings.

Return values

void

initialise_mock_server()

communication_matrix\initialise_mock_server ( )

protected

This test requires mock server to be present.

Return values

void

request()

communication_matrix\request	(	array	$jsonarray = [],
		array	$headers = [] )

The http request for the api call.

Parameters

array	$jsonarray	The array of json
array	$headers	The array of headers

Return values

core\http_client

reset_mock()

communication_matrix\reset_mock

(

)

Reset the mock server.

Return values

void

xmldb_communication_matrix_upgrade()

xmldb_communication_matrix_upgrade

(

$oldversion

)

Install steps for communication_matrix.

Copyright

2023 Safat Shahin safat.nosp@m..sha.nosp@m.hin@m.nosp@m.oodl.nosp@m.e.com

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later Upgrade procedures for the matrix plugin.

Return values

bool

Variable Documentation

$capabilities

$capabilities

Initial value:

= [
 
    
    'communication/matrix:moderator' => [
        'captype' => 'read',
        'contextlevel' => CONTEXT_COURSE,
        'archetypes' => [
            'editingteacher' => CAP_ALLOW,
            'manager' => CAP_ALLOW,
            'teacher' => CAP_ALLOW,
        ],
    ],
]

matrix_test_helper_trait

trait communication_matrix\matrix_test_helper_trait

Initial value:

{
    
    protected string string $accesstoken

Trait matrix_helper_trait to generate initial setup for matrix mock and associated helpers.

Copyright

2023 Safat Shahin safat.nosp@m..sha.nosp@m.hin@m.nosp@m.oodl.nosp@m.e.com

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later