Search moodle.org's
Developer Documentation
Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/mod/imscp/ -> lib.php (source)
Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 401 and 402] [Versions 401 and 403]
Mandatory public API of imscp module
| Copyright: | 2009 Petr Skoda {@link http://skodak.org} |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 508 lines (18 kb) |
| Included or required: | 0 times |
| Referenced: | 2 times |
| Includes or requires: | 0 files |
Defines 15 functions
imscp_supports()
imscp_reset_userdata()
imscp_get_view_actions()
imscp_get_post_actions()
imscp_add_instance()
imscp_update_instance()
imscp_delete_instance()
imscp_get_file_areas()
imscp_get_file_info()
imscp_pluginfile()
imscp_page_type_list()
imscp_export_contents()
imscp_view()
imscp_check_updates_since()
mod_imscp_core_calendar_provide_event_action()
imscp_reset_userdata()
imscp_get_view_actions()
imscp_get_post_actions()
imscp_add_instance()
imscp_update_instance()
imscp_delete_instance()
imscp_get_file_areas()
imscp_get_file_info()
imscp_pluginfile()
imscp_page_type_list()
imscp_export_contents()
imscp_view()
imscp_check_updates_since()
mod_imscp_core_calendar_provide_event_action()
Functions that are not part of a class:
| imscp_supports($feature) X-Ref |
| List of features supported in IMS CP 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. |
| imscp_reset_userdata($data) X-Ref |
| This function is used by the reset_course_userdata function in moodlelib. param: stdClass $data the data submitted from the reset course. return: array status array |
| imscp_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 |
| imscp_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 |
| imscp_add_instance($data, $mform) X-Ref |
| Add imscp instance. param: object $data param: object $mform return: int new imscp instance id |
| imscp_update_instance($data, $mform) X-Ref |
| Update imscp instance. param: object $data param: object $mform return: bool true |
| imscp_delete_instance($id) X-Ref |
| Delete imscp instance. param: int $id return: bool true |
| imscp_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 |
| imscp_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) X-Ref |
| File browsing support for imscp module ontent area. param: stdClass $browser file browser 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 |
| imscp_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array() X-Ref |
| Serves the imscp 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 - justsend the file |
| imscp_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 return: array $modulepagetype list |
| imscp_export_contents($cm, $baseurl) X-Ref |
| Export imscp resource contents param: stdClass $cm Course module object param: string $baseurl Base URL for file downloads return: array of file content |
| imscp_view($imscp, $course, $cm, $context) X-Ref |
| Mark the activity completed (if required) and trigger the course_module_viewed event. param: stdClass $imscp imscp object param: stdClass $course course object param: stdClass $cm course module object param: stdClass $context context object |
| imscp_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_imscp_core_calendar_provide_event_action(calendar_event $event,\core_calendar\action_factory $factory,int $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 param: int $userid User id to use for all capability checks, etc. Set to 0 for current user (default). return: \core_calendar\local\event\entities\action_interface|null |
