core_cohort_external Class Reference

Inheritance diagram for core_cohort_external:

Static Public Member Functions
static	add_cohort_members ($members)
	Add cohort members. More...
static	add_cohort_members_parameters ()
	Returns description of method parameters. More...
static	add_cohort_members_returns ()
	Returns description of method result value. More...
static	call_external_function ($function, $args, $ajaxonly=false)
	Call an external function validating all params/returns correctly. More...
static	clean_returnvalue (external_description $description, $response)
	Clean response If a response attribute is unknown from the description, we just ignore the attribute. More...
static	create_cohorts ($cohorts)
	Create one or more cohorts. More...
static	create_cohorts_parameters ()
	Returns description of method parameters. More...
static	create_cohorts_returns ()
	Returns description of method result value. More...
static	delete_cohort_members ($members)
	Delete cohort members. More...
static	delete_cohort_members_parameters ()
	Returns description of method parameters. More...
static	delete_cohort_members_returns ()
	Returns description of method result value. More...
static	delete_cohorts ($cohortids)
	Delete cohorts. More...
static	delete_cohorts_parameters ()
	Returns description of method parameters. More...
static	delete_cohorts_returns ()
	Returns description of method result value. More...
static	external_function_info ($function, $strictness=MUST_EXIST)
	Returns detailed function information. More...
static	get_cohort_members ($cohortids)
	Return all members for a cohort. More...
static	get_cohort_members_parameters ()
	Returns description of method parameters. More...
static	get_cohort_members_returns ()
	Returns description of method result value. More...
static	get_cohorts ($cohortids=array())
	Get cohorts definition specified by ids. More...
static	get_cohorts_parameters ()
	Returns description of method parameters. More...
static	get_cohorts_returns ()
	Returns description of method result value. More...
static	search_cohorts ($query, $context, $includes='parents', $limitfrom=0, $limitnum=25)
	Search cohorts. More...
static	search_cohorts_parameters ()
	Returns the description of external function parameters. More...
static	search_cohorts_returns ()
	Returns description of external function result value. More...
static	set_context_restriction ($context)
	Set context restriction for all following subsequent function calls. More...
static	set_timeout ($seconds=360)
	This method has to be called before every operation that takes a longer time to finish! More...
static	update_cohorts ($cohorts)
	Update cohorts. More...
static	update_cohorts_parameters ()
	Returns description of method parameters. More...
static	update_cohorts_returns ()
	Returns description of method result value. More...
static	validate_context ($context)
	Makes sure user may execute functions in this context. More...
static	validate_parameters (external_description $description, $params)
	Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown. More...

Static Protected Member Functions
static	get_context_from_params ($param)
	Get context from passed parameters. More...
static	get_context_parameters ()
	Returns a prepared structure to use a context parameters. More...

Member Function Documentation

add_cohort_members()

static core_cohort_external::add_cohort_members (   $members )

static

Add cohort members.

Parameters

array

$members

of arrays with keys userid, cohortid

Since

Moodle 2.5

add_cohort_members_parameters()

static core_cohort_external::add_cohort_members_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.5

add_cohort_members_returns()

static core_cohort_external::add_cohort_members_returns ( )

static

Returns description of method result value.

Return values

null

Since

Moodle 2.5

call_external_function()

static external_api::call_external_function (   $function,   $args,   $ajaxonly = false  )

staticinherited

Call an external function validating all params/returns correctly.

Note that an external function may modify the state of the current page, so this wrapper saves and restores tha PAGE and COURSE global variables before/after calling the external function.

Parameters

string	$function	A webservice function name.
array	$args	Params array (named params)
boolean	$ajaxonly	If true, an extra check will be peformed to see if ajax is required.

Return values

array

containing keys for error (bool), exception and data.

clean_returnvalue()

static external_api::clean_returnvalue ( external_description  $description,   $response  )

staticinherited

Clean response If a response attribute is unknown from the description, we just ignore the attribute.

If a response attribute is incorrect, invalid_response_exception is thrown. Note: this function is similar to validate parameters, however it is distinct because parameters validation must be distinct from cleaning return values.

Parameters

external_description	$description	description of the return values
mixed	$response	the actual response

Return values

mixed

response with added defaults for optional items, invalid_response_exception thrown if any problem found

Author

2010 Jerome Mouneyrac

Since

Moodle 2.0

create_cohorts()

static core_cohort_external::create_cohorts (   $cohorts )

static

Create one or more cohorts.

Parameters

array

$cohorts

An array of cohorts to create.

Return values

array

An array of arrays

Since

Moodle 2.5

create_cohorts_parameters()

static core_cohort_external::create_cohorts_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.5

create_cohorts_returns()

static core_cohort_external::create_cohorts_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 2.5

delete_cohort_members()

static core_cohort_external::delete_cohort_members (   $members )

static

Delete cohort members.

Parameters

array

$members

of arrays with keys userid, cohortid

Since

Moodle 2.5

delete_cohort_members_parameters()

static core_cohort_external::delete_cohort_members_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.5

delete_cohort_members_returns()

static core_cohort_external::delete_cohort_members_returns ( )

static

Returns description of method result value.

Return values

null

Since

Moodle 2.5

delete_cohorts()

static core_cohort_external::delete_cohorts (   $cohortids )

static

Delete cohorts.

Parameters

array

$cohortids

Return values

null

Since

Moodle 2.5

delete_cohorts_parameters()

static core_cohort_external::delete_cohorts_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.5

delete_cohorts_returns()

static core_cohort_external::delete_cohorts_returns ( )

static

Returns description of method result value.

Return values

null

Since

Moodle 2.5

external_function_info()

static external_api::external_function_info (   $function,   $strictness = MUST_EXIST  )

staticinherited

Returns detailed function information.

Parameters

string | object	$function	name of external function or record from external_function
int	$strictness	IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; MUST_EXIST means throw exception if no record or multiple records found

Return values

stdClass

description or false if not found or exception thrown

Since

Moodle 2.0

get_cohort_members()

static core_cohort_external::get_cohort_members (   $cohortids )

static

Return all members for a cohort.

Parameters

array

$cohortids

array of cohort ids

Return values

array

with cohort id keys containing arrays of user ids

Since

Moodle 2.5

get_cohort_members_parameters()

static core_cohort_external::get_cohort_members_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.5

get_cohort_members_returns()

static core_cohort_external::get_cohort_members_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 2.5

get_cohorts()

static core_cohort_external::get_cohorts (   $cohortids = array() )

static

Get cohorts definition specified by ids.

Parameters

array

$cohortids

array of cohort ids

Return values

array

of cohort objects (id, courseid, name)

Since

Moodle 2.5

get_cohorts_parameters()

static core_cohort_external::get_cohorts_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.5

get_cohorts_returns()

static core_cohort_external::get_cohorts_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 2.5

get_context_from_params()

static external_api::get_context_from_params (   $param )

staticprotectedinherited

Get context from passed parameters.

The passed array must either contain a contextid or a combination of context level and instance id to fetch the context. For example, the context level can be "course" and instanceid can be courseid.

See context_helper::get_all_levels() for a list of valid context levels.

Parameters

array

$param

Since

Moodle 2.6

Exceptions

invalid_parameter_exception

Return values

context

get_context_parameters()

static external_api::get_context_parameters ( )

staticprotectedinherited

Returns a prepared structure to use a context parameters.

Return values

external_single_structure

Reimplemented in tool_lp\external, and core_competency\external.

search_cohorts()

static core_cohort_external::search_cohorts (   $query,   $context,   $includes = 'parents',   $limitfrom = 0,   $limitnum = 25  )

static

Search cohorts.

Parameters

string	$query
array	$context
string	$includes
int	$limitfrom
int	$limitnum

Return values

array

search_cohorts_parameters()

static core_cohort_external::search_cohorts_parameters ( )

static

Returns the description of external function parameters.

Return values

external_function_parameters

search_cohorts_returns()

static core_cohort_external::search_cohorts_returns ( )

static

Returns description of external function result value.

Return values

external_description

set_context_restriction()

static external_api::set_context_restriction (   $context )

staticinherited

Set context restriction for all following subsequent function calls.

Parameters

stdClass

$context

the context restriction

Since

Moodle 2.0

set_timeout()

static external_api::set_timeout (   $seconds = 360 )

staticinherited

This method has to be called before every operation that takes a longer time to finish!

Parameters

int

$seconds

max expected time the next operation needs

Since

Moodle 2.0

update_cohorts()

static core_cohort_external::update_cohorts (   $cohorts )

static

Update cohorts.

Parameters

array

$cohorts

Return values

null

Since

Moodle 2.5

update_cohorts_parameters()

static core_cohort_external::update_cohorts_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.5

update_cohorts_returns()

static core_cohort_external::update_cohorts_returns ( )

static

Returns description of method result value.

Return values

null

Since

Moodle 2.5

validate_context()

static external_api::validate_context (   $context )

staticinherited

Makes sure user may execute functions in this context.

Parameters

stdClass

$context

Since

Moodle 2.0

validate_parameters()

static external_api::validate_parameters ( external_description  $description,   $params  )

staticinherited

Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown.

This is a simple recursive method which is intended to be called from each implementation method of external API.

Parameters

external_description	$description	description of parameters
mixed	$params	the actual parameters

Return values

mixed

params with added defaults for optional items, invalid_parameters_exception thrown if any problem found

Since

Moodle 2.0

---

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

• cohort/externallib.php