Moodle  2.2.1
http://www.collinsharper.com
core_user_external Class Reference
Inheritance diagram for core_user_external:
Collaboration diagram for core_user_external:

Static Public Member Functions

static create_users_parameters ()
static create_users ($users)
static create_users_returns ()
static delete_users_parameters ()
static delete_users ($userids)
static delete_users_returns ()
static update_users_parameters ()
static update_users ($users)
static update_users_returns ()
static get_users_by_id_parameters ()
static get_users_by_id ($userids)
static get_users_by_id_returns ()
static get_course_user_profiles_parameters ()
static get_course_user_profiles ($userlist)
static get_course_user_profiles_returns ()

Detailed Description

User functions

Definition at line 32 of file externallib.php.


Member Function Documentation

static create_users ( users) [static]

Create one or more users

Parameters:
array$usersAn array of users to create.
Returns:
array An array of arrays

Definition at line 87 of file externallib.php.

Here is the call graph for this function:

static create_users_parameters ( ) [static]

Returns description of method parameters

Returns:
external_function_parameters

Definition at line 38 of file externallib.php.

static create_users_returns ( ) [static]

Returns description of method result value

Returns:
external_description

Definition at line 178 of file externallib.php.

static delete_users ( userids) [static]

Delete users

Parameters:
array$userids
Returns:
null

Definition at line 207 of file externallib.php.

Here is the call graph for this function:

static delete_users_parameters ( ) [static]

Returns description of method parameters

Returns:
external_function_parameters

Definition at line 194 of file externallib.php.

static delete_users_returns ( ) [static]

Returns description of method result value

Returns:
external_description

Definition at line 241 of file externallib.php.

static get_course_user_profiles ( userlist) [static]

Get course participant's details

Parameters:
array$userlistarray of user ids and according course ids
Returns:
array An array of arrays describing course participants

Definition at line 505 of file externallib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Returns description of method parameters

Returns:
external_function_parameters

Definition at line 485 of file externallib.php.

Here is the caller graph for this function:

static get_course_user_profiles_returns ( ) [static]

Returns description of method result value

Returns:
external_description

Definition at line 562 of file externallib.php.

Here is the caller graph for this function:

static get_users_by_id ( userids) [static]

Get user information

  • This function is matching the permissions of /user/profil.php
  • It is also matching some permissions from /user/editadvanced.php for the following fields: auth, confirmed, idnumber, lang, theme, timezone, mailformat
    Parameters:
    array$useridsarray of user ids
    Returns:
    array An array of arrays describing users

Definition at line 368 of file externallib.php.

Here is the call graph for this function:

static get_users_by_id_parameters ( ) [static]

Returns description of method parameters

Returns:
external_function_parameters

Definition at line 352 of file externallib.php.

static get_users_by_id_returns ( ) [static]

Returns description of method result value

Returns:
external_description

Definition at line 416 of file externallib.php.

static update_users ( users) [static]

Update users

Parameters:
array$users
Returns:
null

Definition at line 298 of file externallib.php.

Here is the call graph for this function:

static update_users_parameters ( ) [static]

Returns description of method parameters

Returns:
external_function_parameters

Definition at line 250 of file externallib.php.

static update_users_returns ( ) [static]

Returns description of method result value

Returns:
external_description

Definition at line 344 of file externallib.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations