 |
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
|
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
Directories | |
| directory | backup |
| | |
Functions | |
| mod_page_core_calendar_provide_event_action (calendar_event $event, core_calendar\action_factory $factory, $userid=0) | |
| This function receives a calendar event and returns the action associated with it, or null if there is none. | |
| mod_page_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. | |
| page_add_instance ($data, $mform=null) | |
| Add page instance. | |
| page_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. | |
| page_delete_instance ($id) | |
| Delete page instance. | |
| page_dndupload_handle ($uploadinfo) | |
| Handle a file that has been uploaded. | |
| page_dndupload_register () | |
| Register the ability to handle drag and drop file uploads. | |
| page_export_contents ($cm, $baseurl) | |
| Export page resource contents. | |
| page_get_coursemodule_info ($coursemodule) | |
| Given a course_module object, this function returns any "extra" information that may be needed when printing this activity in a course listing. | |
| page_get_file_areas ($course, $cm, $context) | |
| Lists all browsable file areas. | |
| page_get_file_info ($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) | |
| File browsing support for page module content area. | |
| page_get_post_actions () | |
| List the actions that correspond to a post of this module. | |
| page_get_view_actions () | |
| List the actions that correspond to a view of this module. | |
| page_page_type_list ($pagetype, $parentcontext, $currentcontext) | |
| Return a list of page types. | |
| page_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) | |
| Serves the page files. | |
| page_reset_userdata ($data) | |
| This function is used by the reset_course_userdata function in moodlelib. | |
| page_supports ($feature) | |
| List of features supported in Page module. | |
| page_update_instance ($data, $mform) | |
| Update page instance. | |
| page_view ($page, $course, $cm, $context) | |
| Mark the activity completed (if required) and trigger the course_module_viewed event. | |
| mod_page_core_calendar_provide_event_action | ( | calendar_event | $event, |
| core_calendar\action_factory | $factory, | ||
| $userid = 0 ) |
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 |
| core_calendar\local\event\entities\action_interface|null |
| mod_page_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. |
| page_add_instance | ( | $data, | |
| $mform = null ) |
Add page instance.
| stdClass | $data | |
| mod_page_mod_form | $mform |
| int | new page instance id |
| page_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 |
| page_delete_instance | ( | $id | ) |
Delete page instance.
| int | $id |
| bool | true |
| page_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 |
| page_dndupload_register | ( | ) |
Register the ability to handle drag and drop file uploads.
| array | containing details of the files / types the mod can handle |
| page_export_contents | ( | $cm, | |
| $baseurl ) |
Export page resource contents.
| array | of file content |
| page_get_coursemodule_info | ( | $coursemodule | ) |
Given a course_module object, this function returns any "extra" information that may be needed when printing this activity in a course listing.
See course_modinfo::get_array_of_activities()
| stdClass | $coursemodule |
| cached_cm_info | Info to customise main page display |
| page_get_file_areas | ( | $course, | |
| $cm, | |||
| $context ) |
Lists all browsable file areas.
| stdClass | $course | course object |
| stdClass | $cm | course module object |
| stdClass | $context | context object |
| array |
| page_get_file_info | ( | $browser, | |
| $areas, | |||
| $course, | |||
| $cm, | |||
| $context, | |||
| $filearea, | |||
| $itemid, | |||
| $filepath, | |||
| $filename ) |
File browsing support for page module content area.
| file_browser | $browser | file browser instance |
| stdClass | $areas | file areas |
| stdClass | $course | course object |
| stdClass | $cm | course module object |
| stdClass | $context | context object |
| string | $filearea | file area |
| int | $itemid | item ID |
| string | $filepath | file path |
| string | $filename | file name |
| file_info | instance or null if not found |
| page_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 |
| page_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 |
| page_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 |
| page_pluginfile | ( | $course, | |
| $cm, | |||
| $context, | |||
| $filearea, | |||
| $args, | |||
| $forcedownload, | |||
| array | $options = array() ) |
Serves the page files.
| stdClass | $course | course object |
| stdClass | $cm | course module object |
| stdClass | $context | context object |
| string | $filearea | file area |
| array | $args | extra arguments |
| bool | $forcedownload | whether or not force download |
| array | $options | additional options affecting the file serving |
| bool | false if file not found, does not return if found - just send the file |
| page_reset_userdata | ( | $data | ) |
This function is used by the reset_course_userdata function in moodlelib.
| $data | the data submitted from the reset course. |
| array | status array |
| page_supports | ( | $feature | ) |
List of features supported in Page module.
| string | $feature | FEATURE_xx constant for requested feature |
| mixed | True if module supports feature, false if not, null if doesn't know or string for the module purpose. |
| page_update_instance | ( | $data, | |
| $mform ) |
Update page instance.
| object | $data | |
| object | $mform |
| bool | true |
| page_view | ( | $page, | |
| $course, | |||
| $cm, | |||
| $context ) |
Mark the activity completed (if required) and trigger the course_module_viewed event.
| stdClass | $page | page object |
| stdClass | $course | course object |
| stdClass | $cm | course module object |
| stdClass | $context | context object |
1.11.0