core_user_external Class Reference

User external functions. More...

Inheritance diagram for core_user_external:

Static Public Member Functions
static	create_users ($users)
	Create one or more users.
static	create_users_parameters ()
	Returns description of method parameters.
static	create_users_returns ()
	Returns description of method result value.
static	delete_users ($userids)
	Delete users.
static	delete_users_parameters ()
	Returns description of method parameters.
static	delete_users_returns ()
	Returns description of method result value.
static	get_users_by_field ($field, $values)
	Get user information for a unique field.
static	get_users_by_field_parameters ()
	Returns description of method parameters.
static	update_user_preferences ($userid=0, $emailstop=null, $preferences=array())
	Update the user's preferences.
static	update_user_preferences_parameters ()
	Returns description of method parameters.
static	update_user_preferences_returns ()
	Returns description of method result value.
static	update_users ($users)
	Update users.
static	update_users_parameters ()
	Returns description of method parameters.
static	update_users_returns ()
	Returns description of method result value.

Detailed Description

User external functions.

Copyright

2011 Jerome Mouneyrac

License

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

Since

Moodle 2.2

Member Function Documentation

create_users()

static core_user_external::create_users ( $users )

static

Create one or more users.

Exceptions

invalid_parameter_exception

Parameters

array

$users

An array of users to create.

Return values

array

An array of arrays

Since

Moodle 2.2

create_users_parameters()

static core_user_external::create_users_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.2

create_users_returns()

static core_user_external::create_users_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 2.2

delete_users()

static core_user_external::delete_users ( $userids )

static

Delete users.

Exceptions

moodle_exception

Parameters

array

$userids

Return values

null

Since

Moodle 2.2

delete_users_parameters()

static core_user_external::delete_users_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.2

delete_users_returns()

static core_user_external::delete_users_returns ( )

static

Returns description of method result value.

Return values

null

Since

Moodle 2.2

get_users_by_field()

static core_user_external::get_users_by_field ( $field, $values )

static

Get user information for a unique field.

Exceptions

coding_exception
invalid_parameter_exception

Parameters

string	$field
array	$values

Return values

array

An array of arrays containg user profiles.

Since

Moodle 2.4

get_users_by_field_parameters()

static core_user_external::get_users_by_field_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.4

update_user_preferences()

static core_user_external::update_user_preferences ( $userid = 0, $emailstop = null, $preferences = array() )

static

Update the user's preferences.

Parameters

int	$userid
bool | null	$emailstop
array	$preferences

Return values

null

Since

Moodle 3.2

update_user_preferences_parameters()

static core_user_external::update_user_preferences_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 3.2

update_user_preferences_returns()

static core_user_external::update_user_preferences_returns ( )

static

Returns description of method result value.

Return values

null

Since

Moodle 3.2

update_users()

static core_user_external::update_users ( $users )

static

Update users.

Parameters

array

$users

Return values

null

Since

Moodle 2.2

update_users_parameters()

static core_user_external::update_users_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since

Moodle 2.2

update_users_returns()

static core_user_external::update_users_returns ( )

static

Returns description of method result value.

Return values

external_description

Since

Moodle 2.2

---

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

• user/externallib.php