mod_bigbluebuttonbn\local\proxy\proxy_base Class Reference

Inheritance diagram for mod_bigbluebuttonbn\local\proxy\proxy_base:

Static Public Member Functions
static	get_checksum (string $action, string $params)
	Get checksum.

Public Attributes
const	BBB_TO_MOODLE_ERROR_CODE
	Sometimes the server sends back some error and errorKeys that can be converted to Moodle error messages.

Static Protected Member Functions
static	action_url (string $action='', array $data=[], array $metadata=[], ?int $instanceid=null)
	Returns the right URL for the action specified.
static	assert_returned_xml ($xml, ?array $additionaldetails=null)
	Throw an exception if there is a problem in the returned XML value.
static	fetch_endpoint_xml (string $action, array $data=[], array $metadata=[], ?int $instanceid=null)
	Fetch the XML from an endpoint and test for success.
static	sanitized_secret ()
	Makes sure the shared_secret used doesn't have trailing white characters.
static	sanitized_url ()
	Makes sure the url used doesn't is in the format required.

Member Function Documentation

action_url()

static mod_bigbluebuttonbn\local\proxy\proxy_base::action_url ( string $action = '', array $data = [], array $metadata = [], ?int $instanceid = null )

staticprotected

Returns the right URL for the action specified.

Parameters

string	$action
array	$data
array	$metadata
int | null	$instanceid

Return values

string

assert_returned_xml()

static mod_bigbluebuttonbn\local\proxy\proxy_base::assert_returned_xml ( $xml, ?array $additionaldetails = null )

staticprotected

Throw an exception if there is a problem in the returned XML value.

Parameters

SimpleXMLElement | bool	$xml
array | null	$additionaldetails

Exceptions

bigbluebutton_exception
server_not_available_exception

fetch_endpoint_xml()

static mod_bigbluebuttonbn\local\proxy\proxy_base::fetch_endpoint_xml ( string $action, array $data = [], array $metadata = [], ?int $instanceid = null )

staticprotected

Fetch the XML from an endpoint and test for success.

If the result could not be loaded, or the returncode was not 'SUCCESS', a null value is returned.

Parameters

string	$action
array	$data
array	$metadata
int | null	$instanceid

Return values

null|bool|SimpleXMLElement

get_checksum()

static mod_bigbluebuttonbn\local\proxy\proxy_base::get_checksum ( string $action, string $params )

static

Get checksum.

Parameters

string	$action
string	$params

Return values

string

sanitized_secret()

static mod_bigbluebuttonbn\local\proxy\proxy_base::sanitized_secret ( )

staticprotected

Makes sure the shared_secret used doesn't have trailing white characters.

Return values

string

sanitized_url()

static mod_bigbluebuttonbn\local\proxy\proxy_base::sanitized_url ( )

staticprotected

Makes sure the url used doesn't is in the format required.

Return values

string

Member Data Documentation

BBB_TO_MOODLE_ERROR_CODE

const mod_bigbluebuttonbn\local\proxy\proxy_base::BBB_TO_MOODLE_ERROR_CODE

Initial value:

= [
        'checksumError' => 'index_error_checksum',
        'notFound' => 'general_error_not_found',
        'maxConcurrent' => 'view_error_max_concurrent',
    ]

Sometimes the server sends back some error and errorKeys that can be converted to Moodle error messages.

---

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

• mod/bigbluebuttonbn/classes/local/proxy/proxy_base.php