Moodle APIs 4.0
Moodle 4.0.11 (Build: 20231009)
Public Member Functions | List of all members
mod_data\output\action_bar Class Reference

Public Member Functions

 __construct (int $id, moodle_url $pageurl)
 The class constructor.
 
 get_fields_action_bar (bool $hasfieldselect=false, bool $hassaveaspreset=false, bool $hasexportpreset=false)
 Generate the output for the action bar in the field page.
 
 get_presets_action_bar ()
 Generate the output for the action selector in the presets page.
 
 get_templates_action_bar ()
 Generate the output for the action selector in the templates page.
 
 get_view_action_bar (bool $hasentries)
 Generate the output for the action selector in the view page.
 

Constructor & Destructor Documentation

◆ __construct()

mod_data\output\action_bar::__construct ( int  $id,
moodle_url  $pageurl 
)

The class constructor.

Parameters
int$idThe database module id.
moodle_url$pageurlThe URL of the current page.

Member Function Documentation

◆ get_fields_action_bar()

mod_data\output\action_bar::get_fields_action_bar ( bool  $hasfieldselect = false,
bool  $hassaveaspreset = false,
bool  $hasexportpreset = false 
)

Generate the output for the action bar in the field page.

Parameters
bool$hasfieldselectWhether the field selector element should be rendered.
bool$hassaveaspresetWhether the save as preset button element should be rendered.
bool$hasexportpresetWhether the export as preset button element should be rendered.
Return values
stringThe HTML code for the action bar.

◆ get_presets_action_bar()

mod_data\output\action_bar::get_presets_action_bar ( )

Generate the output for the action selector in the presets page.

Return values
stringThe HTML code for the action selector.

◆ get_templates_action_bar()

mod_data\output\action_bar::get_templates_action_bar ( )

Generate the output for the action selector in the templates page.

Return values
stringThe HTML code for the action selector.

◆ get_view_action_bar()

mod_data\output\action_bar::get_view_action_bar ( bool  $hasentries)

Generate the output for the action selector in the view page.

Parameters
bool$hasentriesWhether entries exist.
Return values
stringThe HTML code for the action selector.

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