core_rating_external Class Reference

Rating external functions. More...

Inheritance diagram for core_rating_external:

Static Public Member Functions
static	add_rating ($contextlevel, $instanceid, $component, $ratingarea, $itemid, $scaleid, $rating, $rateduserid, $aggregation=RATING_AGGREGATE_NONE)
	Adds a rating to an item.
static	add_rating_parameters ()
	Returns description of add_rating parameters.
static	add_rating_returns ()
	Returns description of add_rating result values.
static	get_item_ratings ($contextlevel, $instanceid, $component, $ratingarea, $itemid, $scaleid, $sort)
	Retrieve a list of ratings for a given item (forum post etc)
static	get_item_ratings_parameters ()
	Returns description of get_item_ratings parameters.
static	get_item_ratings_returns ()
	Returns description of get_item_ratings result values.

Detailed Description

Rating external functions.

Copyright

2015 Costantino Cito ccito.nosp@m.@cva.nosp@m.consu.nosp@m.ltin.nosp@m.g.com

License

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

Since

Moodle 2.9

Member Function Documentation

add_rating()

static core_rating_external::add_rating ( $contextlevel, $instanceid, $component, $ratingarea, $itemid, $scaleid, $rating, $rateduserid, $aggregation = RATING_AGGREGATE_NONE )

static

Adds a rating to an item.

Parameters

string	$contextlevel	course, module, user...
int	$instanceid	the instance if for the context element
string	$component	the name of the component
string	$ratingarea	rating area
int	$itemid	the item id
int	$scaleid	the scale id
int	$rating	the user rating
int	$rateduserid	the rated user id
int	$aggregation	the aggregation method

Return values

array

result and possible warnings

Exceptions

moodle_exception

Since

Moodle 3.2

add_rating_parameters()

static core_rating_external::add_rating_parameters ( )

static

Returns description of add_rating parameters.

Return values

external_function_parameters

Since

Moodle 3.2

add_rating_returns()

static core_rating_external::add_rating_returns ( )

static

Returns description of add_rating result values.

Return values

external_single_structure

Since

Moodle 3.2

get_item_ratings()

static core_rating_external::get_item_ratings ( $contextlevel, $instanceid, $component, $ratingarea, $itemid, $scaleid, $sort )

static

Retrieve a list of ratings for a given item (forum post etc)

Parameters

string	$contextlevel	course, module, user...
int	$instanceid	the instance if for the context element
string	$component	the name of the component
string	$ratingarea	rating area
int	$itemid	the item id
int	$scaleid	the scale id
string	$sort	sql order (firstname, rating or timemodified)

Return values

array

Result and possible warnings

Exceptions

moodle_exception

Since

Moodle 2.9

get_item_ratings_parameters()

static core_rating_external::get_item_ratings_parameters ( )

static

Returns description of get_item_ratings parameters.

Return values

external_function_parameters

Since

Moodle 2.9

get_item_ratings_returns()

static core_rating_external::get_item_ratings_returns ( )

static

Returns description of get_item_ratings result values.

Return values

external_single_structure

Since

Moodle 2.9

---

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

• rating/classes/external.php