external extends external_api
Class external API.
Table of Contents
Methods
- potential_contexts_parameters() : external_function_parameters
- Describes the parameters for update_completion webservice.
- potential_users() : array<string|int, mixed>
- Return the users that match the provided query.
- potential_users_parameters() : mixed
- potential_users_returns() : external_multiple_structure
- get_basic_search_conditions() : mixed
Methods
potential_contexts_parameters()
Describes the parameters for update_completion webservice.
public
static potential_contexts_parameters() : external_function_parameters
Return values
external_function_parameterspotential_users()
Return the users that match the provided query.
public
static potential_users([null|string $query = null ][, bool $searchanywhere = true ][, int $page = 0 ][, int $perpage = 30 ][, int|null $courseid = null ]) : array<string|int, mixed>
Parameters
- $query : null|string = null
- $searchanywhere : bool = true
- $page : int = 0
- $perpage : int = 30
- $courseid : int|null = null
Tags
Return values
array<string|int, mixed> —an array of users
potential_users_parameters()
public
static potential_users_parameters() : mixed
potential_users_returns()
public
static potential_users_returns() : external_multiple_structure
Return values
external_multiple_structureget_basic_search_conditions()
protected
static get_basic_search_conditions(mixed $context, mixed $search, mixed $searchanywhere) : mixed
Parameters
- $context : mixed
- $search : mixed
- $searchanywhere : mixed