initials_bar Class Reference

Component representing initials bar. More...

Inheritance diagram for initials_bar:

Public Member Functions
	__construct ($current, $class, $title, $urlvar, $url, $alpha=null, bool $minirender=false)
	Constructor initials_bar with only the required params.
	export_for_template (renderer_base $output)
	Export for template.

Public Attributes
array	$alpha
	An array of letters in the alphabet.
string	$class
	Class name to add to this initial bar.
string	$current
	Currently selected letter.
bool	$minirender
	Omit links if we are doing a mini render.
string	$title
	The name to put in front of this initial bar.
moodle_url	$url
	URL object.
string	$urlvar
	URL parameter name for this initial.

Detailed Description

Component representing initials bar.

Copyright

2017 Ilya Tregubov

License

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

Since

Moodle 3.3

Constructor & Destructor Documentation

__construct()

initials_bar::__construct	(		$current,
			$class,
			$title,
			$urlvar,
			$url,
			$alpha = null,
		bool	$minirender = false )

Constructor initials_bar with only the required params.

Parameters

string	$current	the currently selected letter.
string	$class	class name to add to this initial bar.
string	$title	the name to put in front of this initial bar.
string	$urlvar	URL parameter name for this initial.
string	$url	URL object.
array	$alpha	of letters in the alphabet.
bool	$minirender	Return a trimmed down view of the initials bar.

Member Function Documentation

export_for_template()

initials_bar::export_for_template

(

renderer_base

$output

)

Export for template.

Parameters

renderer_base

$output

The renderer.

Return values

stdClass

Implements templatable.

---

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

• lib/outputcomponents.php