Topics
	completion


	external


	files


	test

Directories
directory	analytics


directory	bigbluebutton

Namespaces
namespace	mod_bigbluebuttonbn


namespace	mod_bigbluebuttonbn\analytics\indicator
	Activity base class.

namespace	mod_bigbluebuttonbn\completion


namespace	mod_bigbluebuttonbn\event


namespace	mod_bigbluebuttonbn\form


namespace	mod_bigbluebuttonbn\local


namespace	mod_bigbluebuttonbn\local\bigbluebutton\recordings


namespace	mod_bigbluebuttonbn\local\exceptions


namespace	mod_bigbluebuttonbn\local\extension


namespace	mod_bigbluebuttonbn\local\helpers
	The mod_bigbluebuttonbn files helper.

namespace	mod_bigbluebuttonbn\local\plugins


namespace	mod_bigbluebuttonbn\local\proxy


namespace	mod_bigbluebuttonbn\output


namespace	mod_bigbluebuttonbn\plugininfo


namespace	mod_bigbluebuttonbn\privacy


namespace	mod_bigbluebuttonbn\search


namespace	mod_bigbluebuttonbn\task


namespace	mod_bigbluebuttonbn\test
	Subplugin test helper trait.

Classes
class	backup_bigbluebuttonbn_activity_structure_step
	Class for the structure used for backup BigBlueButtonBN. More...

class	backup_bigbluebuttonbn_activity_task
	Backup task that provides all the settings and steps to perform one complete backup of the activity. More...

class	bbb_coverage
	Class bbb_coverage information for the core subsystem. More...

class	mod_bigbluebuttonbn\analytics\indicator\activity_base
	Activity base class. More...

class	mod_bigbluebuttonbn\analytics\indicator\cognitive_depth
	Cognitive depth indicator - bigbluebuttonbn. More...

class	mod_bigbluebuttonbn\analytics\indicator\social_breadth
	Social breadth indicator - BigBlueButtonBN. More...

class	mod_bigbluebuttonbn\broker
	The broker routines. More...

class	mod_bigbluebuttonbn\completion\custom_completion
	Class custom_completion. More...

class	mod_bigbluebuttonbn\event\activity_management_viewed
	The mod_bigbluebuttonbn activity management viewed event. More...

class	mod_bigbluebuttonbn\event\base
	The mod_bigbluebuttonbn abstract base event class. More...

class	mod_bigbluebuttonbn\event\course_module_viewed
	The mod_bigbluebuttonbn activity viewed event. More...

class	mod_bigbluebuttonbn\event\events
	The mod_bigbluebuttonbn class for event name definition. More...

class	mod_bigbluebuttonbn\event\live_session_event
	The mod_bigbluebuttonbn live_session (Experimental: for being triggered when external events are received). More...

class	mod_bigbluebuttonbn\event\meeting_created
	The mod_bigbluebuttonbn meeting created event, triggered when the meeting is created before join. More...

class	mod_bigbluebuttonbn\event\meeting_ended
	The mod_bigbluebuttonbn meeting ended event, triggered when the meeting is ended by the user. More...

class	mod_bigbluebuttonbn\event\meeting_joined
	The mod_bigbluebuttonbn meeting joined event, triggered when the user joins the session. More...

class	mod_bigbluebuttonbn\event\meeting_left
	The mod_bigbluebuttonbn meeting left event, triggered when the user lefts the meeting using the logout button. More...

class	mod_bigbluebuttonbn\event\recording_deleted
	The mod_bigbluebuttonbn recording deleted event. More...

class	mod_bigbluebuttonbn\event\recording_edited
	The mod_bigbluebuttonbn recording edited event. More...

class	mod_bigbluebuttonbn\event\recording_imported
	The mod_bigbluebuttonbn recording imported event. More...

class	mod_bigbluebuttonbn\event\recording_protected
	The mod_bigbluebuttonbn recording protected event. More...

class	mod_bigbluebuttonbn\event\recording_published
	The mod_bigbluebuttonbn recording published event. More...

class	mod_bigbluebuttonbn\event\recording_unprotected
	The mod_bigbluebuttonbn recording unprotected event. More...

class	mod_bigbluebuttonbn\event\recording_unpublished
	The mod_bigbluebuttonbn recording unpublished event. More...

class	mod_bigbluebuttonbn\event\recording_viewed
	The mod_bigbluebuttonbn recording viewed event. More...

class	mod_bigbluebuttonbn\extension
	Generic subplugin management helper. More...

class	mod_bigbluebuttonbn\form\guest_add
	Popup form to add new guests to a meeting and show/copy credential to access the guest login page. More...

class	mod_bigbluebuttonbn\form\guest_login
	Guest login form. More...

class	mod_bigbluebuttonbn\form\text_with_copy_element
	Text type form element with a copy widget. More...

class	mod_bigbluebuttonbn\instance
	Instance record for mod_bigbluebuttonbn. More...

class	mod_bigbluebuttonbn\local\bigbluebutton\recordings\recording_action
	Collection of helper methods for handling recordings actions in Moodle. More...

class	mod_bigbluebuttonbn\local\bigbluebutton\recordings\recording_data
	The recordings_data. More...

class	mod_bigbluebuttonbn\local\config
	Handles the global configuration based on config.php. More...

class	mod_bigbluebuttonbn\local\exceptions\bigbluebutton_exception
	Class bigbluebutton_exception generic exception. More...

class	mod_bigbluebuttonbn\local\exceptions\meeting_join_exception
	The mod_bigbluebuttonbn cannot join meeting exception. More...

class	mod_bigbluebuttonbn\local\exceptions\server_not_available_exception
	Class server_not_available_exception. More...

class	mod_bigbluebuttonbn\local\extension\action_url_addons
	A single action class to mutate the action URL. More...

class	mod_bigbluebuttonbn\local\extension\mod_form_addons
	A class for the main mod form extension. More...

class	mod_bigbluebuttonbn\local\extension\mod_instance_helper
	Class defining a way to deal with instance save/update/delete in extension. More...

class	mod_bigbluebuttonbn\local\helpers\files
	Utility class for all files routines helper. More...

class	mod_bigbluebuttonbn\local\helpers\mod_helper
	Utility class for all instance (module) routines helper. More...

class	mod_bigbluebuttonbn\local\helpers\reset
	Utility class for resetting instance routines helper. More...

class	mod_bigbluebuttonbn\local\helpers\roles
	Utility class for all roles routines helper. More...

class	mod_bigbluebuttonbn\local\helpers\user_info
	Utility class for all user information. More...

class	mod_bigbluebuttonbn\local\plugins\admin_page_manage_extensions
	Admin external page that displays a list of the installed extension plugins. More...

class	mod_bigbluebuttonbn\local\plugins\admin_plugin_manager
	Class that handles the display and configuration of the list of extension plugins. More...

class	mod_bigbluebuttonbn\local\proxy\bigbluebutton_proxy
	The bigbluebutton proxy class. More...

class	mod_bigbluebuttonbn\local\proxy\curl
	A curl wrapper for bbb. More...

class	mod_bigbluebuttonbn\local\proxy\proxy_base
	The abstract proxy base class. More...

class	mod_bigbluebuttonbn\local\proxy\recording_proxy
	The recording proxy. More...

class	mod_bigbluebuttonbn\logger
	Utility class for all logs routines helper. More...

class	mod_bigbluebuttonbn\meeting
	Class to describe a BBB Meeting. More...

class	mod_bigbluebuttonbn\output\import_view
	Renderable for the import page. More...

class	mod_bigbluebuttonbn\output\index
	Renderer for the Index page. More...

class	mod_bigbluebuttonbn\output\instance_updated_message
	Renderable for the instance notification updated message. More...

class	mod_bigbluebuttonbn\output\mobile
	Mobile output class for bigbluebuttonbn. More...

class	mod_bigbluebuttonbn\output\recording_description_editable
	Renderer for recording name in place editable. More...

class	mod_bigbluebuttonbn\output\recording_editable
	Renderer for recording in place editable. More...

class	mod_bigbluebuttonbn\output\recording_name_editable
	Renderer for recording name in place editable. More...

class	mod_bigbluebuttonbn\output\recording_row_actionbar
	Renderer for recording row actionbar column. More...

class	mod_bigbluebuttonbn\output\recording_row_playback
	Renderer for recording row playback column. More...

class	mod_bigbluebuttonbn\output\recording_row_preview
	Renderer for recording_row_preview column. More...

class	mod_bigbluebuttonbn\output\recordings_session
	Renderer for recording section. More...

class	mod_bigbluebuttonbn\output\renderer
	Renderer for the mod_bigbluebuttonbn plugin. More...

class	mod_bigbluebuttonbn\output\view_page
	View Page template renderable. More...

class	mod_bigbluebuttonbn\plugin
	Class plugin. More...

class	mod_bigbluebuttonbn\plugininfo\bbbext
	Subplugin extension info class. More...

class	mod_bigbluebuttonbn\privacy\provider
	Privacy class for requesting user data. More...

class	mod_bigbluebuttonbn\recording
	The recording entity. More...

class	mod_bigbluebuttonbn\search\activity
	Search area for mod_bigbluebuttonbn activities. More...

class	mod_bigbluebuttonbn\search\tags
	Search area for mod_bigbluebuttonbn tags. More...

class	mod_bigbluebuttonbn\setting_validator
	Helper class for validating settings used HTML for settings.php. More...

class	mod_bigbluebuttonbn\settings
	The mod_bigbluebuttonbn settings helper. More...

class	mod_bigbluebuttonbn\task\base_send_notification
	Class containing the abstract class for notification processes in BBB. More...

class	mod_bigbluebuttonbn\task\check_dismissed_recordings
	Synchronise pending and dismissed recordings from the server. More...

class	mod_bigbluebuttonbn\task\check_pending_recordings
	Synchronise pending recordings from the server. More...

class	mod_bigbluebuttonbn\task\completion_update_state
	Class containing the scheduled task for updating the completion state. More...

class	mod_bigbluebuttonbn\task\reset_recordings
	Class containing the scheduled task for converting recordings for the BigBlueButton version 2.5 in Moodle 4.0. More...

class	mod_bigbluebuttonbn\task\send_bigbluebutton_module_disabled_notification
	Ad-hoc task to send a notification related to the disabling of the BigBlueButton activity module. More...

class	mod_bigbluebuttonbn\task\send_guest_emails
	This adhoc task will send emails to guest users with the meeting's details. More...

class	mod_bigbluebuttonbn\task\send_notification
	Class containing the deprecated class for send_notification event in BBB. More...

class	mod_bigbluebuttonbn\task\send_recording_ready_notification
	Class containing the adhoc task to send a recording ready notification. More...

class	mod_bigbluebuttonbn\task\upgrade_recordings_task
	Class containing the scheduled task for converting recordings for the BigBlueButton version 2.5 in Moodle 4.0. More...

class	restore_bigbluebuttonbn_activity_structure_step
	Class for the structure used for restore BigBlueButtonBN. More...

class	restore_bigbluebuttonbn_activity_task
	Restore task that provides all the settings and steps to perform one complete restore of the activity. More...

Functions
	mod_bigbluebuttonbn\test::create_activity_with_recordings (stdClass $course, int $type, array $recordingdata, int $groupid=0)
	Create an activity which includes a set of recordings.

	mod_bigbluebuttonbn\test::create_from_dataset (array $dataset)
	Create a course, users and recording from dataset given in an array form.

	mod_bigbluebuttonbn\test::create_instance (?stdClass $course=null, array $params=[], array $options=[])
	Convenience function to create an instance of a bigbluebuttonactivty.

	mod_bigbluebuttonbn\test::create_log_entries (instance $instance, int $userid, int $count=30, bool $importedrecordings=false, bool $withremoterecordings=true)
	Create the legacy log entries for this task.

	mod_bigbluebuttonbn\test::create_recordings_for_instance (instance $instance, array $recordingdata=[], $additionalmeetingdata=[])
	Create an return an array of recordings.

	mod_bigbluebuttonbn\test::get_course ()
	Get or create course if it does not exist.

	mod_bigbluebuttonbn\test::get_form_data_from_instance (stdClass $bbactivity, ?stdClass $course=null)
	Get the matching form data.

	mod_bigbluebuttonbn\test::initialise_mock_server ()
	This test requires mock server to be present.

	mod_bigbluebuttonbn\test::setup_course_students_teachers (stdClass $courserecord, int $numstudents, int $numteachers, int $groupsnum)
	Generate a course, several students and several groups.

	xmldb_bigbluebuttonbn_add_change_field (database_manager $dbman, string $tablename, string $fieldname, array $fielddefinition)
	Generic helper function for adding or changing a field in a table.

	xmldb_bigbluebuttonbn_index_table (database_manager $dbman, string $tablename, string $indexname, array $indexfields, $indextype=XMLDB_INDEX_NOTUNIQUE)
	Generic helper function for adding index to a table.

	xmldb_bigbluebuttonbn_install ()
	Install script for mod_bigbluebuttonbn.

	xmldb_bigbluebuttonbn_upgrade ($oldversion=0)
	Performs data migrations and updates on upgrade.

Variables
	$addons

	$bbbsettings = new mod_bigbluebuttonbn\settings($ADMIN, $module, $section, $hassiteconfig)

	$capabilities

global	$CFG

global	$CFG

global	mod_bigbluebuttonbn::$CFG

global	mod_bigbluebuttonbn\form::$CFG

global	mod_bigbluebuttonbn\local\plugins::$CFG

global	mod_bigbluebuttonbn\local\proxy::$CFG

global	mod_bigbluebuttonbn\output::$CFG

object null	mod_bigbluebuttonbn\test::$course = null

global	$DB

	$definitions

	$logs

	$messageproviders

	$plugin = 2023100400

	$settings = null

	$tasks

return new	bbb_coverage

$plugin	component = 'mod_bigbluebuttonbn'

trait	mod_bigbluebuttonbn\test::testcase_helper_trait

$plugin	version = 2023100900

Detailed Description

Function Documentation

◆ create_activity_with_recordings()

mod_bigbluebuttonbn\test\create_activity_with_recordings	(	stdClass	$course,
		int	$type,
		array	$recordingdata,
		int	$groupid = 0 )

protected

Create an activity which includes a set of recordings.

Parameters

stdClass	$course
int	$type
array	$recordingdata	array of recording information
int	$groupid

Return values

array

◆ create_from_dataset()

mod_bigbluebuttonbn\test\create_from_dataset ( array $dataset )

protected

Create a course, users and recording from dataset given in an array form.

Parameters

array $dataset

Return values

mixed

◆ create_instance()

mod_bigbluebuttonbn\test\create_instance	(	?stdClass	$course = null,
		array	$params = [],
		array	$options = [] )

protected

Convenience function to create an instance of a bigbluebuttonactivty.

Parameters

stdClass \| null	$course	course to add the module to
array	$params	Array of parameters to pass to the generator
array	$options	Array of options to pass to the generator

Return values

array($context,$cm,$instance) Testable wrapper around the assign class.

◆ create_log_entries()

mod_bigbluebuttonbn\test\create_log_entries	(	instance	$instance,
		int	$userid,
		int	$count = 30,
		bool	$importedrecordings = false,
		bool	$withremoterecordings = true )

protected

Create the legacy log entries for this task.

Parameters

instance	$instance
int	$userid
int	$count
bool	$importedrecordings
bool	$withremoterecordings	create recording on the mock server ?

Return values

array

◆ create_recordings_for_instance()

mod_bigbluebuttonbn\test\create_recordings_for_instance	(	instance	$instance,
		array	$recordingdata = [],
			$additionalmeetingdata = [] )

protected

Create an return an array of recordings.

Parameters

instance	$instance
array	$recordingdata	array of recording information
array	$additionalmeetingdata

Return values

array

◆ get_course()

mod_bigbluebuttonbn\test\get_course ( )

protected

Get or create course if it does not exist.

Return values

stdClass|null

◆ get_form_data_from_instance()

mod_bigbluebuttonbn\test\get_form_data_from_instance	(	stdClass	$bbactivity,
		?stdClass	$course = null )

protected

Get the matching form data.

Parameters

stdClass	$bbactivity	the current bigbluebutton activity
stdClass \| null	$course	the course or null (taken from $this->get_course() if null)

Return values

mixed

◆ setup_course_students_teachers()

mod_bigbluebuttonbn\test\setup_course_students_teachers	(	stdClass	$courserecord,
		int	$numstudents,
		int	$numteachers,
		int	$groupsnum )

protected

Generate a course, several students and several groups.

Parameters

stdClass	$courserecord
int	$numstudents
int	$numteachers
int	$groupsnum

Return values

array

◆ xmldb_bigbluebuttonbn_add_change_field()

xmldb_bigbluebuttonbn_add_change_field	(	database_manager	$dbman,
		string	$tablename,
		string	$fieldname,
		array	$fielddefinition )

Generic helper function for adding or changing a field in a table.

Parameters

database_manager	$dbman
string	$tablename
string	$fieldname
array	$fielddefinition

Deprecated: please do not use this anymore (historical migrations)

◆ xmldb_bigbluebuttonbn_index_table()

xmldb_bigbluebuttonbn_index_table	(	database_manager	$dbman,
		string	$tablename,
		string	$indexname,
		array	$indexfields,
			$indextype = XMLDB_INDEX_NOTUNIQUE )

Generic helper function for adding index to a table.

Parameters

database_manager	$dbman
string	$tablename
string	$indexname
array	$indexfields
string \| false \| null	$indextype

Deprecated: please do not use this anymore (historical migrations)

◆ xmldb_bigbluebuttonbn_install()

xmldb_bigbluebuttonbn_install ( )

Install script for mod_bigbluebuttonbn.

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later Perform the post-install procedures.

◆ xmldb_bigbluebuttonbn_upgrade()

xmldb_bigbluebuttonbn_upgrade ( $oldversion = 0 )

Performs data migrations and updates on upgrade.

Parameters

int $oldversion

Return values

bool

Variable Documentation

◆ $addons

$addons

Initial value:

= [
    "mod_bigbluebuttonbn" => [
        "handlers" => [ 
            'coursebigbluebuttonbn' => [ 
                'displaydata' => [
                    'title' => 'pluginname',
                    'icon' => $CFG->wwwroot . '/mod/bigbluebuttonbn/pix/monologo.png',
                    'class' => '',
                ],
                'delegate' => 'CoreCourseModuleDelegate', 
                'method' => 'mobile_course_view' 
            ]
        ],
        'lang' => [
            ['pluginname', 'bigbluebuttonbn'],
            ['view_conference_action_join', 'bigbluebuttonbn'],
            ['view_message_conference_room_ready', 'bigbluebuttonbn'],
            ['view_mobile_message_reload_page_creation_time_meeting', 'bigbluebuttonbn']
        ]
    ]
]

◆ $logs

$logs

Initial value:

= [
    ['module' => 'bigbluebuttonbn', 'action' => 'add', 'mtable' => 'bigbluebuttonbn', 'field' => 'name'],
    ['module' => 'bigbluebuttonbn', 'action' => 'update', 'mtable' => 'bigbluebuttonbn', 'field' => 'name'],
    ['module' => 'bigbluebuttonbn', 'action' => 'view', 'mtable' => 'bigbluebuttonbn', 'field' => 'name'],
    ['module' => 'bigbluebuttonbn', 'action' => 'view all', 'mtable' => 'bigbluebuttonbn', 'field' => 'name'],
    ['module' => 'bigbluebuttonbn', 'action' => 'create', 'mtable' => 'bigbluebuttonbn', 'field' => 'name'],
    ['module' => 'bigbluebuttonbn', 'action' => 'end', 'mtable' => 'bigbluebuttonbn', 'field' => 'name'],
    ['module' => 'bigbluebuttonbn', 'action' => 'join', 'mtable' => 'bigbluebuttonbn', 'field' => 'name'],
    ['module' => 'bigbluebuttonbn', 'action' => 'left', 'mtable' => 'bigbluebuttonbn', 'field' => 'name'],
    ['module' => 'bigbluebuttonbn', 'action' => 'publish', 'mtable' => 'bigbluebuttonbn', 'field' => 'name'],
    ['module' => 'bigbluebuttonbn', 'action' => 'unpublish', 'mtable' => 'bigbluebuttonbn', 'field' => 'name'],
    ['module' => 'bigbluebuttonbn', 'action' => 'delete', 'mtable' => 'bigbluebuttonbn', 'field' => 'name'],
]

◆ $messageproviders

$messageproviders

Initial value:

= [
    
    'recording_ready' => [
        'defaults' => [
        ],
    ],
 
    
    'instance_updated' => [
        'defaults' => [
        ],
    ],
]

◆ $tasks

$tasks

Initial value:

= [
    [
        'classname' => 'mod_bigbluebuttonbn\task\check_pending_recordings',
        'blocking' => 0,
        'minute' => '*/5',
        'hour' => '*',
        'day' => '*',
        'month' => '*',
        'dayofweek' => '*'
    ],
    [
        'classname' => 'mod_bigbluebuttonbn\task\check_dismissed_recordings',
        'blocking' => 0,
        'minute' => '*',
        'hour' => '*',
        'day' => '*/10', 
        'month' => '*',
        'dayofweek' => '*'
    ],
]

◆ testcase_helper_trait

trait mod_bigbluebuttonbn::test\testcase_helper_trait

Initial value:

{
    
    protected testing_data_generator|null $generator = null

Topics

Directories

Namespaces

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ create_activity_with_recordings()

◆ create_from_dataset()

◆ create_instance()

◆ create_log_entries()

◆ create_recordings_for_instance()

◆ get_course()

◆ get_form_data_from_instance()

◆ setup_course_students_teachers()

◆ xmldb_bigbluebuttonbn_add_change_field()

◆ xmldb_bigbluebuttonbn_index_table()

◆ xmldb_bigbluebuttonbn_install()

◆ xmldb_bigbluebuttonbn_upgrade()

Variable Documentation

◆ $addons

◆ $logs

◆ $messageproviders

◆ $tasks

◆ testcase_helper_trait