mod_url_external Class Reference

URL external functions. More...

Inheritance diagram for mod_url_external:

Static Public Member Functions
static	get_urls_by_courses ($courseids=array())
	Returns a list of urls in a provided list of courses.
static	get_urls_by_courses_parameters ()
	Describes the parameters for get_urls_by_courses.
static	get_urls_by_courses_returns ()
	Describes the get_urls_by_courses return value.
static	view_url ($urlid)
	Trigger the course module viewed event and update the module completion status.
static	view_url_parameters ()
	Returns description of method parameters.
static	view_url_returns ()
	Returns description of method result value.

Detailed Description

URL 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_urls_by_courses()

static mod_url_external::get_urls_by_courses ( $courseids = array() )

static

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

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

Parameters

array

$courseids

course ids

Return values

array

of warnings and urls

Since

Moodle 3.3

get_urls_by_courses_parameters()

static mod_url_external::get_urls_by_courses_parameters ( )

static

Describes the parameters for get_urls_by_courses.

Return values

external_function_parameters

Since

Moodle 3.3

get_urls_by_courses_returns()

static mod_url_external::get_urls_by_courses_returns ( )

static

Describes the get_urls_by_courses return value.

Return values

external_single_structure

Since

Moodle 3.3

view_url()

static mod_url_external::view_url ( $urlid )

static

Trigger the course module viewed event and update the module completion status.

Parameters

int

$urlid

the url instance id

Return values

array

of warnings and status result

Since

Moodle 3.0

Exceptions

moodle_exception

view_url_parameters()

static mod_url_external::view_url_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.0

view_url_returns()

static mod_url_external::view_url_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/url/classes/external.php