files

Directories
directory	backup

Functions
	bigbluebuttonbn_add_instance ($bigbluebuttonbn)
	Given an object containing all the necessary data, (defined by the form in mod_form.php) this function will create a new instance and return the id number of the new instance.
	bigbluebuttonbn_check_updates_since (cm_info $cm, $from, $filter=[])
	Check if the module has any update that affects the current user since a given time.
	bigbluebuttonbn_course_backend_generator_create_activity (tool_generator_course_backend $backend, testing_data_generator $generator, int $courseid, int $number)
	Creates a number of BigblueButtonBN activities.
	bigbluebuttonbn_delete_instance ($id)
	Given an ID of an instance of this module, this function will permanently delete the instance and any data that depends on it.
	bigbluebuttonbn_extend_settings_navigation (settings_navigation $settingsnav, navigation_node $nodenav)
	Adds module specific settings to the settings block.
	bigbluebuttonbn_get_completion_aggregation_state ()
	This flags this module with the capability to override the completion status with the custom completion rules.
	bigbluebuttonbn_get_coursemodule_info ($coursemodule)
	Given a course_module object, this function returns any "extra" information that may be needed when printing this activity in a course listing.
	bigbluebuttonbn_get_extra_capabilities ()
	Returns all other caps used in module.
	bigbluebuttonbn_get_recent_mod_activity (&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0)
	Returns all events since a given time in specified bigbluebutton activity.
	bigbluebuttonbn_inplace_editable ($itemtype, $itemid, $newvalue)
	In place editable for the recording table.
	bigbluebuttonbn_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=[])
	Serves the bigbluebuttonbn attachments.
	bigbluebuttonbn_pre_enable_plugin_actions ()
	Callback method executed prior to enabling the activity module.
	bigbluebuttonbn_print_recent_activity (object $course, bool $viewfullnames, int $timestart)
	Given a course and a date, prints a summary of all the activity for this module.
	bigbluebuttonbn_print_recent_mod_activity (stdClass $activity, int $courseid, bool $detail, array $modnames, bool $viewfullnames)
	Outputs the bigbluebutton logs indicated by $activity.
	bigbluebuttonbn_reset_course_form_defaults (stdClass $course)
	Course reset form defaults.
	bigbluebuttonbn_reset_course_form_definition (&$mform)
	Called by course/reset.php.
	bigbluebuttonbn_reset_userdata (stdClass $data)
	This function is used by the reset_course_userdata function in moodlelib.
	bigbluebuttonbn_supports ($feature)
	Indicates API features that the bigbluebuttonbn supports.
	bigbluebuttonbn_update_instance ($bigbluebuttonbn)
	Given an object containing all the necessary data, (defined by the form in mod_form.php) this function will update an existing instance with new data.
	bigbluebuttonbn_user_complete (stdClass $course, stdClass $user, cm_info $mod, stdClass $bigbluebuttonbn)
	Print a detailed representation of what a user has done with a given particular instance of this module, for user activity reports.
	bigbluebuttonbn_user_outline (stdClass $course, stdClass $user, cm_info $mod, stdClass $bigbluebuttonbn)
	Return a small object with summary information about what a user has done with a given particular instance of this module Used for user activity reports.
	bigbluebuttonbn_view ($bigbluebuttonbn, $course, $cm, $context)
	Mark the activity completed (if required) and trigger the course_module_viewed event.
	mod_bigbluebuttonbn_core_calendar_is_event_visible (calendar_event $event)
	Is the event visible?
	mod_bigbluebuttonbn_core_calendar_provide_event_action (calendar_event $event, action_factory $factory)
	This function receives a calendar event and returns the action associated with it, or null if there is none.

Variables
global	$CFG

Detailed Description

Function Documentation

bigbluebuttonbn_add_instance()

bigbluebuttonbn_add_instance

(

$bigbluebuttonbn

)

Given an object containing all the necessary data, (defined by the form in mod_form.php) this function will create a new instance and return the id number of the new instance.

Parameters

stdClass

$bigbluebuttonbn

An object from the form in mod_form.php

Return values

int	The id of the newly inserted bigbluebuttonbn record

bigbluebuttonbn_check_updates_since()

bigbluebuttonbn_check_updates_since	(	cm_info	$cm,
			$from,
			$filter = [] )

Check if the module has any update that affects the current user since a given time.

Parameters

cm_info	$cm	course module data
int	$from	the time to check updates from
array	$filter	if we need to check only specific updates

Return values

stdClass

an object with the different type of areas indicating if they were updated or not

Since

Moodle 3.2

bigbluebuttonbn_course_backend_generator_create_activity()

bigbluebuttonbn_course_backend_generator_create_activity	(	tool_generator_course_backend	$backend,
		testing_data_generator	$generator,
		int	$courseid,
		int	$number )

Creates a number of BigblueButtonBN activities.

Parameters

tool_generator_course_backend	$backend
testing_data_generator	$generator
int	$courseid
int	$number

Return values

void

bigbluebuttonbn_delete_instance()

bigbluebuttonbn_delete_instance

(

$id

)

Given an ID of an instance of this module, this function will permanently delete the instance and any data that depends on it.

Parameters

int

$id

Id of the module instance

Return values

bool	Success/Failure

bigbluebuttonbn_extend_settings_navigation()

bigbluebuttonbn_extend_settings_navigation	(	settings_navigation	$settingsnav,
		navigation_node	$nodenav )

Adds module specific settings to the settings block.

Parameters

settings_navigation	$settingsnav	The settings navigation object
navigation_node	$nodenav	The node to add module settings to

bigbluebuttonbn_get_completion_aggregation_state()

bigbluebuttonbn_get_completion_aggregation_state

(

)

This flags this module with the capability to override the completion status with the custom completion rules.

Return values

int

bigbluebuttonbn_get_coursemodule_info()

bigbluebuttonbn_get_coursemodule_info

(

$coursemodule

)

Given a course_module object, this function returns any "extra" information that may be needed when printing this activity in a course listing.

See get_array_of_activities() in course/lib.php.

Parameters

stdClass

$coursemodule

Return values

null|cached_cm_info

bigbluebuttonbn_get_extra_capabilities()

bigbluebuttonbn_get_extra_capabilities

(

)

Returns all other caps used in module.

Return values

string[]

bigbluebuttonbn_get_recent_mod_activity()

bigbluebuttonbn_get_recent_mod_activity	(	&	$activities,
		&	$index,
			$timestart,
			$courseid,
			$cmid,
			$userid = 0,
			$groupid = 0 )

Returns all events since a given time in specified bigbluebutton activity.

We focus here on the two events: play and join.

Parameters

array	$activities
int	$index
int	$timestart
int	$courseid
int	$cmid
int	$userid
int	$groupid

Return values

array

bigbluebuttonbn_inplace_editable()

bigbluebuttonbn_inplace_editable	(		$itemtype,
			$itemid,
			$newvalue )

In place editable for the recording table.

Parameters

string	$itemtype
string	$itemid
mixed	$newvalue

Return values

mixed|null

bigbluebuttonbn_pluginfile()

bigbluebuttonbn_pluginfile	(		$course,
			$cm,
			$context,
			$filearea,
			$args,
			$forcedownload,
		array	$options = [] )

Serves the bigbluebuttonbn attachments.

Implements needed access control ;-).

Parameters

stdClass	$course	course object
stdClass	$cm	course module object
context	$context	context object
string	$filearea	file area
array	$args	extra arguments
bool	$forcedownload	whether or not force download
array	$options	additional options affecting the file serving

Return values

false|null

false if file not found, does not return if found - justsend the file

bigbluebuttonbn_pre_enable_plugin_actions()

bigbluebuttonbn_pre_enable_plugin_actions

(

)

Callback method executed prior to enabling the activity module.

Return values

bool	Whether to proceed and enable the plugin or not.

bigbluebuttonbn_print_recent_activity()

bigbluebuttonbn_print_recent_activity	(	object	$course,
		bool	$viewfullnames,
		int	$timestart )

Given a course and a date, prints a summary of all the activity for this module.

Parameters

object	$course
bool	$viewfullnames	capability
int	$timestart

Return values

bool

success

bigbluebuttonbn_print_recent_mod_activity()

bigbluebuttonbn_print_recent_mod_activity	(	stdClass	$activity,
		int	$courseid,
		bool	$detail,
		array	$modnames,
		bool	$viewfullnames )

Outputs the bigbluebutton logs indicated by $activity.

Parameters

stdClass	$activity	the activity object the bigbluebuttonbn resides in
int	$courseid	the id of the course the bigbluebuttonbn resides in
bool	$detail	not used, but required for compatibilty with other modules
array	$modnames	not used, but required for compatibilty with other modules
bool	$viewfullnames	not used, but required for compatibilty with other modules

bigbluebuttonbn_reset_course_form_defaults()

bigbluebuttonbn_reset_course_form_defaults

(

stdClass

$course

)

Course reset form defaults.

Parameters

stdClass

$course

Return values

array

bigbluebuttonbn_reset_course_form_definition()

bigbluebuttonbn_reset_course_form_definition

(

&

$mform

)

Called by course/reset.php.

Parameters

MoodleQuickForm

$mform

bigbluebuttonbn_reset_userdata()

bigbluebuttonbn_reset_userdata

(

stdClass

$data

)

This function is used by the reset_course_userdata function in moodlelib.

Parameters

stdClass

$data

the data submitted from the reset course.

Return values

array

status array

bigbluebuttonbn_supports()

bigbluebuttonbn_supports

(

$feature

)

Indicates API features that the bigbluebuttonbn supports.

Parameters

string

$feature

Return values

mixed

True if yes (some features may use other values) @uses FEATURE_IDNUMBER @uses FEATURE_GROUPS @uses FEATURE_GROUPINGS @uses FEATURE_GROUPMEMBERSONLY @uses FEATURE_MOD_INTRO @uses FEATURE_BACKUP_MOODLE2 @uses FEATURE_COMPLETION_TRACKS_VIEWS @uses FEATURE_COMPLETION_HAS_RULES @uses FEATURE_GRADE_HAS_GRADE @uses FEATURE_GRADE_OUTCOMES @uses FEATURE_SHOW_DESCRIPTION

bigbluebuttonbn_update_instance()

bigbluebuttonbn_update_instance

(

$bigbluebuttonbn

)

Given an object containing all the necessary data, (defined by the form in mod_form.php) this function will update an existing instance with new data.

Parameters

stdClass

$bigbluebuttonbn

An object from the form in mod_form.php

Return values

bool	Success/Fail

bigbluebuttonbn_user_complete()

bigbluebuttonbn_user_complete	(	stdClass	$course,
		stdClass	$user,
		cm_info	$mod,
		stdClass	$bigbluebuttonbn )

Print a detailed representation of what a user has done with a given particular instance of this module, for user activity reports.

Parameters

stdClass	$course
stdClass	$user
cm_info	$mod
stdClass	$bigbluebuttonbn

bigbluebuttonbn_user_outline()

bigbluebuttonbn_user_outline	(	stdClass	$course,
		stdClass	$user,
		cm_info	$mod,
		stdClass	$bigbluebuttonbn )

Return a small object with summary information about what a user has done with a given particular instance of this module Used for user activity reports.

Parameters

stdClass	$course
stdClass	$user
cm_info	$mod
stdClass	$bigbluebuttonbn

Return values

stdClass

with info and time (timestamp of the last log)

bigbluebuttonbn_view()

bigbluebuttonbn_view	(		$bigbluebuttonbn,
			$course,
			$cm,
			$context )

Mark the activity completed (if required) and trigger the course_module_viewed event.

Parameters

stdClass	$bigbluebuttonbn	bigbluebuttonbn object
stdClass	$course	course object
cm_info	$cm	course module object
context	$context	context object

Since

Moodle 3.0

mod_bigbluebuttonbn_core_calendar_is_event_visible()

mod_bigbluebuttonbn_core_calendar_is_event_visible

(

calendar_event

$event

)

Is the event visible?

Parameters

calendar_event

$event

Return values

bool	Returns true if the event is visible to the current user, false otherwise.

mod_bigbluebuttonbn_core_calendar_provide_event_action()

mod_bigbluebuttonbn_core_calendar_provide_event_action	(	calendar_event	$event,
		action_factory	$factory )

This function receives a calendar event and returns the action associated with it, or null if there is none.

This is used by block_myoverview in order to display the event appropriately. If null is returned then the event is not displayed on the block.

Parameters

calendar_event	$event
action_factory	$factory

Return values

action_interface|null