mod_data\output\action_bar Class Reference

Public Member Functions
	__construct (int $id, moodle_url $pageurl)
	The class constructor.
	get_create_fields (bool $isprimarybutton=false)
	Generate the output for the create a new field action menu.
	get_fields_action_bar (bool $hasfieldselect=false, ?bool $unused1=null, ?bool $unused2=null)
	Generate the output for the action bar in the field page.
	get_fields_mapping_action_bar ()
	Generate the output for the action bar in the field mappings page.
	get_presets_action_bar ()
	Generate the output for the action selector in the presets page.
	get_presets_preview_action_bar (manager $manager, string $fullname, string $current)
	Generate the output for the action selector in the presets preview page.
	get_templates_action_bar ()
	Generate the output for the action selector in the templates page.
	get_view_action_bar (bool $hasentries, string $mode)
	Generate the output for the action selector in the view page.

Protected Member Functions
	get_presets_actions_select (bool $hasimport=false)
	Helper method to get the selector for the presets action.

Constructor & Destructor Documentation

__construct()

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

The class constructor.

Parameters

int	$id	The database module id.
moodle_url	$pageurl	The URL of the current page.

Member Function Documentation

get_create_fields()

mod_data\output\action_bar::get_create_fields

(

bool

$isprimarybutton = false

)

Generate the output for the create a new field action menu.

Parameters

bool

$isprimarybutton

is the action trigger a primary or secondary button?

Return values

action_menu

Action menu to create a new field

get_fields_action_bar()

mod_data\output\action_bar::get_fields_action_bar	(	bool	$hasfieldselect = false,
		?bool	$unused1 = null,
		?bool	$unused2 = null )

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

Parameters

bool	$hasfieldselect	Whether the field selector element should be rendered.
null	$unused1	This parameter has been deprecated since 4.1 and should not be used anymore.
null	$unused2	This parameter has been deprecated since 4.1 and should not be used anymore.

Return values

string

The HTML code for the action bar.

get_fields_mapping_action_bar()

mod_data\output\action_bar::get_fields_mapping_action_bar

(

)

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

Return values

string

The 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

string

The HTML code for the action selector.

get_presets_actions_select()

mod_data\output\action_bar::get_presets_actions_select ( bool $hasimport = false )

protected

Helper method to get the selector for the presets action.

Parameters

bool

$hasimport

Whether the Import buttons must be included or not.

Return values

action_menu|null

The selector object used to display the presets actions. Null when the import button is not displayed and the database hasn't any fields.

get_presets_preview_action_bar()

mod_data\output\action_bar::get_presets_preview_action_bar	(	manager	$manager,
		string	$fullname,
		string	$current )

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

Parameters

manager	$manager	the manager instance
string	$fullname	the preset fullname
string	$current	the current template name

Return values

string

The 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

string

The HTML code for the action selector.

get_view_action_bar()

mod_data\output\action_bar::get_view_action_bar	(	bool	$hasentries,
		string	$mode )

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

Parameters

bool	$hasentries	Whether entries exist.
string	$mode	The current view mode (list, view...).

Return values

string

The HTML code for the action selector.

---

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

• mod/data/classes/output/action_bar.php