Moodle  2.2.1
http://www.collinsharper.com
moodle_user_external Class Reference
Inheritance diagram for moodle_user_external:
Collaboration diagram for moodle_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_participants_by_id_parameters ()
static get_course_participants_by_id ($userlist)
static get_course_participants_by_id_returns ()
static get_users_by_courseid_parameters ()
static get_users_by_courseid ($courseid, $options)
static get_users_by_courseid_returns ()

Detailed Description

Deprecated user functions

Deprecated:
since Moodle 2.2 please use core_user_external instead

Definition at line 643 of file externallib.php.


Member Function Documentation

static create_users ( users) [static]

Create one or more users

Deprecated:
since Moodle 2.2 please use core_user_external::create_users instead
Parameters:
array$usersAn array of users to create.
Returns:
array An array of arrays

Definition at line 660 of file externallib.php.

static create_users_parameters ( ) [static]

Returns description of method parameters

Deprecated:
since Moodle 2.2 please use core_user_external::create_users_parameters instead
Returns:
external_function_parameters

Definition at line 650 of file externallib.php.

static create_users_returns ( ) [static]

Returns description of method result value

Deprecated:
since Moodle 2.2 please use core_user_external::create_users_returns instead
Returns:
external_description

Definition at line 669 of file externallib.php.

static delete_users ( userids) [static]

Delete users

Deprecated:
since Moodle 2.2 please use core_user_external::delete_users instead
Parameters:
array$userids
Returns:
null

Definition at line 689 of file externallib.php.

static delete_users_parameters ( ) [static]

Returns description of method parameters

Deprecated:
since Moodle 2.2 please use core_user_external::delete_users_parameters instead
Returns:
external_function_parameters

Definition at line 679 of file externallib.php.

static delete_users_returns ( ) [static]

Returns description of method result value

Deprecated:
since Moodle 2.2 please use core_user_external::delete_users_returns instead
Returns:
external_description

Definition at line 698 of file externallib.php.

static get_course_participants_by_id ( userlist) [static]

Get course participant's details

Deprecated:
since Moodle 2.2 please use core_user_external::get_course_user_profiles instead
Parameters:
array$userlistarray of user ids and according course ids
Returns:
array An array of arrays describing course participants

Definition at line 776 of file externallib.php.

Here is the call graph for this function:

Returns description of method parameters

Deprecated:
since Moodle 2.2 please use core_user_external::get_course_user_profiles_parameters instead
Returns:
external_function_parameters

Definition at line 766 of file externallib.php.

Here is the call graph for this function:

Returns description of method result value

Deprecated:
since Moodle 2.2 please use core_user_external::get_course_user_profiles_returns instead
Returns:
external_description

Definition at line 785 of file externallib.php.

Here is the call graph for this function:

static get_users_by_courseid ( courseid,
options 
) [static]

Get course participants details

Deprecated:
since Moodle 2.2 please use core_enrol_external::get_enrolled_users instead
Parameters:
int$courseidcourse id
array$optionsoptions { 'name' => option name 'value' => option value }
Returns:
array An array of users

Definition at line 810 of file externallib.php.

Here is the call graph for this function:

static get_users_by_courseid_parameters ( ) [static]

Returns description of method parameters

Deprecated:
since Moodle 2.2 please use core_enrol_external::get_enrolled_users_parameters instead
Returns:
external_function_parameters

Definition at line 794 of file externallib.php.

Here is the call graph for this function:

static get_users_by_courseid_returns ( ) [static]

Returns description of method result value

Deprecated:
since Moodle 2.2 please use core_enrol_external::get_enrolled_users_returns instead
Returns:
external_description

Definition at line 820 of file externallib.php.

Here is the call 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
    Deprecated:
    since Moodle 2.2 please use core_user_external::get_users_by_id instead
    Parameters:
    array$useridsarray of user ids
    Returns:
    array An array of arrays describing users

Definition at line 749 of file externallib.php.

static get_users_by_id_parameters ( ) [static]

Returns description of method parameters

Deprecated:
since Moodle 2.2 please use core_user_external::get_users_by_id_parameters instead
Returns:
external_function_parameters

Definition at line 736 of file externallib.php.

static get_users_by_id_returns ( ) [static]

Returns description of method result value

Deprecated:
since Moodle 2.2 please use core_user_external::get_users_by_id_returns instead
Returns:
external_description

Definition at line 758 of file externallib.php.

static update_users ( users) [static]

Update users

Deprecated:
since Moodle 2.2 please use core_user_external::update_users instead
Parameters:
array$users
Returns:
null

Definition at line 718 of file externallib.php.

static update_users_parameters ( ) [static]

Returns description of method parameters

Deprecated:
since Moodle 2.2 please use core_user_external::update_users_parameters instead
Returns:
external_function_parameters

Definition at line 708 of file externallib.php.

static update_users_returns ( ) [static]

Returns description of method result value

Deprecated:
since Moodle 2.2 please use core_user_external::update_users_returns instead
Returns:
external_description

Definition at line 727 of file externallib.php.


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