class external extends external_api

Class external API.

Methods

static external_function_parameters
potential_contexts_parameters()

Describes the parameters for update_completion webservice.

static 
potential_users_parameters()

No description

static array
potential_users(string|null $query = null, bool $searchanywhere = true, int $page = 0, int $perpage = 30, int|null $courseid = null)

Return the users that match the provided query.

static external_multiple_structure
potential_users_returns()

No description

static 
get_basic_search_conditions($context, $search, $searchanywhere)

No description

Details

at line 41
static external_function_parameters potential_contexts_parameters()

Describes the parameters for update_completion webservice.

Return Value

external_function_parameters

at line 48
static potential_users_parameters()

No description

at line 69
static array potential_users(string|null $query = null, bool $searchanywhere = true, int $page = 0, int $perpage = 30, int|null $courseid = null)

Since: Moodle 3.8

Return the users that match the provided query.

Parameters

string|null $query
bool $searchanywhere
int $page
int $perpage
int|null $courseid

Return Value

array

an array of users

at line 147
static external_multiple_structure potential_users_returns()

No description

Return Value

external_multiple_structure

at line 156
static protected get_basic_search_conditions($context, $search, $searchanywhere)

No description

Parameters

$context
$search
$searchanywhere