Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
mod_folder_external Class Reference
Inheritance diagram for mod_folder_external:

Static Public Member Functions

static get_folders_by_courses ($courseids=array())
 Returns a list of folders in a provided list of courses.
 
static get_folders_by_courses_parameters ()
 Describes the parameters for get_folders_by_courses.
 
static get_folders_by_courses_returns ()
 Describes the get_folders_by_courses return value.
 
static view_folder ($folderid)
 Simulate the folder/view.php web interface page: trigger events, completion, etc...
 
static view_folder_parameters ()
 Returns description of method parameters.
 
static view_folder_returns ()
 Returns description of method result value.
 

Detailed Description

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

Member Function Documentation

◆ get_folders_by_courses()

static mod_folder_external::get_folders_by_courses ( $courseids = array())
static

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.

Parameters
array$courseidscourse ids
Return values
arrayof warnings and folders
Since
Moodle 3.3

◆ get_folders_by_courses_parameters()

static mod_folder_external::get_folders_by_courses_parameters ( )
static

Describes the parameters for get_folders_by_courses.

Return values
external_function_parameters
Since
Moodle 3.3

◆ get_folders_by_courses_returns()

static mod_folder_external::get_folders_by_courses_returns ( )
static

Describes the get_folders_by_courses return value.

Return values
external_single_structure
Since
Moodle 3.3

◆ view_folder()

static mod_folder_external::view_folder ( $folderid)
static

Simulate the folder/view.php web interface page: trigger events, completion, etc...

Parameters
int$folderidthe folder instance id
Return values
arrayof warnings and status result
Since
Moodle 3.0
Exceptions
moodle_exception

◆ view_folder_parameters()

static mod_folder_external::view_folder_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.0

◆ view_folder_returns()

static mod_folder_external::view_folder_returns ( )
static

Returns description of method result value.

Return values
core_external\external_description
Since
Moodle 3.0

The documentation for this class was generated from the following file: