Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
mod_imscp_external Class Reference

IMSCP external functions. More...

Inheritance diagram for mod_imscp_external:

Static Public Member Functions

static get_imscps_by_courses ($courseids=array())
 Returns a list of IMSCP packages in a provided list of courses, if no list is provided all IMSCP packages that the user can view will be returned.
 
static get_imscps_by_courses_parameters ()
 Describes the parameters for get_imscps_by_courses.
 
static get_imscps_by_courses_returns ()
 Describes the get_imscps_by_courses return value.
 
static view_imscp ($imscpid)
 Simulate the imscp/view.php web interface page: trigger events, completion, etc...
 
static view_imscp_parameters ()
 Returns description of method parameters.
 
static view_imscp_returns ()
 Returns description of method result value.
 

Detailed Description

IMSCP external functions.

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

Member Function Documentation

◆ get_imscps_by_courses()

static mod_imscp_external::get_imscps_by_courses ( $courseids = array())
static

Returns a list of IMSCP packages in a provided list of courses, if no list is provided all IMSCP packages that the user can view will be returned.

Parameters
array$courseidsthe course ids
Return values
arrayof IMSCP packages details and possible warnings
Since
Moodle 3.0

◆ get_imscps_by_courses_parameters()

static mod_imscp_external::get_imscps_by_courses_parameters ( )
static

Describes the parameters for get_imscps_by_courses.

Return values
external_function_parameters
Since
Moodle 3.0

◆ get_imscps_by_courses_returns()

static mod_imscp_external::get_imscps_by_courses_returns ( )
static

Describes the get_imscps_by_courses return value.

Return values
external_single_structure
Since
Moodle 3.0

◆ view_imscp()

static mod_imscp_external::view_imscp ( $imscpid)
static

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

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

◆ view_imscp_parameters()

static mod_imscp_external::view_imscp_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.0

◆ view_imscp_returns()

static mod_imscp_external::view_imscp_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: