Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
mod_bigbluebuttonbn\extension Class Reference

Generic subplugin management helper. More...

Static Public Member Functions

static action_url_addons (string $action='', array $data=[], array $metadata=[], ?int $instanceid=null)
 Invoke a subplugin hook that will return additional parameters.
 
static add_instance (stdClass $data)
 Add instance processing.
 
static delete_instance (int $id)
 Delete instance processing.
 
static get_join_tables ()
 Get additional join tables for instance when extension activated.
 
static mod_form_addons_instances (\MoodleQuickForm $mform, ?stdClass $bigbluebuttondata=null, string $suffix=null)
 Get all mod_form addons classes instances.
 
static update_instance (stdClass $data)
 Update instance processing.
 

Public Attributes

const BBB_EXTENSION_PLUGIN_NAME = 'bbbext'
 Plugin name for extension.
 

Static Protected Member Functions

static get_classes_implementing (string $classname)
 Get classes are named on the base of this classname and implementing this class.
 
static get_instances_implementing (string $classname, ?array $newparameters=[])
 Get new instance of classes that are named on the base of this classname and implementing this class.
 

Detailed Description

Generic subplugin management helper.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Author
Laurent David (laure.nosp@m.nt@c.nosp@m.all-l.nosp@m.earn.nosp@m.ing.f.nosp@m.r)

Member Function Documentation

◆ action_url_addons()

static mod_bigbluebuttonbn\extension::action_url_addons ( string $action = '',
array $data = [],
array $metadata = [],
?int $instanceid = null )
static

Invoke a subplugin hook that will return additional parameters.

Parameters
string$action
array$data
array$metadata
int | null$instanceid
Return values
arrayassociative array with the additional data and metadata (indexed by 'data' and 'metadata' keys).

◆ add_instance()

static mod_bigbluebuttonbn\extension::add_instance ( stdClass $data)
static

Add instance processing.

Parameters
stdClass$datadata to persist
Return values
void

◆ delete_instance()

static mod_bigbluebuttonbn\extension::delete_instance ( int $id)
static

Delete instance processing.

Parameters
int$idinstance id
Return values
void

◆ get_classes_implementing()

static mod_bigbluebuttonbn\extension::get_classes_implementing ( string $classname)
staticprotected

Get classes are named on the base of this classname and implementing this class.

Parameters
string$classname
Return values
array

◆ get_instances_implementing()

static mod_bigbluebuttonbn\extension::get_instances_implementing ( string $classname,
?array $newparameters = [] )
staticprotected

Get new instance of classes that are named on the base of this classname and implementing this class.

Parameters
string$classname
array | null$newparametersadditional parameters for the constructor.
Return values
array

◆ get_join_tables()

static mod_bigbluebuttonbn\extension::get_join_tables ( )
static

Get additional join tables for instance when extension activated.

Return values
arrayof additional tables names. They all have a field called bigbluebuttonbnid that identifies the bbb instance.

◆ mod_form_addons_instances()

static mod_bigbluebuttonbn\extension::mod_form_addons_instances ( \MoodleQuickForm $mform,
?stdClass $bigbluebuttondata = null,
string $suffix = null )
static

Get all mod_form addons classes instances.

Parameters
MoodleQuickForm$mform
stdClass | null$bigbluebuttondata
string | null$suffix
Return values
arrayof custom completion addon classes instances

◆ update_instance()

static mod_bigbluebuttonbn\extension::update_instance ( stdClass $data)
static

Update instance processing.

Parameters
stdClass$datadata to persist
Return values
void

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