mod_resource_external Class Reference

Resource external functions. More...

Inheritance diagram for mod_resource_external:

Static Public Member Functions
static	get_resources_by_courses ($courseids=array())
	Returns a list of files in a provided list of courses.
static	get_resources_by_courses_parameters ()
	Describes the parameters for get_resources_by_courses.
static	get_resources_by_courses_returns ()
	Describes the get_resources_by_courses return value.
static	view_resource ($resourceid)
	Simulate the resource/view.php web interface page: trigger events, completion, etc...
static	view_resource_parameters ()
	Returns description of method parameters.
static	view_resource_returns ()
	Returns description of method result value.

Detailed Description

Resource external functions.

Copyright

2015 Juan Leyva juan@.nosp@m.mood.nosp@m.le.co.nosp@m.m

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Since

Moodle 3.0

Member Function Documentation

get_resources_by_courses()

static mod_resource_external::get_resources_by_courses ( $courseids = array() )

static

Returns a list of files in a provided list of courses.

If no list is provided all files that the user can view will be returned.

Parameters

array

$courseids

course ids

Return values

array

of warnings and files

Since

Moodle 3.3

get_resources_by_courses_parameters()

static mod_resource_external::get_resources_by_courses_parameters ( )

static

Describes the parameters for get_resources_by_courses.

Return values

external_function_parameters

Since

Moodle 3.3

get_resources_by_courses_returns()

static mod_resource_external::get_resources_by_courses_returns ( )

static

Describes the get_resources_by_courses return value.

Return values

external_single_structure

Since

Moodle 3.3

view_resource()

static mod_resource_external::view_resource ( $resourceid )

static

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

Parameters

int

$resourceid

the resource instance id

Return values

array

of warnings and status result

Since

Moodle 3.0

Exceptions

moodle_exception

view_resource_parameters()

static mod_resource_external::view_resource_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.0

view_resource_returns()

static mod_resource_external::view_resource_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:

• mod/resource/classes/external.php