core_search\external\get_results Class Reference

External function for retrieving search results. More...

Inheritance diagram for core_search\external\get_results:

Static Public Member Functions
static	execute (string $query, array $filters=[], int $page=0)
	Gets global search results based on the provided query and filters.
static	execute_parameters ()
	Webservice parameters.
static	execute_returns ()
	Webservice returns.

Detailed Description

External function for retrieving search results.

Copyright

2023 David Monllao & Juan Leyva juan@.nosp@m.mood.nosp@m.le.co.nosp@m.m

License

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

Since

Moodle 4.3

Member Function Documentation

execute()

static core_search\external\get_results::execute ( string $query, array $filters = [], int $page = 0 )

static

Gets global search results based on the provided query and filters.

Parameters

string	$query	the search query
array	$filters	filters to apply
int	$page	results page

Return values

array

search results

execute_parameters()

static core_search\external\get_results::execute_parameters ( )

static

Webservice parameters.

Return values

external_function_parameters

execute_returns()

static core_search\external\get_results::execute_returns ( )

static

Webservice returns.

Return values

external_single_structure

---

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

• search/classes/external/get_results.php