block_search_forums\output\search_form Class Reference

Search form renderable class. More...

Inheritance diagram for block_search_forums\output\search_form:

Public Member Functions
	__construct ($courseid)
	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.
moodle_url	$advancedsearchurl
	The advanced search URL.
int	$courseid
	The course ID.
help_icon	$helpicon
	The help icon.

Detailed Description

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()

block_search_forums\output\search_form::__construct

(

$courseid

)

Constructor.

Parameters

int

$courseid

The course ID.

Member Function Documentation

export_for_template()

block_search_forums\output\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:

• blocks/search_forums/classes/output/search_form.php