core_communication\communication_provider Interface Reference

A base communication provider. More...

Inheritance diagram for core_communication\communication_provider:

Static Public Member Functions
static	is_configured ()
	Check if the provider is configured or not.
static	load_for_instance (processor $communication)
	A base communication provider.

Detailed Description

A base communication provider.

This interface should be used to declare support for the instantiation method for communication providers.

Every communication provider must, as a minimum, implement this provider.

Copyright

2023 Andrew Lyons andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

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

Member Function Documentation

is_configured()

static core_communication\communication_provider::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.

Implemented in communication_customlink\communication_feature, and communication_matrix\communication_feature.

load_for_instance()

static core_communication\communication_provider::load_for_instance ( processor $communication )

static

A base communication provider.

Parameters

processor

$communication

The communication object

Implemented in communication_customlink\communication_feature, and communication_matrix\communication_feature.

---

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

• communication/classes/communication_provider.php