Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
- Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
- PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/mod/h5pactivity/ -> lib.php (source)
Differences Between: [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]
Library of interface functions and constants.
| Copyright: | 2020 Ferran Recio <ferran@moodle.com> |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 543 lines (19 kb) |
| Included or required: | 3 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 21 functions
h5pactivity_supports()
h5pactivity_add_instance()
h5pactivity_update_instance()
h5pactivity_delete_instance()
h5pactivity_scale_used_anywhere()
h5pactivity_grade_item_update()
h5pactivity_grade_item_delete()
h5pactivity_update_grades()
h5pactivity_rescale_activity_grades()
h5pactivity_reset_course_form_definition()
h5pactivity_reset_course_form_defaults()
h5pactivity_reset_userdata()
h5pactivity_reset_gradebook()
h5pactivity_page_type_list()
h5pactivity_check_updates_since()
h5pactivity_get_file_areas()
h5pactivity_get_file_info()
h5pactivity_pluginfile()
h5pactivity_set_mainfile()
h5pactivity_dndupload_register()
h5pactivity_dndupload_handle()
h5pactivity_add_instance()
h5pactivity_update_instance()
h5pactivity_delete_instance()
h5pactivity_scale_used_anywhere()
h5pactivity_grade_item_update()
h5pactivity_grade_item_delete()
h5pactivity_update_grades()
h5pactivity_rescale_activity_grades()
h5pactivity_reset_course_form_definition()
h5pactivity_reset_course_form_defaults()
h5pactivity_reset_userdata()
h5pactivity_reset_gradebook()
h5pactivity_page_type_list()
h5pactivity_check_updates_since()
h5pactivity_get_file_areas()
h5pactivity_get_file_info()
h5pactivity_pluginfile()
h5pactivity_set_mainfile()
h5pactivity_dndupload_register()
h5pactivity_dndupload_handle()
Functions that are not part of a class:
| h5pactivity_supports(string $feature) X-Ref |
| Checks if H5P activity supports a specific feature. param: string $feature FEATURE_xx constant for requested feature return: mixed True if module supports feature, false if not, null if doesn't know |
| h5pactivity_add_instance(stdClass $data, mod_h5pactivity_mod_form $mform = null) X-Ref |
| Saves a new instance of the mod_h5pactivity into the database. 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 instance. param: stdClass $data An object from the form. param: mod_h5pactivity_mod_form $mform The form. return: int The id of the newly inserted record. |
| h5pactivity_update_instance(stdClass $data, mod_h5pactivity_mod_form $mform = null) X-Ref |
| Updates an instance of the mod_h5pactivity in the database. Given an object containing all the necessary data (defined in mod_form.php), this function will update an existing instance with new data. param: stdClass $data An object from the form in mod_form.php. param: mod_h5pactivity_mod_form $mform The form. return: bool True if successful, false otherwise. |
| h5pactivity_delete_instance(int $id) X-Ref |
| Removes an instance of the mod_h5pactivity from the database. param: int $id Id of the module instance. return: bool True if successful, false on failure. |
| h5pactivity_scale_used_anywhere(int $scaleid) X-Ref |
| Checks if scale is being used by any instance of mod_h5pactivity. This is used to find out if scale used anywhere. param: int $scaleid ID of the scale. return: bool True if the scale is used by any mod_h5pactivity instance. |
| h5pactivity_grade_item_update(stdClass $moduleinstance, $grades = null) X-Ref |
| Creates or updates grade item for the given mod_h5pactivity instance. Needed by {@link grade_update_mod_grades()}. param: stdClass $moduleinstance Instance object with extra cmidnumber and modname property. param: mixed $grades optional array/object of grade(s); 'reset' means reset grades in gradebook return: int int 0 if ok, error code otherwise |
| h5pactivity_grade_item_delete(stdClass $moduleinstance) X-Ref |
| Delete grade item for given mod_h5pactivity instance. param: stdClass $moduleinstance Instance object. return: int Returns GRADE_UPDATE_OK, GRADE_UPDATE_FAILED, GRADE_UPDATE_MULTIPLE or GRADE_UPDATE_ITEM_LOCKED |
| h5pactivity_update_grades(stdClass $moduleinstance, int $userid = 0) X-Ref |
| Update mod_h5pactivity grades in the gradebook. Needed by {@link grade_update_mod_grades()}. param: stdClass $moduleinstance Instance object with extra cmidnumber and modname property. param: int $userid Update grade of specific user only, 0 means all participants. |
| h5pactivity_rescale_activity_grades(stdClass $course, stdClass $cm, float $oldmin,float $oldmax, float $newmin, float $newmax) X-Ref |
| Rescale all grades for this activity and push the new grades to the gradebook. param: stdClass $course Course db record param: stdClass $cm Course module db record param: float $oldmin param: float $oldmax param: float $newmin param: float $newmax return: bool true if reescale is successful |
| h5pactivity_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 H5P activity. param: object $mform form passed by reference |
| h5pactivity_reset_course_form_defaults(stdClass $course) X-Ref |
| Course reset form defaults. param: stdClass $course the course object return: array |
| h5pactivity_reset_userdata(stdClass $data) X-Ref |
| This function is used by the reset_course_userdata function in moodlelib. This function will remove all H5P attempts in the database and clean up any related data. param: stdClass $data the data submitted from the reset course. return: array of reseting status |
| h5pactivity_reset_gradebook(int $courseid, string $type='') X-Ref |
| Removes all grades from gradebook param: int $courseid Coude ID param: string $type optional type (default '') |
| h5pactivity_page_type_list(string $pagetype, ?stdClass $parentcontext, stdClass $currentcontext) X-Ref |
| Return a list of page types param: string $pagetype current page type param: stdClass|null $parentcontext Block's parent context param: stdClass $currentcontext Current context of block return: array array of page types and it's names |
| h5pactivity_check_updates_since(cm_info $cm, int $from, array $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 |
| h5pactivity_get_file_areas(stdClass $course, stdClass $cm, stdClass $context) X-Ref |
| Returns the lists of all browsable file areas within the given module context. The file area 'intro' for the activity introduction field is added automatically by {@link file_browser::get_file_info_context_module()}. param: stdClass $course course object param: stdClass $cm course module object param: stdClass $context context object return: string[] array of pair file area => human file area name |
| h5pactivity_get_file_info(file_browser $browser, array $areas, stdClass $course,stdClass $cm, context $context, string $filearea, ?int $itemid = null,?string $filepath = null, ?string $filename = null) X-Ref |
| File browsing support for data module. param: file_browser $browser param: array $areas param: stdClass $course param: stdClass $cm param: context $context param: string $filearea param: int|null $itemid param: string|null $filepath param: string|null $filename return: file_info_stored|null file_info_stored instance or null if not found |
| h5pactivity_pluginfile($course, $cm, context $context,string $filearea, array $args, bool $forcedownload, array $options = []) X-Ref |
| Serves the files from the mod_h5pactivity file areas. param: mixed $course course or id of the course param: mixed $cm course module or id of the course module param: context $context param: string $filearea param: array $args param: bool $forcedownload 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 |
| h5pactivity_set_mainfile(stdClass $data) X-Ref |
| Saves draft files as the activity package. param: stdClass $data an object from the form |
| h5pactivity_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 |
| h5pactivity_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 |
