Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Functions | Variables
lib.php File Reference

Mandatory public API of folder module. More...

Functions

 folder_add_instance ($data, $mform)
 Add folder instance. More...
 
 folder_archive_available ($folder, $cm)
 Check if the folder can be zipped and downloaded. More...
 
 folder_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. More...
 
 folder_cm_info_dynamic (cm_info $cm)
 Sets dynamic information about a course module. More...
 
 folder_cm_info_view (cm_info $cm)
 Overwrites the content in the course-module object with the folder files list if folder.display == FOLDER_DISPLAY_INLINE. More...
 
 folder_delete_instance ($id)
 Delete folder instance. More...
 
 folder_dndupload_handle ($uploadinfo)
 Handle a file that has been uploaded. More...
 
 folder_dndupload_register ()
 Register the ability to handle drag and drop file uploads. More...
 
 folder_downloaded ($folder, $course, $cm, $context)
 Mark the activity completed (if required) and trigger the all_files_downloaded event. More...
 
 folder_export_contents ($cm, $baseurl)
 Export folder resource contents. More...
 
 folder_get_coursemodule_info ($cm)
 Given a coursemodule object, this function returns the extra information needed to print this activity in various places. More...
 
 folder_get_directory_size ($directory)
 Recursively measure the size of the files in a directory. More...
 
 folder_get_file_areas ($course, $cm, $context)
 
 folder_get_file_info ($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename)
 
 folder_get_post_actions ()
 List the actions that correspond to a post of this module. More...
 
 folder_get_recent_activity ($context, $timestart, $userid=0)
 Gets recent file uploads in a given folder. More...
 
 folder_get_recent_mod_activity (&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0)
 Returns all uploads since a given time in specified folder. More...
 
 folder_get_view_actions ()
 List the actions that correspond to a view of this module. More...
 
 folder_page_type_list ($pagetype, $parentcontext, $currentcontext)
 Return a list of page types. More...
 
 folder_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array())
 
 folder_print_recent_activity ($course, $viewfullnames, $timestart)
 Given a course and a date, prints a summary of all the new files posted in folder resources since that date. More...
 
 folder_print_recent_mod_activity ($activity, $courseid, $detail, $modnames, $viewfullnames)
 Outputs the folder uploads indicated by $activity. More...
 
 folder_reset_userdata ($data)
 This function is used by the reset_course_userdata function in moodlelib. More...
 
 folder_supports ($feature)
 List of features supported in Folder module. More...
 
 folder_update_instance ($data, $mform)
 Update folder instance. More...
 
 folder_view ($folder, $course, $cm, $context)
 Mark the activity completed (if required) and trigger the course_module_viewed event. More...
 
 mod_folder_core_calendar_provide_event_action (calendar_event $event, core_calendar\action_factory $factory, int $userid=0)
 This function receives a calendar event and returns the action associated with it, or null if there is none. More...
 
 mod_folder_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. More...
 

Variables

const FOLDER_DISPLAY_INLINE 1
 Display folder contents inline in a course.
 
const FOLDER_DISPLAY_PAGE 0
 Display folder contents on a separate page.
 

Detailed Description

Mandatory public API of folder module.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later