Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Differences Between: [Versions 400 and 402] [Versions 401 and 402] [Versions 402 and 403]

Library calls for Moodle and BigBlueButton.

Author: Jesus Federico (jesus [at] blindsidenetworks [dt] com)
Author: Fred Dixon (ffdixon [at] blindsidenetworks [dt] com)
Copyright: 2010 onwards, Blindside Networks Inc
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 770 lines (28 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 24 functions


Functions that are not part of a class:

bigbluebuttonbn_supports($feature)   X-Ref
Indicates API features that the bigbluebuttonbn supports.

param: string $feature
return: mixed True if yes (some features may use other values)

bigbluebuttonbn_add_instance($bigbluebuttonbn)   X-Ref
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.

param: stdClass $bigbluebuttonbn An object from the form in mod_form.php
return: int The id of the newly inserted bigbluebuttonbn record

bigbluebuttonbn_update_instance($bigbluebuttonbn)   X-Ref
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.

param: stdClass $bigbluebuttonbn An object from the form in mod_form.php
return: bool Success/Fail

bigbluebuttonbn_delete_instance($id)   X-Ref
Given an ID of an instance of this module,
this function will permanently delete the instance
and any data that depends on it.

param: int $id Id of the module instance
return: bool Success/Failure

bigbluebuttonbn_user_outline(stdClass $course, stdClass $user, cm_info $mod, stdClass $bigbluebuttonbn)   X-Ref
No description

bigbluebuttonbn_user_complete(stdClass $course, stdClass $user, cm_info $mod, stdClass $bigbluebuttonbn)   X-Ref
Print a detailed representation of what a user has done with
a given particular instance of this module, for user activity reports.

param: stdClass $course
param: stdClass $user
param: cm_info $mod
param: stdClass $bigbluebuttonbn

bigbluebuttonbn_get_completion_aggregation_state()   X-Ref
This flags this module with the capability to override the completion status with the custom completion rules.

return: int

bigbluebuttonbn_get_extra_capabilities()   X-Ref
Returns all other caps used in module.

return: string[]

bigbluebuttonbn_reset_course_form_definition(&$mform)   X-Ref
Called by course/reset.php

param: MoodleQuickForm $mform

bigbluebuttonbn_reset_course_form_defaults(stdClass $course)   X-Ref
Course reset form defaults.

param: stdClass $course
return: array

bigbluebuttonbn_reset_userdata(stdClass $data)   X-Ref
This function is used by the reset_course_userdata function in moodlelib.

param: stdClass $data the data submitted from the reset course.
return: array status array

bigbluebuttonbn_get_coursemodule_info($coursemodule)   X-Ref
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.

param: stdClass $coursemodule
return: null|cached_cm_info

bigbluebuttonbn_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options = [])   X-Ref
Serves the bigbluebuttonbn attachments. Implements needed access control ;-).

param: stdClass $course course object
param: stdClass $cm course module object
param: context $context context object
param: string $filearea file area
param: array $args extra arguments
param: bool $forcedownload whether or not force download
param: array $options additional options affecting the file serving
return: false|null false if file not found, does not return if found - justsend the file

bigbluebuttonbn_view($bigbluebuttonbn, $course, $cm, $context)   X-Ref
Mark the activity completed (if required) and trigger the course_module_viewed event.

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

bigbluebuttonbn_check_updates_since(cm_info $cm, $from, $filter = [])   X-Ref
Check if the module has any update that affects the current user since a given time.

param: cm_info $cm course module data
param: int $from the time to check updates from
param: array $filter if we need to check only specific updates
return: stdClass an object with the different type of areas indicating if they were updated or not

mod_bigbluebuttonbn_core_calendar_provide_event_action(calendar_event $event,action_factory $factory)   X-Ref
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.

param: calendar_event $event
param: action_factory $factory
return: action_interface|null

mod_bigbluebuttonbn_core_calendar_is_event_visible(calendar_event $event)   X-Ref
Is the event visible?

param: calendar_event $event
return: bool Returns true if the event is visible to the current user, false otherwise.

bigbluebuttonbn_extend_settings_navigation(settings_navigation $settingsnav, navigation_node $nodenav)   X-Ref
Adds module specific settings to the settings block

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

bigbluebuttonbn_inplace_editable($itemtype, $itemid, $newvalue)   X-Ref
In place editable for the recording table

param: string $itemtype
param: string $itemid
param: mixed $newvalue
return: mixed|null

bigbluebuttonbn_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid = 0,$groupid = 0)   X-Ref
Returns all events since a given time in specified bigbluebutton activity.
We focus here on the two events: play and join.

param: array $activities
param: int $index
param: int $timestart
param: int $courseid
param: int $cmid
param: int $userid
param: int $groupid
return: array

bigbluebuttonbn_print_recent_mod_activity(stdClass $activity, int $courseid, bool $detail, array $modnames,bool $viewfullnames)   X-Ref
Outputs the bigbluebutton logs indicated by $activity.

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

bigbluebuttonbn_print_recent_activity(object $course, bool $viewfullnames, int $timestart)   X-Ref
Given a course and a date, prints a summary of all the activity for this module

param: object $course
param: bool $viewfullnames capability
param: int $timestart
return: bool success

bigbluebuttonbn_pre_enable_plugin_actions()   X-Ref
Callback method executed prior to enabling the activity module.

return: bool Whether to proceed and enable the plugin or not.

bigbluebuttonbn_course_backend_generator_create_activity(tool_generator_course_backend $backend,testing_data_generator $generator,int $courseid,int $number)   X-Ref
Creates a number of BigblueButtonBN activities.

param: tool_generator_course_backend $backend
param: testing_data_generator $generator
param: int $courseid
param: int $number
return: void