communication_matrix\matrix_room Class Reference

Class to manage the updates to the room information in db. More...

Public Member Functions
	delete_room_record ()
	Delete matrix room data.
	get_processor_id ()
	Get the processor id.
	get_room_id ()
	Get the matrix room id.
	get_topic ()
	Get the matrix room topic.
	update_room_record (?string $roomid=null, ?string $topic=null,)
	Update matrix room data.

Static Public Member Functions
static	create_room_record (int $processorid, ?string $topic, ?string $roomid=null,)
	Create matrix room data.
stdClass null static	load_by_processor_id (int $processorid,)
	$record The matrix room record from db

Detailed Description

Class to manage the updates to the room information in db.

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

Member Function Documentation

create_room_record()

static communication_matrix\matrix_room::create_room_record ( int $processorid, ?string $topic, ?string $roomid = null )

static

Create matrix room data.

Parameters

int	$processorid	The id of the communication record
string | null	$topic	The topic of the room for matrix
string | null	$roomid	The id of the room from matrix

Return values

self

get_processor_id()

communication_matrix\matrix_room::get_processor_id

(

)

Get the processor id.

Return values

int

get_room_id()

communication_matrix\matrix_room::get_room_id

(

)

Get the matrix room id.

Return values

string|null

get_topic()

communication_matrix\matrix_room::get_topic

(

)

Get the matrix room topic.

Return values

string

load_by_processor_id()

stdClass null static communication_matrix\matrix_room::load_by_processor_id ( int $processorid )

static

$record The matrix room record from db

Load the matrix room record for the supplied processor.

Parameters

int

$processorid

Return values

null|self

update_room_record()

communication_matrix\matrix_room::update_room_record	(	?string	$roomid = null,
		?string	$topic = null )

Update matrix room data.

Parameters

string | null	$roomid	The id of the room from matrix
string | null	$topic	The topic of the room for matrix

---

The documentation for this class was generated from the following file:

• communication/provider/matrix/classes/matrix_room.php