Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
initials_bar Class Reference

Component representing initials bar. More...

Inheritance diagram for initials_bar:
renderable templatable

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.

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$currentthe currently selected letter.
string$classclass name to add to this initial bar.
string$titlethe name to put in front of this initial bar.
string$urlvarURL parameter name for this initial.
string$urlURL object.
array$alphaof letters in the alphabet.
bool$minirenderReturn 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$outputThe renderer.
Return values
stdClass

Implements templatable.


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