 |
Moodle APIs 4.0
Moodle 4.0.11 (Build: 20231009)
|
|
Moodle APIs 4.0
Moodle 4.0.11 (Build: 20231009)
|
Functions | |
| mod_scorm_core_calendar_event_timestart_updated (\calendar_event $event, stdClass $scorm) | |
| This function will update the scorm module according to the event that has been modified. | |
| mod_scorm_core_calendar_get_event_action_string (string $eventtype) | |
| Callback to fetch the activity event type lang string. | |
| mod_scorm_core_calendar_get_valid_event_timestart_range (\calendar_event $event, stdClass $instance) | |
| This function calculates the minimum and maximum cutoff values for the timestart of the given event. | |
| mod_scorm_core_calendar_provide_event_action (calendar_event $event, core_calendar\action_factory $factory, $userid=null) | |
| This function receives a calendar event and returns the action associated with it, or null if there is none. | |
| mod_scorm_get_completion_active_rule_descriptions ($cm) | |
| Callback which returns human-readable strings describing the active completion custom rules for the module instance. | |
| mod_scorm_get_fontawesome_icon_map () | |
| Get icon mapping for font-awesome. | |
| mod_scorm_get_path_from_pluginfile (string $filearea, array $args) | |
| Given an array with a file path, it returns the itemid and the filepath for the defined filearea. | |
| stdClass | scorm_add_instance ($scorm, $mform=null) |
| 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. | |
| scorm_check_mode ($scorm, &$newattempt, &$attempt, $userid, &$mode) | |
| Check and set the correct mode and attempt when entering a SCORM package. | |
| scorm_check_updates_since (cm_info $cm, $from, $filter=array()) | |
| Check if the module has any update that affects the current user since a given time. | |
| stdClass | scorm_cron_scheduled_task () |
| Function to be run periodically according to the moodle Tasks API This function searches for things that need to be done, such as sending out mail, toggling flags etc ... | |
| scorm_debug_log_filename ($type, $scoid) | |
| Get the filename for a temp log file. | |
| scorm_debug_log_remove ($type, $scoid) | |
| Remove debug log file. | |
| scorm_debug_log_write ($type, $text, $scoid) | |
| writes log output to a temp log file | |
| stdClass | scorm_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. | |
| scorm_dndupload_handle ($uploadinfo) | |
| Handle a file that has been uploaded. | |
| scorm_dndupload_register () | |
| Register the ability to handle drag and drop file uploads. | |
| scorm_extend_settings_navigation (settings_navigation $settings, navigation_node $scormnode) | |
| This function extends the settings navigation block for the site. | |
| scorm_get_coursemodule_info ($coursemodule) | |
| Add a get_coursemodule_info function in case any SCORM type wants to add 'extra' information for the course (see resource). | |
| scorm_get_file_areas ($course, $cm, $context) | |
| Lists all file areas current user may browse. | |
| scorm_get_file_info ($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) | |
| scorm_get_post_actions () | |
| List the actions that correspond to a post of this module. | |
| stdClass | scorm_get_user_grades ($scorm, $userid=0) |
| Return grade for given user or all users. | |
| scorm_get_view_actions () | |
| List the actions that correspond to a view of this module. | |
| scorm_grade_item_delete ($scorm) | |
| scorm_grade_item_update ($scorm, $grades=null) | |
| scorm_option2text ($scorm) | |
| scorm_page_type_list ($pagetype, $parentcontext, $currentcontext) | |
| Return a list of page types. | |
| scorm_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) | |
| scorm_print_overview () | |
| scorm_refresh_events ($courseid=0, $instance=null, $cm=null) | |
| This standard function will check all instances of this module and make sure there are up-to-date events created for each of them. | |
| scorm_reset_course_form_defaults ($course) | |
| Course reset form defaults. | |
| scorm_reset_course_form_definition (&$mform) | |
| Implementation of the function for printing the form elements that control whether the course reset functionality affects the scorm. | |
| stdClass | scorm_reset_gradebook ($courseid, $type='') |
| Removes all grades from gradebook. | |
| stdClass | scorm_reset_userdata ($data) |
| Actual implementation of the reset course functionality, delete all the scorm attempts for course $data->courseid. | |
| scorm_set_completion ($scorm, $userid, $completionstate=COMPLETION_COMPLETE, $grades=array()) | |
| Sets activity completion state. | |
| scorm_status_options ($withstrings=false) | |
| Return an array of status options. | |
| scorm_supports ($feature) | |
| @uses FEATURE_GROUPS @uses FEATURE_GROUPINGS @uses FEATURE_MOD_INTRO @uses FEATURE_COMPLETION_TRACKS_VIEWS @uses FEATURE_COMPLETION_HAS_RULES @uses FEATURE_GRADE_HAS_GRADE @uses FEATURE_GRADE_OUTCOMES | |
| scorm_update_grades ($scorm, $userid=0, $nullifnone=true) | |
| stdClass | scorm_update_instance ($scorm, $mform=null) |
| 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. | |
| stdClass | scorm_user_complete ($course, $user, $mod, $scorm) |
| Print a detailed representation of what a user has done with a given particular instance of this module, for user activity reports. | |
| stdClass | scorm_user_outline ($course, $user, $mod, $scorm) |
| 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. | |
| scorm_validate_package ($file) | |
| Check that a Zip file contains a valid SCORM package. | |
| scorm_version_check ($scormversion, $version='') | |
| Returns the SCORM version used. | |
| scorm_view ($scorm, $course, $cm, $context) | |
| Trigger the course_module_viewed event. | |
1.9.6