Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
mod_bigbluebuttonbn\settings Class Reference

Public Member Functions

 __construct (admin_category $admin, core\plugininfo\mod $module, string $categoryname, bool $hassiteconfig)
 Constructor for the bigbluebuttonbn settings.
 
 add_all_settings ()
 Add all settings.
 

Protected Member Functions

 add_conditional_element (string $name, admin_setting $item, admin_settingpage $settings)
 Add the setting and lock it conditionally.
 
 add_defaultmessages_settings ()
 Helper function renders default messages settings if the feature is enabled.
 
 add_experimental_settings ()
 Helper function renders experimental settings if any of the features there is enabled.
 
 add_extended_settings ()
 Helper function renders extended settings if any of the features there is enabled.
 
 add_general_settings ()
 Helper function renders general settings if the feature is enabled.
 
 add_importrecordings_settings ()
 Helper function renders import recording settings if the feature is enabled.
 
 add_lock_setting_from_name (string $settingname, admin_settingpage $lockingsetting)
 Helper function renders setting if the feature is enabled.
 
 add_lock_settings ()
 Helper function to render lock settings.
 
 add_muteonstart_settings ()
 Helper function renders general settings if the feature is enabled.
 
 add_participants_settings ()
 Helper function renders participant settings if the feature is enabled.
 
 add_preupload_settings ()
 Helper function renders preuploaded presentation settings if the feature is enabled.
 
 add_record_settings ()
 Helper function renders record settings if the feature is enabled.
 
 add_showrecordings_settings ()
 Helper function renders show recording settings if the feature is enabled.
 
 add_userlimit_settings ()
 Helper function renders userlimit settings if the feature is enabled.
 
 add_voicebridge_settings ()
 Helper function renders static voice bridge settings if the feature is enabled.
 
 add_waitmoderator_settings ()
 Helper function renders wait for moderator settings if the feature is enabled.
 
 reset_cache ()
 Process reset cache.
 

Constructor & Destructor Documentation

◆ __construct()

mod_bigbluebuttonbn\settings::__construct ( admin_category $admin,
core\plugininfo\mod $module,
string $categoryname,
bool $hassiteconfig )

Constructor for the bigbluebuttonbn settings.

Parameters
admin_category$admin
core\plugininfo\mod$module
string$categorynamefor the plugin setting (main setting page)
bool$hassiteconfigwhether the current user has moodle/site:config capability

Member Function Documentation

◆ add_conditional_element()

mod_bigbluebuttonbn\settings::add_conditional_element ( string $name,
admin_setting $item,
admin_settingpage $settings )
protected

Add the setting and lock it conditionally.

Parameters
string$name
admin_setting$item
admin_settingpage$settings

◆ add_general_settings()

mod_bigbluebuttonbn\settings::add_general_settings ( )
protected

Helper function renders general settings if the feature is enabled.

Return values
admin_settingpage
Exceptions
coding_exception

◆ add_lock_setting_from_name()

mod_bigbluebuttonbn\settings::add_lock_setting_from_name ( string $settingname,
admin_settingpage $lockingsetting )
protected

Helper function renders setting if the feature is enabled.

Parameters
string$settingname
admin_settingpage$lockingsettingThe parent settingpage to add to

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