core_search\external Class Reference

Handles external (web service) function calls related to search. More...

Inheritance diagram for core_search\external:

Static Public Member Functions
static	get_relevant_users ($query, $courseid)
	Searches for users given a query, taking into account the current user's permissions and possibly a course to check within.
static	get_relevant_users_parameters ()
	Returns parameter types for get_relevant_users function.
static	get_relevant_users_returns ()
	Returns result type for get_relevant_users function.

Detailed Description

Handles external (web service) function calls related to search.

Copyright

2017 The Open University

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

get_relevant_users()

static core_search\external::get_relevant_users ( $query, $courseid )

static

Searches for users given a query, taking into account the current user's permissions and possibly a course to check within.

Parameters

string	$query	Query text
int	$courseid	Course id or 0 if no restriction

Return values

array

Defined return structure

get_relevant_users_parameters()

static core_search\external::get_relevant_users_parameters ( )

static

Returns parameter types for get_relevant_users function.

Return values

external_function_parameters

Parameters

get_relevant_users_returns()

static core_search\external::get_relevant_users_returns ( )

static

Returns result type for get_relevant_users function.

Return values

external_description

Result type

---

The documentation for this class was generated from the following file:

• search/classes/external.php