Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_badges\output\standard_action_bar Class Reference
Inheritance diagram for core_badges\output\standard_action_bar:
core_badges\output\base_action_bar renderable templatable

Public Member Functions

 __construct (moodle_page $page, int $type, bool $showmanage=true, $showaddbadge=true, ?moodle_url $backurl=null)
 standard_action_bar constructor
 
 export_for_template (renderer_base $output)
 Export the action bar.
 
 get_template ()
 The template that this tertiary nav should use.
 
 get_third_party_nav_action (renderer_base $output)
 Gets additional third party navigation nodes for display.
 

Protected Member Functions

 expected_items ()
 Expected navigation node keys for badges.
 

Protected Attributes

moodle_url $backurl
 $backurl BackURL to be used when the back button is required.
 
moodle_page $page
 $page The context we are operating within.
 
bool $showaddbadge
 $showaddbadge Whether or not to show the add badges button.
 
bool $showmanage
 $showmanage Whether or not to show the manage badges button.
 
int $type
 $type The badge type.
 

Constructor & Destructor Documentation

◆ __construct()

core_badges\output\standard_action_bar::__construct ( moodle_page $page,
int $type,
bool $showmanage = true,
$showaddbadge = true,
?moodle_url $backurl = null )

standard_action_bar constructor

Parameters
moodle_page$pageThe page object
int$typeThe type of badge we are operating with
bool$showmanageWhether or not to show the manage badges button
bool$showaddbadgeWhether or not to show the add badges button
moodle_url | null$backurlThe backurl to be used

Member Function Documentation

◆ expected_items()

core_badges\output\base_action_bar::expected_items ( )
protectedinherited

Expected navigation node keys for badges.

Return values
arraydefault badge navigation node keys.

◆ export_for_template()

core_badges\output\standard_action_bar::export_for_template ( renderer_base $output)

Export the action bar.

Parameters
renderer_base$output
Return values
arrayThe buttons to be rendered

Implements templatable.

◆ get_template()

core_badges\output\standard_action_bar::get_template ( )

The template that this tertiary nav should use.

Return values
string

Reimplemented from core_badges\output\base_action_bar.

◆ get_third_party_nav_action()

core_badges\output\base_action_bar::get_third_party_nav_action ( renderer_base $output)
inherited

Gets additional third party navigation nodes for display.

Parameters
renderer_base$outputThe output
Return values
arrayAll that sweet third party navigation action.

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