| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
Mandatory public API of folder module
| Copyright: | 2009 Petr Skoda {@link http://skodak.org} |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 558 lines (18 kb) |
| Included or required: | 0 times |
| Referenced: | 1 time |
| Includes or requires: | 0 files |
| folder_supports($feature) X-Ref |
| List of features supported in Folder 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 |
| folder_get_extra_capabilities() X-Ref |
| Returns all other caps used in module return: array |
| folder_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 |
| folder_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 |
| folder_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 |
| folder_add_instance($data, $mform) X-Ref |
| Add folder instance. param: object $data param: object $mform return: int new folder instance id |
| folder_update_instance($data, $mform) X-Ref |
| Update folder instance. param: object $data param: object $mform return: bool true |
| folder_delete_instance($id) X-Ref |
| Delete folder instance. param: int $id return: bool true |
| folder_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 |
| folder_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) X-Ref |
| File browsing support for folder module content area. param: file_browser $browser file browser instance param: array $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 |
| folder_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array() X-Ref |
| Serves the folder files. param: stdClass $course course object param: stdClass $cm course module 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 |
| folder_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 |
| folder_export_contents($cm, $baseurl) X-Ref |
| Export folder resource contents return: array of file content |
| folder_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 |
| folder_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 |
| folder_get_coursemodule_info($cm) X-Ref |
| Given a coursemodule object, this function returns the extra information needed to print this activity in various places. If folder needs to be displayed inline we store additional information in customdata, so functions {@link folder_cm_info_dynamic()} and {@link folder_cm_info_view()} do not need to do DB queries param: cm_info $cm return: cached_cm_info info |
| folder_cm_info_dynamic(cm_info $cm) X-Ref |
| Sets dynamic information about a course module This function is called from cm_info when displaying the module mod_folder can be displayed inline on course page and therefore have no course link param: cm_info $cm |
| folder_cm_info_view(cm_info $cm) X-Ref |
| Overwrites the content in the course-module object with the folder files list if folder.display == FOLDER_DISPLAY_INLINE param: cm_info $cm |
| folder_view($folder, $course, $cm, $context) X-Ref |
| Mark the activity completed (if required) and trigger the course_module_viewed event. param: stdClass $folder folder object param: stdClass $course course object param: stdClass $cm course module object param: stdClass $context context object |
| folder_archive_available($folder, $cm) X-Ref |
| Check if the folder can be zipped and downloaded. param: stdClass $folder param: context_module $cm return: bool True if the folder can be zipped and downloaded. |
| folder_get_directory_size($directory) X-Ref |
| Recursively measure the size of the files in a directory. param: array $directory return: int size of directory contents in bytes |
| folder_downloaded($folder, $course, $cm, $context) X-Ref |
| Mark the activity completed (if required) and trigger the all_files_downloaded event. param: stdClass $folder folder object param: stdClass $course course object param: stdClass $cm course module object param: stdClass $context context object |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |