mod_forum\output\quick_search_form Class Reference

Quick search form renderable class. More...

Inheritance diagram for mod_forum\output\quick_search_form:

Public Member Functions
	__construct ($courseid, $query='')
	Constructor. More...
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template. More...

Protected Attributes
moodle_url	$actionurl
	The form action URL.
int	$courseid
	The course ID.
help_icon	$helpicon
	The help icon.
string	$query
	Current query.

Detailed Description

Quick search form renderable class.

Copyright

2016 Frédéric Massart - FMCorz.net

License

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

Constructor & Destructor Documentation

__construct()

mod_forum\output\quick_search_form::__construct	(		$courseid,
			$query = ''
	)

Constructor.

Parameters

int	$courseid	The course ID.
string	$query	The current query.

Member Function Documentation

export_for_template()

mod_forum\output\quick_search_form::export_for_template

(

renderer_base

$output

)

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

1. No complex types - only stdClass, array, int, string, float, bool
2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).

Parameters

renderer_base

$output

Used to do a final render of any components that need to be rendered for export.

Return values

stdClass|array

Implements templatable.

---

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

• mod/forum/classes/output/quick_search_form.php