 |
Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
|
|
Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
|
Files | |
| file | access.php |
| Capability definitions for the quiz module. | |
| file | activity.php |
| Search area for mod_scorm activities. | |
| file | activity_base.php |
| Activity base class. | |
| file | aicclib.php |
| functions used by AICC packages. | |
| file | attempt_deleted.php |
| The mod_scorm attempt deleted event. | |
| file | backup_scorm_activity_task.class.php |
| Defines backup_scorm_activity_task class. | |
| file | backup_scorm_stepslib.php |
| @subpackage backup-moodle2 | |
| file | cmielement_submitted.php |
| The mod_scorm generic CMI element submitted event. | |
| file | cognitive_depth.php |
| Cognitive depth indicator - scorm. | |
| file | course_module_instance_list_viewed.php |
| The mod_scorm instance list viewed event. | |
| file | course_module_viewed.php |
| The mod_scorm course module viewed event. | |
| file | cron_task.php |
| A scheduled task for scorm cron. | |
| file | external.php |
| SCORM module external API. | |
| file | interactions_viewed.php |
| The mod_scorm interactions viewed event. | |
| file | lib.php |
| Provides support for the conversion of moodle1 backup to the moodle2 format. | |
| file | lib.php |
| file | lib.php |
| mod_scorm data generator. | |
| file | locallib.php |
| Library of internal classes and functions for module SCORM. | |
| file | log.php |
| Definition of log events. | |
| file | provider.php |
| Privacy class for requesting user data. | |
| file | renderer.php |
| Defines the renderer for the scorm module. | |
| file | report.php |
| file | report_viewed.php |
| The mod_scorm report viewed event. | |
| file | reportlib.php |
| Returns an array of reports to which are currently readable. | |
| file | restore_scorm_activity_task.class.php |
| @subpackage backup-moodle2 | |
| file | restore_scorm_stepslib.php |
| @subpackage backup-moodle2 | |
| file | sco_launched.php |
| The mod_scorm sco launched event. | |
| file | scoreraw_submitted.php |
| The mod_scorm raw score submitted event. | |
| file | scormlib.php |
| functions used by SCORM 1.2/2004 packages. | |
| file | scormreport.php |
| Subplugin info class. | |
| file | services.php |
| SCORM external functions and service definitions. | |
| file | social_breadth.php |
| Social breadth indicator - scorm. | |
| file | status_submitted.php |
| The mod_scorm status submitted event. | |
| file | tabs.php |
| Sets up the tabs used by the scorm pages based on the users capabilities. | |
| file | tasks.php |
| Definition of Forum scheduled tasks. | |
| file | tracks_viewed.php |
| The mod_scorm tracks viewed event. | |
| file | upgrade.php |
| Upgrade script for the scorm module. | |
| file | user_report_viewed.php |
| The mod_scorm tracks user report viewed event. | |
| file | userreporttabs.php |
| Sets up the tabs used by the scorm pages based on the users capabilities. | |
| file | version.php |
| scorm version information. | |
Namespaces | |
| namespace | mod_scorm |
| | |
| namespace | mod_scorm\analytics\indicator |
| | |
| namespace | mod_scorm\event |
| | |
| namespace | mod_scorm\plugininfo |
| | |
| namespace | mod_scorm\privacy |
| | |
| namespace | mod_scorm\search |
| | |
| namespace | mod_scorm\task |
| | |
Functions | |
| get_scorm_default (&$userdata, $scorm, $scoid, $attempt, $mode) | |
| Sets up $userdata array and default values for AICC package. More... | |
| get_scorm_question_count ($scormid) | |
| Returns The maximum numbers of Questions associated with an Scorm Pack. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| mod_scorm_get_completion_active_rule_descriptions ($cm) | |
| Callback which returns human-readable strings describing the active completion custom rules for the module instance. More... | |
| 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. More... | |
| 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. More... | |
| scorm_add_time ($a, $b) | |
| scorm_aicc_confirm_hacp_session ($hacpsession) | |
| Check the hacp_session for whether it is valid. More... | |
| scorm_aicc_generate_simple_sco ($scorm) | |
| generate a simple single activity AICC object structure to wrap around and externally linked AICC package URL More... | |
| scorm_aicc_get_hacp_session ($scormid) | |
| Given a scormid creates an AICC Session record to allow HACP. More... | |
| scorm_array_search ($item, $needle, $haystacks, $strict=false) | |
| scorm_check_launchable_sco ($scorm, $scoid) | |
| Check if the current sco is launchable If not, find the next launchable sco. More... | |
| scorm_check_mode ($scorm, &$newattempt, &$attempt, $userid, &$mode) | |
| Check and set the correct mode and attempt when entering a SCORM package. More... | |
| 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. More... | |
| scorm_check_url ($url) | |
| Check for the availability of a resource by URL. More... | |
| scorm_count_launchable ($scormid, $organization='') | |
| 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 ... More... | |
| scorm_debug_log_filename ($type, $scoid) | |
| Get the filename for a temp log file. More... | |
| scorm_debug_log_remove ($type, $scoid) | |
| Remove debug log file. More... | |
| scorm_debug_log_write ($type, $text, $scoid) | |
| writes log output to a temp log file More... | |
| scorm_debugging ($scorm) | |
| Figure out with this is a debug situation. More... | |
| scorm_delete_attempt ($userid, $scorm, $attemptid) | |
| Delete Scorm tracks for selected users. More... | |
| 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. More... | |
| scorm_delete_responses ($attemptids, $scorm) | |
| Delete Scorm tracks for selected users. More... | |
| scorm_dndupload_handle ($uploadinfo) | |
| Handle a file that has been uploaded. More... | |
| scorm_dndupload_register () | |
| Register the ability to handle drag and drop file uploads. More... | |
| scorm_element_cmp ($a, $b) | |
| Build up the JavaScript representation of an array element. More... | |
| scorm_eval_prerequisites ($prerequisites, $usertracks) | |
| This is really a little language parser for AICC_SCRIPT evaluates the expression and returns a boolean answer see 2.3.2.5.1. More... | |
| scorm_external_link ($link) | |
| scorm_find_common_ancestor ($ancestors, $sco) | |
| scorm_forge_cols_regexp ($columns, $remodule='(".*")?,') | |
| Given a colums array return a string containing the regular expression to match the columns in a text row. More... | |
| scorm_format_duration ($duration) | |
| Converts SCORM duration notation to human-readable format The function works with both SCORM 1.2 and SCORM 2004 time formats. More... | |
| scorm_format_interactions ($trackdata) | |
| helper function to return a formatted list of interactions for reports. More... | |
| scorm_format_toc_for_droplist ($scorm, $scoes, $usertracks, $currentorg='', $organizationsco=null, $children=false, $level=0, $tocmenus=array()) | |
| scorm_format_toc_for_treeview ($user, $scorm, $scoes, $usertracks, $cmid, $toclink=TOCJSLINK, $currentorg='', $attempt='', $play=false, $organizationsco=null, $children=false) | |
| scorm_get_adlnav_json ($scoes, &$adlnav=array(), $parentscoid=null) | |
| scorm_get_aicc_columns ($row, $mastername='system_id') | |
| Take the header row of an AICC definition file and returns sequence of columns and a pointer to the sco identifier column. More... | |
| scorm_get_all_attempts ($scormid, $userid) | |
| Returns the full list of attempts a user has made. More... | |
| scorm_get_ancestors ($sco) | |
| scorm_get_attempt_count ($userid, $scorm, $returnobjects=false, $ignoremissingcompletion=false) | |
| Get SCORM attempt count. More... | |
| scorm_get_attempt_status ($user, $scorm, $cm='') | |
| Generate the user attempt status string. More... | |
| scorm_get_attempts_array () | |
| Returns an array of the array of attempt options. More... | |
| scorm_get_attemptstatus_array () | |
| Returns an array of the attempt status options. More... | |
| scorm_get_availability_status ($scorm, $checkviewreportcap=false, $context=null, $userid=null) | |
| Check if a SCORM is available for the current user. More... | |
| scorm_get_available_children ($sco) | |
| scorm_get_available_descendent ($descend=array(), $sco) | |
| scorm_get_children ($sco) | |
| scorm_get_completion_state ($course, $cm, $userid, $type) | |
| Obtains the automatic completion state for this scorm based on any conditions in scorm settings. More... | |
| scorm_get_count_users ($scormid, $groupingid=null) | |
| 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). More... | |
| scorm_get_file_areas ($course, $cm, $context) | |
| Lists all file areas current user may browse. More... | |
| scorm_get_file_info ($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) | |
| scorm_get_first_attempt ($scormid, $userid) | |
| Returns the first attempt used - if no attempts yet, returns 1 for first attempt. More... | |
| scorm_get_forceattempt_array () | |
| Returns an array of the force attempt options. More... | |
| scorm_get_grade_method_array () | |
| Returns an array of the array of what grade options. More... | |
| scorm_get_hidetoc_array () | |
| Returns an array of the array of hide table of contents options. More... | |
| scorm_get_last_attempt ($scormid, $userid) | |
| Returns the last attempt used - if no attempts yet, returns 1 for first attempt. More... | |
| scorm_get_last_completed_attempt ($scormid, $userid) | |
| Returns the last completed attempt used - if no completed attempts yet, returns 1 for first attempt. More... | |
| scorm_get_manifest ($blocks, $scoes) | |
| scorm_get_navigation_display_array () | |
| Returns an array of the array of navigation buttons display options. More... | |
| scorm_get_parent ($sco) | |
| scorm_get_popup_display_array () | |
| Returns an array of the array of popup display options. More... | |
| scorm_get_popup_options_array () | |
| Returns an array of the popup options for SCORM and each options default value. More... | |
| scorm_get_post_actions () | |
| List the actions that correspond to a post of this module. More... | |
| scorm_get_preorder (&$preorder=array(), $sco=null) | |
| scorm_get_resources ($blocks) | |
| scorm_get_sco ($id, $what=SCO_ALL) | |
| Returns an object containing all datas relative to the given sco ID. More... | |
| scorm_get_sco_and_launch_url ($scorm, $scoid, $context) | |
| Return a SCO object and the SCO launch URL. More... | |
| scorm_get_sco_runtime ($scormid, $scoid, $userid, $attempt=1) | |
| scorm_get_scoes ($id, $organisation=false) | |
| Returns an object (array) containing all the scoes data related to the given sco ID. More... | |
| scorm_get_siblings ($sco) | |
| scorm_get_skip_view_array () | |
| Returns an array of the array of skip view options. More... | |
| scorm_get_toc ($user, $scorm, $cmid, $toclink=TOCJSLINK, $currentorg='', $scoid='', $mode='normal', $attempt='', $play=false, $tocheader=false) | |
| scorm_get_toc_get_parent_child (&$result, $currentorg) | |
| scorm_get_toc_object ($user, $scorm, $currentorg='', $scoid='', $mode='normal', $attempt='', $play=false, $organizationsco=null) | |
| scorm_get_tracks ($scoid, $userid, $attempt='') | |
| scorm_get_updatefreq_array () | |
| Returns an array of the array of update frequency options. More... | |
| stdClass | scorm_get_user_grades ($scorm, $userid=0) |
| Return grade for given user or all users. More... | |
| scorm_get_view_actions () | |
| List the actions that correspond to a view of this module. More... | |
| scorm_get_what_grade_array () | |
| Returns an array of the array of what grade options. More... | |
| scorm_grade_item_delete ($scorm) | |
| scorm_grade_item_update ($scorm, $grades=null) | |
| scorm_grade_user ($scorm, $userid) | |
| scorm_grade_user_attempt ($scorm, $userid, $attempt=1) | |
| scorm_has_tracks ($scormid, $userid) | |
| simple quick function to return true/false if this user has tracks in this scorm More... | |
| scorm_insert_track ($userid, $scormid, $scoid, $attempt, $element, $value, $forcecompleted=false, $trackdata=null) | |
| scorm_is_leaf ($sco) | |
| scorm_isset ($userdata, $param, $ifempty='') | |
| Check for a parameter in userdata and return it if it's set or return the value from $ifempty if its empty. More... | |
| scorm_launch_sco ($scorm, $sco, $cm, $context, $scourl) | |
| Trigger the scorm_launched event. More... | |
| scorm_option2text ($scorm) | |
| scorm_optionals_data ($item, $standarddata) | |
| scorm_page_type_list ($pagetype, $parentcontext, $currentcontext) | |
| Return a list of page types. More... | |
| scorm_parse ($scorm, $full) | |
| Extracts scrom package, sets up all variables. More... | |
| scorm_parse_aicc (&$scorm) | |
| Sets up AICC packages Called whenever package changes. More... | |
| scorm_parse_scorm (&$scorm, $manifest) | |
| Sets up SCORM 1.2/2004 packages using the manifest file. More... | |
| scorm_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) | |
| scorm_print_launch ($user, $scorm, $action, $cm) | |
| Displays the entry form and toc if required. More... | |
| scorm_print_overview () | |
| scorm_reconstitute_array_element ($sversion, $userdata, $elementname, $children) | |
| Build up the JavaScript representation of an array element. More... | |
| 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. More... | |
| scorm_repeater ($what, $times) | |
| scorm_report_list ($context) | |
| scorm_require_available ($scorm, $checkviewreportcap=false, $context=null) | |
| Requires a SCORM package to be available for the current user. More... | |
| scorm_reset_course_form_defaults ($course) | |
| Course reset form defaults. More... | |
| 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. More... | |
| stdClass | scorm_reset_gradebook ($courseid, $type='') |
| Removes all grades from gradebook. More... | |
| stdClass | scorm_reset_userdata ($data) |
| Actual implementation of the reset course functionality, delete all the scorm attempts for course $data->courseid. More... | |
| scorm_set_completion ($scorm, $userid, $completionstate=COMPLETION_COMPLETE, $grades=array()) | |
| Sets activity completion state. More... | |
| scorm_simple_play ($scorm, $user, $context, $cmid) | |
| scorm_status_options ($withstrings=false) | |
| Return an array of status options. More... | |
| 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 More... | |
| scorm_update_calendar (stdClass $scorm, $cmid) | |
| Update the calendar entries for this scorm activity. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| scorm_validate_package ($file) | |
| Check that a Zip file contains a valid SCORM package. More... | |
| scorm_version_check ($scormversion, $version='') | |
| Returns the SCORM version used. More... | |
| scorm_view ($scorm, $course, $cm, $context) | |
| Trigger the course_module_viewed event. More... | |
| moodle_database | xmldb_scorm_upgrade ($oldversion) |
| $DB More... | |
Variables | |
| $activated = array() | |
| $activated = array() | |
| $capabilities | |
| if(empty($scorm)) if(!isset( $currenttab)) if(!isset($cm)) | $contextmodule = context_module::instance($cm->id) |
| $functions | |
| $inactive = array() | |
| $inactive = array() | |
| $interactionssurl | |
| $logs | |
| $plugin = 2020060900 | |
| $row = array() | |
| $row [] = new tabobject('scoes', $scoesurl, get_string('scoes', 'scorm')) | |
| $row = array() | |
| $scoesurl | |
| if(empty( $scorm)) if(!isset($currenttab)) | $tabs = array() |
| $tabs [] = $row | |
| $tabs = array() | |
| $tasks | |
| const | AVERAGEATTEMPT '1' |
| $plugin | component = 'mod_scorm' |
| const | FIRSTATTEMPT '2' |
| const | GRADEAVERAGE '2' |
| const | GRADEHIGHEST '1' |
| const | GRADESCOES '0' |
| const | GRADESUM '3' |
| const | HIGHESTATTEMPT '0' |
| const | LASTATTEMPT '3' |
| const | SCO_ALL 0 |
| const | SCO_DATA 1 |
| const | SCO_ONLY 2 |
| const | SCORM_12 1 |
| const | SCORM_13 2 |
| const | SCORM_AICC 3 |
| const | SCORM_DISPLAY_ATTEMPTSTATUS_ALL 1 |
| const | SCORM_DISPLAY_ATTEMPTSTATUS_ENTRY 3 |
| const | SCORM_DISPLAY_ATTEMPTSTATUS_MY 2 |
| const | SCORM_DISPLAY_ATTEMPTSTATUS_NO 0 |
| const | SCORM_EVENT_TYPE_CLOSE 'close' |
| const | SCORM_EVENT_TYPE_OPEN 'open' |
| const | SCORM_FORCEATTEMPT_ALWAYS 2 |
| const | SCORM_FORCEATTEMPT_NO 0 |
| const | SCORM_FORCEATTEMPT_ONCOMPLETE 1 |
| const | SCORM_NAV_DISABLED 0 |
| const | SCORM_NAV_FLOATING 2 |
| const | SCORM_NAV_UNDER_CONTENT 1 |
| const | SCORM_SKIPVIEW_ALWAYS '2' |
| const | SCORM_SKIPVIEW_FIRST '1' |
| const | SCORM_SKIPVIEW_NEVER '0' |
| const | SCORM_TOC_DISABLED 3 |
| const | SCORM_TOC_HIDDEN 1 |
| const | SCORM_TOC_POPUP 2 |
| const | SCORM_TOC_SIDE 0 |
| const | SCORM_TYPE_AICCURL 'aiccurl' |
| SCORM_TYPE_AICCURL = external AICC url. | |
| const | SCORM_TYPE_EXTERNAL 'external' |
| SCORM_TYPE_EXTERNAL = external. | |
| const | SCORM_TYPE_LOCAL 'local' |
| SCORM_TYPE_LOCAL = local. | |
| const | SCORM_TYPE_LOCALSYNC 'localsync' |
| SCORM_TYPE_LOCALSYNC = localsync. | |
| const | SCORM_UPDATE_EVERYDAY '2' |
| const | SCORM_UPDATE_EVERYTIME '3' |
| const | SCORM_UPDATE_NEVER '0' |
| const | TOCFULLURL 2 |
| const | TOCJSLINK 1 |
| $plugin | version = 2020061500 |
| get_scorm_default | ( | & | $userdata, |
| $scorm, | |||
| $scoid, | |||
| $attempt, | |||
| $mode | |||
| ) |
Sets up $userdata array and default values for AICC package.
| stdClass | $userdata | an empty stdClass variable that should be set up with user values |
| object | $scorm | package record |
| string | $scoid | SCO Id |
| string | $attempt | attempt number for the user |
| string | $mode | scorm display mode type |
| array | The default values that should be used for AICC package |
| get_scorm_question_count | ( | $scormid | ) |
Returns The maximum numbers of Questions associated with an Scorm Pack.
| int | Scorm ID |
| int | an integer representing the question count |
| 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.
It will set the timeopen or timeclose value of the scorm instance according to the type of event provided.
| moodle_exception |
| calendar_event | $event | |
| stdClass | $scorm | The module instance to get the range from |
| 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.
It will return an array with two values, the first being the minimum cutoff value and the second being the maximum cutoff value. Either or both values can be null, which indicates there is no minimum or maximum, respectively.
If a cutoff is required then the function must return an array containing the cutoff timestamp and error string to display to the user if the cutoff value is violated.
A minimum and maximum cutoff return value will look like: [ [1505704373, 'The date must be after this date'], [1506741172, 'The date must be before this date'] ]
| calendar_event | $event | The calendar event to get the time range for |
| stdClass | $instance | The module instance to get the range from |
| array | Returns an array with min and max date. |
| 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.
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.
| calendar_event | $event | |
| core_calendar::action_factory | $factory | |
| int | $userid | User id override |
| core_calendar::local::event::entities::action_interface|null |
| mod_scorm_get_completion_active_rule_descriptions | ( | $cm | ) |
Callback which returns human-readable strings describing the active completion custom rules for the module instance.
| cm_info | stdClass | $cm | object with fields ->completion and ->customdata['customcompletionrules'] |
| array::$descriptions | the array of descriptions for the custom rules. |
| 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.
| string | $filearea | The filearea. |
| array | $args | The path (the part after the filearea and before the filename). |
| array | The itemid and the filepath inside the $args path, 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.
@global object @uses CONTEXT_MODULE @uses SCORM_TYPE_LOCAL @uses SCORM_TYPE_LOCALSYNC @uses SCORM_TYPE_EXTERNAL
| object | $scorm | Form data |
| object | $mform |
| int | new instance id |
| scorm_aicc_confirm_hacp_session | ( | $hacpsession | ) |
Check the hacp_session for whether it is valid.
| string | $hacpsession | The hacpsession value to check (optional). Normally leave this blank and this function will do required_param('sesskey', ...). |
| mixed | - false if invalid, otherwise returns record from scorm_aicc_session table. |
| scorm_aicc_generate_simple_sco | ( | $scorm | ) |
generate a simple single activity AICC object structure to wrap around and externally linked AICC package URL
| object | $scorm | package record |
| scorm_aicc_get_hacp_session | ( | $scormid | ) |
Given a scormid creates an AICC Session record to allow HACP.
| int | $scormid | - id from scorm table |
| string | hacpsession |
| scorm_check_launchable_sco | ( | $scorm, | |
| $scoid | |||
| ) |
Check if the current sco is launchable If not, find the next launchable sco.
| stdClass | $scorm | Scorm object |
| integer | $scoid | id of scorm_scoes record. |
| integer | scoid of correct sco to launch or empty if one cannot be found, which will trigger first sco. |
| scorm_check_mode | ( | $scorm, | |
| & | $newattempt, | ||
| & | $attempt, | ||
| $userid, | |||
| & | $mode | ||
| ) |
Check and set the correct mode and attempt when entering a SCORM package.
| object | $scorm | object |
| string | $newattempt | should a new attempt be generated here. |
| int | $attempt | the attempt number this is for. |
| int | $userid | the userid of the user. |
| string | $mode | the current mode that has been selected. |
| 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.
| cm_info | $cm | course module data |
| int | $from | the time to check updates from |
| array | $filter | if we need to check only specific updates |
| stdClass | an object with the different type of areas indicating if they were updated or not |
| scorm_check_url | ( | $url | ) |
Check for the availability of a resource by URL.
Check is performed using an HTTP HEAD call.
| $url | string A valid URL |
| bool|string | True if no issue is found. The error string message, otherwise |
| 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 ...
@global object
| boolean |
| scorm_debug_log_filename | ( | $type, | |
| $scoid | |||
| ) |
Get the filename for a temp log file.
| string | $type | - type of log(aicc,scorm12,scorm13) used as prefix for filename |
| integer | $scoid | - scoid of object this log entry is for |
| string | The filename as an absolute path |
| scorm_debug_log_remove | ( | $type, | |
| $scoid | |||
| ) |
Remove debug log file.
| string | $type | - type of log(aicc,scorm12,scorm13) used as prefix for filename |
| integer | $scoid | - scoid of object this log entry is for |
| boolean | True if the file is successfully deleted, false otherwise |
| scorm_debug_log_write | ( | $type, | |
| $text, | |||
| $scoid | |||
| ) |
writes log output to a temp log file
| string | $type | - type of log(aicc,scorm12,scorm13) used as prefix for filename |
| string | $text | - text to be written to file. |
| integer | $scoid | - scoid of object this log entry is for. |
| scorm_debugging | ( | $scorm | ) |
Figure out with this is a debug situation.
| object | $scorm | a moodle scrom object - mdl_scorm |
| boolean | - debugging true/false |
| scorm_delete_attempt | ( | $userid, | |
| $scorm, | |||
| $attemptid | |||
| ) |
Delete Scorm tracks for selected users.
| int | $userid | ID of User |
| stdClass | $scorm | Scorm object |
| int | $attemptid | user attempt that need to be deleted |
| bool | true suceeded |
| 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.
@global object
| int | $id | Scorm instance id |
| boolean |
| scorm_delete_responses | ( | $attemptids, | |
| $scorm | |||
| ) |
Delete Scorm tracks for selected users.
| array | $attemptids | list of attempts that need to be deleted |
| stdClass | $scorm | instance |
| bool | true deleted all responses, false failed deleting an attempt - stopped here |
| scorm_dndupload_handle | ( | $uploadinfo | ) |
Handle a file that has been uploaded.
| object | $uploadinfo | details of the file / content that has been uploaded |
| int | instance id of the newly created mod |
| scorm_dndupload_register | ( | ) |
Register the ability to handle drag and drop file uploads.
| array | containing details of the files / types the mod can handle |
| scorm_element_cmp | ( | $a, | |
| $b | |||
| ) |
Build up the JavaScript representation of an array element.
| string | $a | left array element |
| string | $b | right array element |
| comparator | - 0,1,-1 |
| scorm_eval_prerequisites | ( | $prerequisites, | |
| $usertracks | |||
| ) |
This is really a little language parser for AICC_SCRIPT evaluates the expression and returns a boolean answer see 2.3.2.5.1.
Sequencing/Navigation Today - from the SCORM 1.2 spec (CAM). Also used by AICC packages.
| string | $prerequisites | the aicc_script prerequisites expression |
| array | $usertracks | the tracked user data of each SCO visited |
| boolean |
| scorm_forge_cols_regexp | ( | $columns, | |
$remodule = '(".*")?, |
|||
| ' | |||
| ) |
Given a colums array return a string containing the regular expression to match the columns in a text row.
| array | $column | The header columns |
| string | $remodule | The regular expression module for a single column |
| string |
| scorm_format_duration | ( | $duration | ) |
Converts SCORM duration notation to human-readable format The function works with both SCORM 1.2 and SCORM 2004 time formats.
| $duration | string SCORM duration |
| string | human-readable date/time |
| scorm_format_interactions | ( | $trackdata | ) |
helper function to return a formatted list of interactions for reports.
| array | $trackdata | the records from scorm_scoes_track table |
| object | formatted list of interactions |
| scorm_get_aicc_columns | ( | $row, | |
$mastername = 'system_id' |
|||
| ) |
Take the header row of an AICC definition file and returns sequence of columns and a pointer to the sco identifier column.
| string | $row | AICC header row |
| string | $mastername | AICC sco identifier column |
| mixed |
| scorm_get_all_attempts | ( | $scormid, | |
| $userid | |||
| ) |
Returns the full list of attempts a user has made.
| int | $scormid | the id of the scorm. |
| int | $userid | the id of the user. |
| array | array of attemptids |
| scorm_get_attempt_count | ( | $userid, | |
| $scorm, | |||
$returnobjects = false, |
|||
$ignoremissingcompletion = false |
|||
| ) |
Get SCORM attempt count.
| object | $user | Current context user |
| object | $scorm | a moodle scrom object - mdl_scorm |
| bool | $returnobjects | if true returns a object with attempts, if false returns count of attempts. |
| bool | $ignoremissingcompletion | - ignores attempts that haven't reported a grade/completion. |
| int | - no. of attempts so far |
| scorm_get_attempt_status | ( | $user, | |
| $scorm, | |||
$cm = '' |
|||
| ) |
Generate the user attempt status string.
| object | $user | Current context user |
| object | $scorm | a moodle scrom object - mdl_scorm |
| string | - Attempt status string |
| scorm_get_attempts_array | ( | ) |
Returns an array of the array of attempt options.
| array | an array of attempt options |
| scorm_get_attemptstatus_array | ( | ) |
Returns an array of the attempt status options.
| array | an array of attempt status options |
| scorm_get_availability_status | ( | $scorm, | |
$checkviewreportcap = false, |
|||
$context = null, |
|||
$userid = null |
|||
| ) |
Check if a SCORM is available for the current user.
| stdClass | $scorm | SCORM record |
| boolean | $checkviewreportcap | Check the scorm:viewreport cap |
| stdClass | $context | Module context, required if $checkviewreportcap is set to true |
| int | $userid | User id override |
| array | status (available or not and possible warnings) |
| scorm_get_completion_state | ( | $course, | |
| $cm, | |||
| $userid, | |||
| $type | |||
| ) |
Obtains the automatic completion state for this scorm based on any conditions in scorm settings.
| object | $course | Course |
| object | $cm | Course-module |
| int | $userid | User ID |
| bool | $type | Type of comparison (or/and; can be used as return value if no conditions) |
| bool | True if completed, false if not. (If no conditions, then return value depends on comparison type) |
| 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).
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.
| stdClass | $coursemodule | The coursemodule object (record). |
| cached_cm_info | An object on information that the courses will know about (most noticeably, an icon). |
| scorm_get_file_areas | ( | $course, | |
| $cm, | |||
| $context | |||
| ) |
Lists all file areas current user may browse.
| object | $course | |
| object | $cm | |
| object | $context |
| array |
| scorm_get_first_attempt | ( | $scormid, | |
| $userid | |||
| ) |
Returns the first attempt used - if no attempts yet, returns 1 for first attempt.
| int | $scormid | the id of the scorm. |
| int | $userid | the id of the user. |
| int | The first attempt number. |
| scorm_get_forceattempt_array | ( | ) |
Returns an array of the force attempt options.
| array | an array of attempt options |
| scorm_get_grade_method_array | ( | ) |
Returns an array of the array of what grade options.
| array | an array of what grade options |
| scorm_get_hidetoc_array | ( | ) |
Returns an array of the array of hide table of contents options.
| array | an array of hide table of contents options |
| scorm_get_last_attempt | ( | $scormid, | |
| $userid | |||
| ) |
Returns the last attempt used - if no attempts yet, returns 1 for first attempt.
| int | $scormid | the id of the scorm. |
| int | $userid | the id of the user. |
| int | The attempt number to use. |
| scorm_get_last_completed_attempt | ( | $scormid, | |
| $userid | |||
| ) |
Returns the last completed attempt used - if no completed attempts yet, returns 1 for first attempt.
| int | $scormid | the id of the scorm. |
| int | $userid | the id of the user. |
| int | The attempt number to use. |
| scorm_get_navigation_display_array | ( | ) |
Returns an array of the array of navigation buttons display options.
| array | an array of navigation buttons display options |
| scorm_get_popup_display_array | ( | ) |
Returns an array of the array of popup display options.
| array | an array of popup display options |
| scorm_get_popup_options_array | ( | ) |
Returns an array of the popup options for SCORM and each options default value.
| array | an array of popup options as the key and their defaults as the value |
| scorm_get_post_actions | ( | ) |
List the actions that correspond to a post of this module.
This is used by the participation report.
Note: This is not used by new logging system. Event with crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING will be considered as post action.
| array |
| scorm_get_sco | ( | $id, | |
$what = SCO_ALL |
|||
| ) |
Returns an object containing all datas relative to the given sco ID.
| integer | $id | The sco ID |
| mixed | (false if sco id does not exists) |
| scorm_get_sco_and_launch_url | ( | $scorm, | |
| $scoid, | |||
| $context | |||
| ) |
Return a SCO object and the SCO launch URL.
| stdClass | $scorm | SCORM object |
| int | $scoid | The SCO id in database |
| stdClass | $context | context object |
| array | the SCO object and URL |
| scorm_get_scoes | ( | $id, | |
$organisation = false |
|||
| ) |
Returns an object (array) containing all the scoes data related to the given sco ID.
| integer | $id | The sco ID |
| integer | $organisation | an organisation ID - defaults to false if not required |
| mixed | (false if there are no scoes or an array) |
| scorm_get_skip_view_array | ( | ) |
Returns an array of the array of skip view options.
| array | an array of skip view options |
| scorm_get_updatefreq_array | ( | ) |
Returns an array of the array of update frequency options.
| array | an array of update frequency options |
| stdClass scorm_get_user_grades | ( | $scorm, | |
$userid = 0 |
|||
| ) |
Return grade for given user or all users.
@global object
| int | $scormid | id of scorm |
| int | $userid | optional user id, 0 means all users |
| array | array of grades, false if none |
| scorm_get_view_actions | ( | ) |
List the actions that correspond to a view of this module.
This is used by the participation report.
Note: This is not used by new logging system. Event with crud = 'r' and edulevel = LEVEL_PARTICIPATING will be considered as view action.
| array |
| scorm_get_what_grade_array | ( | ) |
Returns an array of the array of what grade options.
| array | an array of what grade options |
| scorm_has_tracks | ( | $scormid, | |
| $userid | |||
| ) |
simple quick function to return true/false if this user has tracks in this scorm
| integer | $scormid | The scorm ID |
| integer | $userid | the users id |
| boolean | (false if there are no tracks) |
| scorm_isset | ( | $userdata, | |
| $param, | |||
$ifempty = '' |
|||
| ) |
Check for a parameter in userdata and return it if it's set or return the value from $ifempty if its empty.
| stdClass | $userdata | Contains user's data |
| string | $param | parameter that should be checked |
| string | $ifempty | value to be replaced with if $param is not set |
| string | value from $userdata->$param if its not empty, or $ifempty |
| scorm_launch_sco | ( | $scorm, | |
| $sco, | |||
| $cm, | |||
| $context, | |||
| $scourl | |||
| ) |
Trigger the scorm_launched event.
| stdClass | $scorm | scorm object |
| stdClass | $sco | sco object |
| stdClass | $cm | course module object |
| stdClass | $context | context object |
| string | $scourl | SCO URL |
| scorm_option2text | ( | $scorm | ) |
| object | $scorm |
| object::$scorm |
| scorm_page_type_list | ( | $pagetype, | |
| $parentcontext, | |||
| $currentcontext | |||
| ) |
Return a list of page types.
| string | $pagetype | current page type |
| stdClass | $parentcontext | Block's parent context |
| stdClass | $currentcontext | Current context of block |
| scorm_parse | ( | $scorm, | |
| $full | |||
| ) |
Extracts scrom package, sets up all variables.
Called whenever scorm changes
| object | $scorm | instance - fields are updated and changes saved into database |
| bool | $full | force full update if true |
| void |
| scorm_parse_aicc | ( | & | $scorm | ) |
Sets up AICC packages Called whenever package changes.
| object | $scorm | instance - fields are updated and changes saved into database |
| bool |
| scorm_parse_scorm | ( | & | $scorm, |
| $manifest | |||
| ) |
Sets up SCORM 1.2/2004 packages using the manifest file.
Called whenever SCORM changes
| object | $scorm | instance - fields are updated and changes saved into database |
| stored_file | string | $manifest | - path to manifest file or stored_file. |
| bool |
| scorm_print_launch | ( | $user, | |
| $scorm, | |||
| $action, | |||
| $cm | |||
| ) |
Displays the entry form and toc if required.
| stdClass | $user | user object |
| stdClass | $scorm | scorm object |
| string | $action | base URL for the organizations select box |
| stdClass | $cm | course module object |
| scorm_print_overview | ( | ) |
| scorm_reconstitute_array_element | ( | $sversion, | |
| $userdata, | |||
| $elementname, | |||
| $children | |||
| ) |
Build up the JavaScript representation of an array element.
| string | $sversion | SCORM API version |
| array | $userdata | User track data |
| string | $elementname | Name of array element to get values for |
| array | $children | list of sub elements of this array element that also need instantiating |
| Javascript | array elements |
| 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.
If courseid = 0, then every scorm event in the site is checked, else only scorm events belonging to the course specified are checked.
| int | $courseid | |
| int | stdClass | $instance | scorm module instance or ID. |
| int | stdClass | $cm | Course module object or ID. |
| bool |
| scorm_require_available | ( | $scorm, | |
$checkviewreportcap = false, |
|||
$context = null |
|||
| ) |
Requires a SCORM package to be available for the current user.
| stdClass | $scorm | SCORM record |
| boolean | $checkviewreportcap | Check the scorm:viewreport cap |
| stdClass | $context | Module context, required if $checkviewreportcap is set to true |
| moodle_exception |
| scorm_reset_course_form_defaults | ( | $course | ) |
Course reset form defaults.
| array |
| 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.
| object | $mform | form passed by reference |
| stdClass scorm_reset_gradebook | ( | $courseid, | |
$type = '' |
|||
| ) |
Removes all grades from gradebook.
@global object
| int | $courseid | |
| string | optional type |
| stdClass scorm_reset_userdata | ( | $data | ) |
Actual implementation of the reset course functionality, delete all the scorm attempts for course $data->courseid.
@global object
| object | $data | the data submitted from the reset course. |
| array | status array |
| scorm_set_completion | ( | $scorm, | |
| $userid, | |||
$completionstate = COMPLETION_COMPLETE, |
|||
$grades = array() |
|||
| ) |
Sets activity completion state.
| object | $scorm | object |
| int | $userid | User ID |
| int | $completionstate | Completion state |
| array | $grades | grades array of users with grades - used when $userid = 0 |
| scorm_status_options | ( | $withstrings = false | ) |
Return an array of status options.
Optionally with translated strings
| bool | $with_strings | (optional) |
| array |
| 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
| string | $feature | FEATURE_xx constant for requested feature |
| mixed | True if module supports feature, false if not, null if doesn't know |
| scorm_update_calendar | ( | stdClass | $scorm, |
| $cmid | |||
| ) |
Update the calendar entries for this scorm activity.
| stdClass | $scorm | the row from the database table scorm. |
| int | $cmid | The coursemodule id |
| bool |
| 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.
@global object @uses CONTEXT_MODULE @uses SCORM_TYPE_LOCAL @uses SCORM_TYPE_LOCALSYNC @uses SCORM_TYPE_EXTERNAL
| object | $scorm | Form data |
| object | $mform |
| bool |
| 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.
@global object
| object | $course | |
| object | $user | |
| object | $mod | |
| object | $scorm |
| boolean |
| 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.
| int | $course | Course id |
| int | $user | User id |
| int | $mod | |
| int | $scorm | The scorm id |
| mixed |
| scorm_validate_package | ( | $file | ) |
Check that a Zip file contains a valid SCORM package.
| $file | stored_file a Zip file. |
| array | empty if no issue is found. Array of error message otherwise |
| scorm_version_check | ( | $scormversion, | |
$version = '' |
|||
| ) |
Returns the SCORM version used.
| string | $scormversion | comes from $scorm->version |
| string | $version | one of the defined vars SCORM_12, SCORM_13, SCORM_AICC (or empty) |
| Scorm | version. |
| scorm_view | ( | $scorm, | |
| $course, | |||
| $cm, | |||
| $context | |||
| ) |
Trigger the course_module_viewed event.
| stdClass | $scorm | scorm object |
| stdClass | $course | course object |
| stdClass | $cm | course module object |
| stdClass | $context | context object |
| moodle_database xmldb_scorm_upgrade | ( | $oldversion | ) |
$DB
| int | $oldversion |
| bool |
| $interactionssurl |
| $logs |
| $scoesurl |
| $tasks |
1.9.3