1. class
  2. local_middag
  3. \
  4. external

external

class external extends external_api

Constants

MAX_CONTEXTS_RETURNED

Methods

static external_function_parameters
potential_contexts_parameters()

potential_contexts parameters.

static array
potential_contexts(string|null $query = null)

Return the contexts that match the provided query.

static external_description|external_multiple_structure
potential_contexts_returns()

potential_contexts return.

static external_function_parameters
potential_users_parameters()

potential_users parameters.

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()

potential_users return.

static array
get_basic_search_conditions(context $context, string $search, bool $searchanywhere)

No description

Details

at line 50
static external_function_parameters potential_contexts_parameters()

potential_contexts parameters.

Return Value

external_function_parameters

at line 67
static array potential_contexts(string|null $query = null)

Return the contexts that match the provided query.

Parameters

string|null $query

Return Value

array

an array of contexts

Exceptions

coding_exception
invalid_parameter_exception

at line 93
static external_description|external_multiple_structure potential_contexts_returns()

potential_contexts return.

Return Value

external_description|external_multiple_structure

at line 108
static external_function_parameters potential_users_parameters()

potential_users parameters.

Return Value

external_function_parameters

at line 135
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.

Parameters

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

Return Value

array

an array of users

Exceptions

dml_exception
coding_exception
invalid_parameter_exception
moodle_exception

at line 227
static external_multiple_structure potential_users_returns()

potential_users return.

Return Value

external_multiple_structure

at line 243
static protected array get_basic_search_conditions(context $context, string $search, bool $searchanywhere)

No description

Parameters

context $context
string $search
bool $searchanywhere

Return Value

array

Exceptions

coding_exception