Search renderer. More...

Inheritance diagram for core_search\output\renderer:

Public Member Functions
	render_index_requests_info (\stdClass $info)
	Returns information about queued index requests.

	render_result (\core_search\document $doc)
	Displaying search results.

	render_results ($results, $page, $totalcount, $url, $cat=null)
	Renders search results.

	render_search_disabled ()
	Returns a box with a search disabled lang string.

	render_top_results ($results)
	Top results content.

Public Attributes
int const	SEARCH_RESULT_STRING_SIZE = 100
	Max number chars to display of a string value.

int const	SEARCH_RESULT_TEXT_SIZE = 500
	Max number chars to display of a text value.

Detailed Description

Search renderer.

Member Function Documentation

core_search\output\renderer::render_index_requests_info ( \stdClass $info )

Returns information about queued index requests.

Parameters

stdClass $info Info object from get_index_requests_info

Return values

string HTML

Exceptions

moodle_exception Any error with template

core_search\output\renderer::render_result ( \core_search\document $doc )

Displaying search results.

Parameters

core_search\document Containing a single search response to be displayed.a

Return values

string HTML

core_search\output\renderer::render_results	(	$results,
		$page,
		$totalcount,
		$url,
		$cat = null )

Renders search results.

Parameters

core_search\document[]	$results
int	$page	Zero based page number.
int	$totalcount	Total number of results available.
moodle_url	$url
core_search\area_category \| null	$cat	Selected search are category or null if category functionality is disabled.

Return values

string HTML

core_search\output\renderer::render_search_disabled ( )

Returns a box with a search disabled lang string.

Return values

string HTML

core_search\output\renderer::render_top_results ( $results )