Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/mod/bigbluebuttonbn/ -> lib.php (source)
Differences Between: [Versions 400 and 401] [Versions 400 and 402] [Versions 400 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: | 724 lines (26 kb) |
| Included or required: | 0 times |
| Referenced: | 2 times |
| Includes or requires: | 0 files |
Defines 23 functions
bigbluebuttonbn_supports()
bigbluebuttonbn_add_instance()
bigbluebuttonbn_update_instance()
bigbluebuttonbn_delete_instance()
bigbluebuttonbn_user_outline()
bigbluebuttonbn_user_complete()
bigbluebuttonbn_get_completion_aggregation_state()
bigbluebuttonbn_get_extra_capabilities()
bigbluebuttonbn_reset_course_form_definition()
bigbluebuttonbn_reset_course_form_defaults()
bigbluebuttonbn_reset_userdata()
bigbluebuttonbn_get_coursemodule_info()
bigbluebuttonbn_pluginfile()
bigbluebuttonbn_view()
bigbluebuttonbn_check_updates_since()
mod_bigbluebuttonbn_core_calendar_provide_event_action()
mod_bigbluebuttonbn_core_calendar_is_event_visible()
bigbluebuttonbn_extend_settings_navigation()
bigbluebuttonbn_inplace_editable()
bigbluebuttonbn_get_recent_mod_activity()
bigbluebuttonbn_print_recent_mod_activity()
bigbluebuttonbn_print_recent_activity()
bigbluebuttonbn_pre_enable_plugin_actions()
bigbluebuttonbn_add_instance()
bigbluebuttonbn_update_instance()
bigbluebuttonbn_delete_instance()
bigbluebuttonbn_user_outline()
bigbluebuttonbn_user_complete()
bigbluebuttonbn_get_completion_aggregation_state()
bigbluebuttonbn_get_extra_capabilities()
bigbluebuttonbn_reset_course_form_definition()
bigbluebuttonbn_reset_course_form_defaults()
bigbluebuttonbn_reset_userdata()
bigbluebuttonbn_get_coursemodule_info()
bigbluebuttonbn_pluginfile()
bigbluebuttonbn_view()
bigbluebuttonbn_check_updates_since()
mod_bigbluebuttonbn_core_calendar_provide_event_action()
mod_bigbluebuttonbn_core_calendar_is_event_visible()
bigbluebuttonbn_extend_settings_navigation()
bigbluebuttonbn_inplace_editable()
bigbluebuttonbn_get_recent_mod_activity()
bigbluebuttonbn_print_recent_mod_activity()
bigbluebuttonbn_print_recent_activity()
bigbluebuttonbn_pre_enable_plugin_actions()
Functions that are not part of a class:
| bigbluebuttonbn_supports($feature) X-Ref |
| Indicates API features that the bigbluebuttonbn supports. return: mixed True if yes (some features may use other values) param: string $feature |
| 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. return: int The id of the newly inserted bigbluebuttonbn record param: stdClass $bigbluebuttonbn An object from the form in mod_form.php |
| 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. return: bool Success/Fail param: stdClass $bigbluebuttonbn An object from the form in mod_form.php |
| 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. return: bool Success/Failure param: int $id Id of the module instance |
| bigbluebuttonbn_user_outline(stdClass $course, stdClass $user, cm_info $mod, stdClass $bigbluebuttonbn) X-Ref |
| 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. return: stdClass with info and time (timestamp of the last log) param: stdClass $course param: stdClass $user param: cm_info $mod param: stdClass $bigbluebuttonbn |
| 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(object &$mform) X-Ref |
| Called by course/reset.php param: object $mform |
| bigbluebuttonbn_reset_course_form_defaults(stdClass $course) X-Ref |
| Course reset form defaults. return: array param: stdClass $course |
| bigbluebuttonbn_reset_userdata(stdClass $data) X-Ref |
| This function is used by the reset_course_userdata function in moodlelib. return: array status array param: stdClass $data the data submitted from the reset course. |
| 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. return: null|cached_cm_info param: stdClass $coursemodule |
| bigbluebuttonbn_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options = []) X-Ref |
| Serves the bigbluebuttonbn attachments. Implements needed access control ;-). return: false|null false if file not found, does not return if found - justsend the file param: stdClass $course course object param: cm_info $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 |
| 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. return: stdClass an object with the different type of areas indicating if they were updated or not 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 |
| 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. return: action_interface|null param: calendar_event $event param: action_factory $factory |
| mod_bigbluebuttonbn_core_calendar_is_event_visible(calendar_event $event) X-Ref |
| Is the event visible? return: bool Returns true if the event is visible to the current user, false otherwise. param: calendar_event $event |
| 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 return: mixed|null param: string $itemtype param: string $itemid param: mixed $newvalue |
| 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. return: array param: array $activities param: int $index param: int $timestart param: int $courseid param: int $cmid param: int $userid param: int $groupid |
| 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 return: bool success param: object $course param: bool $viewfullnames capability param: int $timestart |
| 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. |
