Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
- Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/mod/page/ -> lib.php (source)
Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]
(no description)
| Copyright: | 2009 Petr Skoda (http://skodak.org) |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 595 lines (21 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 19 functions
page_supports()
page_reset_userdata()
page_get_view_actions()
page_get_post_actions()
page_add_instance()
page_update_instance()
page_delete_instance()
page_get_coursemodule_info()
page_get_file_areas()
page_get_file_info()
page_pluginfile()
page_page_type_list()
page_export_contents()
page_dndupload_register()
page_dndupload_handle()
page_view()
page_check_updates_since()
mod_page_core_calendar_provide_event_action()
mod_page_get_path_from_pluginfile()
page_reset_userdata()
page_get_view_actions()
page_get_post_actions()
page_add_instance()
page_update_instance()
page_delete_instance()
page_get_coursemodule_info()
page_get_file_areas()
page_get_file_info()
page_pluginfile()
page_page_type_list()
page_export_contents()
page_dndupload_register()
page_dndupload_handle()
page_view()
page_check_updates_since()
mod_page_core_calendar_provide_event_action()
mod_page_get_path_from_pluginfile()
Functions that are not part of a class:
| page_supports($feature) X-Ref |
| List of features supported in Page module param: string $feature FEATURE_xx constant for requested feature return: mixed True if module supports feature, false if not, null if doesn't know or string for the module purpose. |
| page_reset_userdata($data) X-Ref |
| This function is used by the reset_course_userdata function in moodlelib. param: $data the data submitted from the reset course. return: array status array |
| page_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 |
| page_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 |
| page_add_instance($data, $mform = null) X-Ref |
| Add page instance. param: stdClass $data param: mod_page_mod_form $mform return: int new page instance id |
| page_update_instance($data, $mform) X-Ref |
| Update page instance. param: object $data param: object $mform return: bool true |
| page_delete_instance($id) X-Ref |
| Delete page instance. param: int $id return: bool true |
| page_get_coursemodule_info($coursemodule) X-Ref |
| Given a course_module object, this function returns any "extra" information that may be needed when printing this activity in a course listing. See {@link course_modinfo::get_array_of_activities()} param: stdClass $coursemodule return: cached_cm_info Info to customise main page display |
| page_get_file_areas($course, $cm, $context) X-Ref |
| Lists all browsable file areas param: stdClass $course course object param: stdClass $cm course module object param: stdClass $context context object return: array |
| page_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) X-Ref |
| File browsing support for page module content area. param: file_browser $browser file browser instance param: stdClass $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 |
| page_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array() X-Ref |
| Serves the page files. 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 |
| page_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 |
| page_export_contents($cm, $baseurl) X-Ref |
| Export page resource contents return: array of file content |
| page_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 |
| page_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 |
| page_view($page, $course, $cm, $context) X-Ref |
| Mark the activity completed (if required) and trigger the course_module_viewed event. param: stdClass $page page object param: stdClass $course course object param: stdClass $cm course module object param: stdClass $context context object |
| page_check_updates_since(cm_info $cm, $from, $filter = array() 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 |
| mod_page_core_calendar_provide_event_action(calendar_event $event,\core_calendar\action_factory $factory, $userid = 0) X-Ref |
| 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. param: calendar_event $event param: \core_calendar\action_factory $factory return: \core_calendar\local\event\entities\action_interface|null |
| mod_page_get_path_from_pluginfile(string $filearea, array $args) X-Ref |
| Given an array with a file path, it returns the itemid and the filepath for the defined filearea. param: string $filearea The filearea. param: array $args The path (the part after the filearea and before the filename). return: array The itemid and the filepath inside the $args path, for the defined filearea. |
