core\output\chooser Class Reference

The chooser renderable class. More...

Inheritance diagram for core\output\chooser:

Public Member Functions
	__construct (moodle_url $actionurl, lang_string $title, array $sections, $paramname)
	Constructor.
	add_param ($name, $value, $id=null)
	Add a parameter to submit with the form.
	export_for_template (renderer_base $output)
	Export for template.
	set_instructions (lang_string $value)
	Set the chooser instructions.
	set_method ($value)
	Set the form method.

Public Attributes
moodle_url	$actionurl
	The form action URL.
lang_string	$instructions
	The instructions to display.
string	$method = 'post'
	The form method.
string	$paramname
	The name of the parameter for the items value.
array	$params = []
	The list of hidden parameters.
chooser_section[]	$sections
	The sections.
lang_string	$title
	The chooser title.

Detailed Description

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

core\output\chooser::__construct	(	moodle_url	$actionurl,
		lang_string	$title,
		array	$sections,
			$paramname )

Constructor.

Parameters

moodle_url	$actionurl	The form action URL.
lang_string	$title	The title of the chooser.
chooser_section[]	$sections	The sections.
string	$paramname	The name of the parameter for the items value.

Member Function Documentation

add_param()

core\output\chooser::add_param	(		$name,
			$value,
			$id = null )

Add a parameter to submit with the form.

Parameters

string	$name	The parameter name.
string	$value	The parameter value.
string	$id	The parameter ID.

export_for_template()

core\output\chooser::export_for_template

(

renderer_base

$output

)

Export for template.

Parameters

renderer_base

The renderer.

Return values

stdClass

Implements templatable.

set_instructions()

core\output\chooser::set_instructions

(

lang_string

$value

)

Set the chooser instructions.

Parameters

lang_string

$value

The instructions.

set_method()

core\output\chooser::set_method

(

$value

)

Set the form method.

Parameters

string

$value

The method.

Member Data Documentation

$params

array core\output\chooser::$params = []

The list of hidden parameters.

See self::add_param.

---

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

• lib/classes/output/chooser.php