Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | List of all members
initials_bar Class Reference
Inheritance diagram for initials_bar:
renderable templatable

Public Member Functions

 __construct ($current, $class, $title, $urlvar, $url, $alpha=null)
 Constructor initials_bar with only the required params. More...
 
 export_for_template (renderer_base $output)
 Export for template. More...
 

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.
 
string $title
 The name to put in front of this initial bar.
 
string $url
 URL object.
 
string $urlvar
 URL parameter name for this initial.
 

Constructor & Destructor Documentation

◆ __construct()

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

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.

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: