Inheritance diagram for mod_bigbluebuttonbn\local\proxy\recording_proxy:

Static Public Member Functions
static	delete_recording (string $recordid, ?int $instanceid=null)
	Perform deleteRecordings on BBB.

static	fetch_recording (string $recordingid)
	Helper function to fetch a single recording from a BigBlueButton server.

static	fetch_recording_by_meeting_id (array $keyids=[])
	Helper function to fetch recordings from a BigBlueButton server.

static	fetch_recordings (array $keyids=[])
	Helper function to fetch recordings from a BigBlueButton server.

static	get_checksum (string $action, string $params)
	Get checksum.

static	parse_preview_images (SimpleXMLElement $preview)
	Helper function to convert an xml recording preview images to an array in the format used by the plugin.

static	parse_recording (SimpleXMLElement $recording)
	Helper function to parse an xml recording object and produce an array in the format used by the plugin.

static	parse_recording_meta (array $metadata)
	Helper function to convert an xml recording metadata object to an array in the format used by the plugin.

static	protect_recording (string $recordid, string $protected='true')
	Perform publishRecordings on BBB.

static	publish_recording (string $recordid, string $publish='true')
	Perform publishRecordings on BBB.

static	purge_protected_recording (string $recordingid)
	Check whether the current recording is a protected recording and purge the cache if necessary.

static	sort_recordings (array $recordings)
	Helper function to sort an array of recordings.

static	update_recording (string $recordid, array $params)
	Perform updateRecordings on BBB.

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	invalidate_cache_for_recording (string $recordid)
	Invalidate the MUC cache for the specified recording.

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 )

staticprotectedinherited

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 )

staticprotectedinherited

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

◆ delete_recording()

static mod_bigbluebuttonbn\local\proxy\recording_proxy::delete_recording	(	string	$recordid,
		?int	$instanceid = null )

static

Perform deleteRecordings on BBB.

Parameters

string $recordid a recording id

Return values

bool

◆ fetch_endpoint_xml()

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

staticprotectedinherited

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

◆ fetch_recording()

static mod_bigbluebuttonbn\local\proxy\recording_proxy::fetch_recording ( string $recordingid )

static

Helper function to fetch a single recording from a BigBlueButton server.

Parameters

string $recordingid

Return values

null|array

◆ fetch_recording_by_meeting_id()

static mod_bigbluebuttonbn\local\proxy\recording_proxy::fetch_recording_by_meeting_id ( array $keyids = [] )

static

Helper function to fetch recordings from a BigBlueButton server.

Parameters

array $keyids list of meetingids

Return values

array (associative) with recordings indexed by recordID, each recording is a non sequential array and sorted by {

See also: recording_proxy\sort_recordings}

◆ fetch_recordings()

static mod_bigbluebuttonbn\local\proxy\recording_proxy::fetch_recordings ( array $keyids = [] )

static

Helper function to fetch recordings from a BigBlueButton server.

We use a cache to store recording indexed by keyids/recordingID.

Parameters

array $keyids list of recordingids

Return values

array (associative) with recordings indexed by recordID, each recording is a non sequential array and sorted by {

See also: recording_proxy\sort_recordings}

◆ get_checksum()

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

staticinherited

Get checksum.

Parameters

string	$action
string	$params

Return values

string

◆ invalidate_cache_for_recording()

static mod_bigbluebuttonbn\local\proxy\recording_proxy::invalidate_cache_for_recording ( string $recordid )

staticprotected

Invalidate the MUC cache for the specified recording.

Parameters

string $recordid

◆ parse_preview_images()

static mod_bigbluebuttonbn\local\proxy\recording_proxy::parse_preview_images ( SimpleXMLElement $preview )

static

Helper function to convert an xml recording preview images to an array in the format used by the plugin.

Parameters

SimpleXMLElement $preview

Return values

array

◆ parse_recording()

static mod_bigbluebuttonbn\local\proxy\recording_proxy::parse_recording ( SimpleXMLElement $recording )

static

Helper function to parse an xml recording object and produce an array in the format used by the plugin.

Parameters

SimpleXMLElement $recording

Return values

array

◆ parse_recording_meta()

static mod_bigbluebuttonbn\local\proxy\recording_proxy::parse_recording_meta ( array $metadata )

static

Helper function to convert an xml recording metadata object to an array in the format used by the plugin.

Parameters

array $metadata

Return values

array

◆ protect_recording()

static mod_bigbluebuttonbn\local\proxy\recording_proxy::protect_recording	(	string	$recordid,
		string	$protected = 'true' )

static

Perform publishRecordings on BBB.

Parameters

string	$recordid
string	$protected

Return values

bool

◆ publish_recording()

static mod_bigbluebuttonbn\local\proxy\recording_proxy::publish_recording	(	string	$recordid,
		string	$publish = 'true' )

static

Perform publishRecordings on BBB.

Parameters

string	$recordid
string	$publish

Return values

bool

◆ purge_protected_recording()

static mod_bigbluebuttonbn\local\proxy\recording_proxy::purge_protected_recording ( string $recordingid )

static

Check whether the current recording is a protected recording and purge the cache if necessary.

Parameters

string $recordingid

◆ sanitized_secret()

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

staticprotectedinherited

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 ( )

staticprotectedinherited

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

Return values

string

◆ sort_recordings()

static mod_bigbluebuttonbn\local\proxy\recording_proxy::sort_recordings ( array $recordings )

static

Helper function to sort an array of recordings.

It compares the startTime in two recording objects.

Parameters

array $recordings

Return values

array

◆ update_recording()

static mod_bigbluebuttonbn\local\proxy\recording_proxy::update_recording	(	string	$recordid,
		array	$params )

static

Perform updateRecordings on BBB.

Parameters

string	$recordid	a single record identifier
array	$params	['key'=>param_key, 'value']

Member Data Documentation

◆ BBB_TO_MOODLE_ERROR_CODE

const mod_bigbluebuttonbn\local\proxy\proxy_base::BBB_TO_MOODLE_ERROR_CODE

inherited

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/recording_proxy.php

Static Public Member Functions

Public Attributes

Static Protected Member Functions

Member Function Documentation

◆ action_url()

◆ assert_returned_xml()

◆ delete_recording()

◆ fetch_endpoint_xml()

◆ fetch_recording()

◆ fetch_recording_by_meeting_id()

◆ fetch_recordings()

◆ get_checksum()

◆ invalidate_cache_for_recording()

◆ parse_preview_images()

◆ parse_recording()

◆ parse_recording_meta()

◆ protect_recording()

◆ publish_recording()

◆ purge_protected_recording()

◆ sanitized_secret()

◆ sanitized_url()

◆ sort_recordings()

◆ update_recording()

Member Data Documentation

◆ BBB_TO_MOODLE_ERROR_CODE