Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/mod/folder/classes/ -> external.php (source)

[Source view]

Differences Between: [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403] [Versions 39 and 310]

folder external API

Copyright: 2015 Juan Leyva <juan@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 212 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

mod_folder_external:: (6 methods):
  view_folder_parameters()
  view_folder()
  view_folder_returns()
  get_folders_by_courses_parameters()
  get_folders_by_courses()
  get_folders_by_courses_returns()


Class: mod_folder_external  - X-Ref

folder external functions

view_folder_parameters()   X-Ref
Returns description of method parameters

return: external_function_parameters

view_folder($folderid)   X-Ref
Simulate the folder/view.php web interface page: trigger events, completion, etc...

param: int $folderid the folder instance id
return: array of warnings and status result

view_folder_returns()   X-Ref
Returns description of method result value

return: external_description

get_folders_by_courses_parameters()   X-Ref
Describes the parameters for get_folders_by_courses.

return: external_function_parameters

get_folders_by_courses($courseids = array()   X-Ref
Returns a list of folders in a provided list of courses.
If no list is provided all folders that the user can view will be returned.

param: array $courseids course ids
return: array of warnings and folders

get_folders_by_courses_returns()   X-Ref
Describes the get_folders_by_courses return value.

return: external_single_structure