core_badges_external Class Reference

Badges external functions. More...

Inheritance diagram for core_badges_external:

Static Public Member Functions
static	get_user_badges ($userid=0, $courseid=0, $page=0, $perpage=0, $search='', $onlypublic=false)
	Returns the list of badges awarded to a user.
static	get_user_badges_parameters ()
	Describes the parameters for get_user_badges.
static	get_user_badges_returns ()
	Describes the get_user_badges return value.

Detailed Description

Badges external functions.

Copyright

2016 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.1

Member Function Documentation

get_user_badges()

static core_badges_external::get_user_badges ( $userid = 0, $courseid = 0, $page = 0, $perpage = 0, $search = '', $onlypublic = false )

static

Returns the list of badges awarded to a user.

Parameters

int	$userid	user id
int	$courseid	course id
int	$page	page of records to return
int	$perpage	number of records to return per page
string	$search	a simple string to search for
bool	$onlypublic	whether to return only public badges

Return values

array

array containing warnings and the awarded badges

Since

Moodle 3.1

Exceptions

moodle_exception

get_user_badges_parameters()

static core_badges_external::get_user_badges_parameters ( )

static

Describes the parameters for get_user_badges.

Return values

external_function_parameters

Since

Moodle 3.1

get_user_badges_returns()

static core_badges_external::get_user_badges_returns ( )

static

Describes the get_user_badges return value.

Return values

external_single_structure

Since

Moodle 3.1

---

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

• badges/classes/external.php