external extends external_api
Table of Contents
Constants
- MAX_CONTEXTS_RETURNED = 100
Methods
- potential_contexts() : array<string|int, mixed>
- Return the contexts that match the provided query.
- potential_contexts_parameters() : external_function_parameters
- potential_contexts parameters.
- potential_contexts_returns() : external_description|external_multiple_structure
- potential_contexts return.
- potential_users() : array<string|int, mixed>
- Return the users that match the provided query.
- potential_users_parameters() : external_function_parameters
- potential_users parameters.
- potential_users_returns() : external_multiple_structure
- potential_users return.
- get_basic_search_conditions() : array<string|int, mixed>
Constants
MAX_CONTEXTS_RETURNED
public
mixed
MAX_CONTEXTS_RETURNED
= 100
Methods
potential_contexts()
Return the contexts that match the provided query.
public
static potential_contexts([null|string $query = null ]) : array<string|int, mixed>
Parameters
- $query : null|string = null
Tags
Return values
array<string|int, mixed> —an array of contexts
potential_contexts_parameters()
potential_contexts parameters.
public
static potential_contexts_parameters() : external_function_parameters
Return values
external_function_parameterspotential_contexts_returns()
potential_contexts return.
public
static potential_contexts_returns() : external_description|external_multiple_structure
Return values
external_description|external_multiple_structurepotential_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 ][, null|int $courseid = null ]) : array<string|int, mixed>
Parameters
- $query : null|string = null
- $searchanywhere : bool = true
- $page : int = 0
- $perpage : int = 30
- $courseid : null|int = null
Tags
Return values
array<string|int, mixed> —an array of users
potential_users_parameters()
potential_users parameters.
public
static potential_users_parameters() : external_function_parameters
Return values
external_function_parameterspotential_users_returns()
potential_users return.
public
static potential_users_returns() : external_multiple_structure
Return values
external_multiple_structureget_basic_search_conditions()
protected
static get_basic_search_conditions(context $context, string $search, bool $searchanywhere) : array<string|int, mixed>
Parameters
- $context : context
- $search : string
- $searchanywhere : bool