MDL-30973 Files API, check and update DocBlock

This commit is contained in:
Dongsheng Cai
2012-02-15 12:48:57 +08:00
parent baa5cd8240
commit d2b7803e5a
47 changed files with 1497 additions and 785 deletions
+27 -19
View File
@@ -217,9 +217,12 @@ function folder_get_participants($folderid) {
/**
* Lists all browsable file areas
* @param object $course
* @param object $cm
* @param object $context
*
* @package mod_folder
* @category files
* @param stdClass $course course object
* @param stdClass $cm course module object
* @param stdClass $context context object
* @return array
*/
function folder_get_file_areas($course, $cm, $context) {
@@ -231,16 +234,19 @@ function folder_get_file_areas($course, $cm, $context) {
/**
* File browsing support for folder module content area.
* @param object $browser
* @param object $areas
* @param object $course
* @param object $cm
* @param object $context
* @param string $filearea
* @param int $itemid
* @param string $filepath
* @param string $filename
* @return object file_info instance or null if not found
*
* @package mod_folder
* @category files
* @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
*/
function folder_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
global $CFG;
@@ -279,12 +285,14 @@ function folder_get_file_info($browser, $areas, $course, $cm, $context, $fileare
/**
* Serves the folder files.
*
* @param object $course
* @param object $cm
* @param object $context
* @param string $filearea
* @param array $args
* @param bool $forcedownload
* @package mod_folder
* @category 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
* @return bool false if file not found, does not return if found - just send the file
*/
function folder_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {