| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | 1999 onwards Martin Dougiamas {@link http://moodle.com} |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 1480 lines (52 kb) |
| Included or required: | 1 time |
| Referenced: | 7 times |
| Includes or requires: | 0 files |
| scorm_status_options($withstrings = false) X-Ref |
| Return an array of status options Optionally with translated strings param: bool $with_strings (optional) return: array |
| scorm_add_instance($scorm, $mform=null) 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: object $scorm Form data param: object $mform return: int new instance id |
| scorm_update_instance($scorm, $mform=null) 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: object $scorm Form data param: object $mform return: bool |
| scorm_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 Scorm instance id return: boolean |
| scorm_user_outline($course, $user, $mod, $scorm) 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. param: int $course Course id param: int $user User id param: int $mod param: int $scorm The scorm id return: mixed |
| scorm_user_complete($course, $user, $mod, $scorm) 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: object $course param: object $user param: object $mod param: object $scorm return: boolean |
| scorm_cron() X-Ref |
| Function to be run periodically according to the moodle cron This function searches for things that need to be done, such as sending out mail, toggling flags etc ... return: boolean |
| scorm_get_user_grades($scorm, $userid=0) X-Ref |
| Return grade for given user or all users. param: int $scormid id of scorm param: int $userid optional user id, 0 means all users return: array array of grades, false if none |
| scorm_update_grades($scorm, $userid=0, $nullifnone=true) X-Ref |
| Update grades in central gradebook param: object $scorm param: int $userid specific user only, 0 mean all param: bool $nullifnone |
| scorm_grade_item_update($scorm, $grades=null) X-Ref |
| Update/create grade item for given scorm param: object $scorm object with extra cmidnumber param: mixed $grades optional array/object of grade(s); 'reset' means reset grades in gradebook return: object grade_item |
| scorm_grade_item_delete($scorm) X-Ref |
| Delete grade item for given scorm param: object $scorm object return: object grade_item |
| scorm_get_view_actions() X-Ref |
| 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. return: array |
| scorm_get_post_actions() X-Ref |
| 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. return: array |
| scorm_option2text($scorm) X-Ref |
param: object $scorm return: object $scorm |
| scorm_reset_course_form_definition(&$mform) X-Ref |
| Implementation of the function for printing the form elements that control whether the course reset functionality affects the scorm. param: object $mform form passed by reference |
| scorm_reset_course_form_defaults($course) X-Ref |
| Course reset form defaults. return: array |
| scorm_reset_gradebook($courseid, $type='') X-Ref |
| Removes all grades from gradebook param: int $courseid param: string optional type |
| scorm_reset_userdata($data) X-Ref |
| Actual implementation of the reset course functionality, delete all the scorm attempts for course $data->courseid. param: object $data the data submitted from the reset course. return: array status array |
| scorm_get_extra_capabilities() X-Ref |
| Returns all other caps used in module return: array |
| scorm_get_file_areas($course, $cm, $context) X-Ref |
| Lists all file areas current user may browse param: object $course param: object $cm param: object $context return: array |
| scorm_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) X-Ref |
| File browsing support for SCORM file areas param: file_browser $browser file browser instance param: array $areas file areas param: stdClass $course course object param: stdClass $cm course module object param: stdClass $context context object param: string $filearea file area param: int $itemid item ID param: string $filepath file path param: string $filename file name return: file_info instance or null if not found |
| scorm_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array() X-Ref |
| Serves scorm content, introduction images and packages. Implements needed access control ;-) param: stdClass $course course object param: stdClass $cm course module object param: stdClass $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: bool false if file not found, does not return if found - just send the file |
| scorm_supports($feature) X-Ref |
param: string $feature FEATURE_xx constant for requested feature return: mixed True if module supports feature, false if not, null if doesn't know |
| scorm_debug_log_filename($type, $scoid) X-Ref |
| Get the filename for a temp log file param: string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename param: integer $scoid - scoid of object this log entry is for return: string The filename as an absolute path |
| scorm_debug_log_write($type, $text, $scoid) X-Ref |
| writes log output to a temp log file param: string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename param: string $text - text to be written to file. param: integer $scoid - scoid of object this log entry is for. |
| scorm_debug_log_remove($type, $scoid) X-Ref |
| Remove debug log file param: string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename param: integer $scoid - scoid of object this log entry is for return: boolean True if the file is successfully deleted, false otherwise |
| scorm_print_overview($courses, &$htmlarray) X-Ref |
| writes overview info for course_overview block - displays upcoming scorm objects that have a due date param: object $type - type of log(aicc,scorm12,scorm13) used as prefix for filename param: array $htmlarray return: mixed |
| scorm_page_type_list($pagetype, $parentcontext, $currentcontext) X-Ref |
| Return a list of page types param: string $pagetype current page type param: stdClass $parentcontext Block's parent context param: stdClass $currentcontext Current context of block |
| scorm_version_check($scormversion, $version='') X-Ref |
| Returns the SCORM version used. param: string $scormversion comes from $scorm->version param: string $version one of the defined vars SCORM_12, SCORM_13, SCORM_AICC (or empty) return: Scorm version. |
| scorm_get_completion_state($course, $cm, $userid, $type) X-Ref |
| Obtains the automatic completion state for this scorm based on any conditions in scorm settings. param: object $course Course param: object $cm Course-module param: int $userid User ID param: bool $type Type of comparison (or/and; can be used as return value if no conditions) return: bool True if completed, false if not. (If no conditions, then return |
| scorm_dndupload_register() X-Ref |
| Register the ability to handle drag and drop file uploads return: array containing details of the files / types the mod can handle |
| scorm_dndupload_handle($uploadinfo) X-Ref |
| Handle a file that has been uploaded param: object $uploadinfo details of the file / content that has been uploaded return: int instance id of the newly created mod |
| scorm_set_completion($scorm, $userid, $completionstate = COMPLETION_COMPLETE, $grades = array() X-Ref |
| Sets activity completion state param: object $scorm object param: int $userid User ID param: int $completionstate Completion state param: array $grades grades array of users with grades - used when $userid = 0 |
| scorm_validate_package($file) X-Ref |
| Check that a Zip file contains a valid SCORM package param: $file stored_file a Zip file. return: array empty if no issue is found. Array of error message otherwise |
| scorm_check_mode($scorm, &$newattempt, &$attempt, $userid, &$mode) X-Ref |
| Check and set the correct mode and attempt when entering a SCORM package. param: object $scorm object param: string $newattempt should a new attempt be generated here. param: int $attempt the attempt number this is for. param: int $userid the userid of the user. param: string $mode the current mode that has been selected. |
| scorm_view($scorm, $course, $cm, $context) X-Ref |
| Trigger the course_module_viewed event. param: stdClass $scorm scorm object param: stdClass $course course object param: stdClass $cm course module object param: stdClass $context context object |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |