communication_customlink\communication_feature Class Reference

class communication_feature to handle custom link specific actions. More...

Inheritance diagram for communication_customlink\communication_feature:

Public Member Functions
	create_chat_room ()
	Create room - room existence managed externally, always return true.
	delete_chat_room ()
	Delete room - room existence managed externally, always return true.
	get_chat_room_url ()
	Fetch the URL for this custom link provider.
	save_form_data (\stdClass $instance)
	Set the form data to the instance if any data is available.
	set_form_data (\stdClass $instance)
	Set the form data to the instance if any data is available.
	update_chat_room ()
	Update room - room existence managed externally, always return true.

Static Public Member Functions
static	is_configured ()
	Check if the provider is configured or not.
static	load_for_instance (processor $communication)
	Load the communication provider for the communication API.
static	set_form_definition (\MoodleQuickForm $mform)
	Set the form definitions.

Protected Attributes
cache_application cache_application	$cache
	$cache The application cache for this provider.
string const	CUSTOMLINK_TABLE = 'communication_customlink'
	The database table storing custom link specific data.

Detailed Description

class communication_feature to handle custom link specific actions.

Copyright

2023 Michael Hawkins micha.nosp@m.elh@.nosp@m.moodl.nosp@m.e.co.nosp@m.m

License

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

Member Function Documentation

create_chat_room()

communication_customlink\communication_feature::create_chat_room

(

)

Create room - room existence managed externally, always return true.

Return values

boolean

Implements core_communication\room_chat_provider.

delete_chat_room()

communication_customlink\communication_feature::delete_chat_room

(

)

Delete room - room existence managed externally, always return true.

Return values

boolean

Implements core_communication\room_chat_provider.

get_chat_room_url()

communication_customlink\communication_feature::get_chat_room_url

(

)

Fetch the URL for this custom link provider.

Return values

string|null

The custom URL, or null if not found.

Implements core_communication\room_chat_provider.

is_configured()

static communication_customlink\communication_feature::is_configured ( )

static

Check if the provider is configured or not.

This method is intended to check if the plugin have got any settings and if all the settings are set properly. This checking helps to reduce errors in future when a communication instance is added for the provider and not configured.

Implements core_communication\communication_provider.

load_for_instance()

static communication_customlink\communication_feature::load_for_instance ( processor $communication )

static

Load the communication provider for the communication API.

Parameters

processor

$communication

The communication processor object.

Return values

communication_feature

The communication provider object.

Implements core_communication\communication_provider.

save_form_data()

communication_customlink\communication_feature::save_form_data

(

\stdClass

$instance

)

Set the form data to the instance if any data is available.

Parameters

stdClass

$instance

The actual instance to set the data

Implements core_communication\form_provider.

set_form_data()

communication_customlink\communication_feature::set_form_data

(

\stdClass

$instance

)

Set the form data to the instance if any data is available.

Parameters

stdClass

$instance

The actual instance to set the data

Implements core_communication\form_provider.

set_form_definition()

static communication_customlink\communication_feature::set_form_definition ( \MoodleQuickForm $mform )

static

Set the form definitions.

Parameters

MoodleQuickForm

$mform

The form object

Implements core_communication\form_provider.

update_chat_room()

communication_customlink\communication_feature::update_chat_room

(

)

Update room - room existence managed externally, always return true.

Return values

boolean

Implements core_communication\room_chat_provider.

---

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

• communication/provider/customlink/classes/communication_feature.php