core_search\output\renderer Class Reference

Search renderer. More...

Inheritance diagram for core_search\output\renderer:

Public Member Functions
	__call ($method, $arguments)
	Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.
	add_action_handler (component_action $action, $id=null)
	Adds a JS action for the element with the provided id.
	get_compact_logo_url ($maxwidth=300, $maxheight=300)
	Return the site's compact logo URL, if any.
	get_logo_url ($maxwidth=null, $maxheight=200)
	Return the site's logo URL, if any.
	get_page ()
	Returns the moodle page object.
	has_started ()
	Returns true is output has already started, and false if not.
	image_url ($imagename, $component='moodle')
	Return the moodle_url for an image.
	pix_url ($imagename, $component='moodle')
	Return the direct URL for an image from the pix folder.
	render (renderable $widget)
	Renders the provided widget and returns the HTML to display it.
	render_from_template ($templatename, $context)
	Renders a template by name with the given context.
	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.
	should_display_main_logo ($headinglevel=1)
	Whether we should display the main logo.
	should_display_navbar_logo ()
	Whether we should display the logo in the navbar.

Static Public Member Functions
static	prepare_classes ($classes)
	Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

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.

Protected Member Functions
	get_mustache ()
	Return an instance of the mustache class.

Protected Attributes
xhtml_container_stack	$opencontainers
	The xhtml_container_stack to use.
renderer_base core_renderer	$output
	A reference to the current renderer.
moodle_page	$page
	The Moodle page the renderer has been created to assist with.
string	$target
	The requested rendering target.
array	$templatecache = []
	$templatecache The mustache template cache.

Detailed Description

Search renderer.

Copyright

2015 David Monllao

License

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

Member Function Documentation

render_index_requests_info()

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

render_result()

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

render_results()

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

render_search_disabled()

core_search\output\renderer::render_search_disabled

(

)

Returns a box with a search disabled lang string.

Return values

string

HTML

render_top_results()

core_search\output\renderer::render_top_results

(

$results

)

Top results content.

Parameters

core_search\document[]

$results

Search Results

Return values

string

content of the top result section

---

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

• search/classes/output/renderer.php