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

Public Member Functions

 __construct (badge $badge, moodle_page $page)
 manage_badge_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.
 
 generate_badge_navigation ()
 Generate the options to be displayed when editing a badge.
 
 get_badge_administration_mapping_construct ()
 Returns a multi dimensional array of the links that should be displayed when creating a badge.
 

Protected Attributes

badge $badge
 $badge The badge we are managing.
 
moodle_page $page
 $page The context we are operating within.
 
int $type
 $type The badge type.
 

Constructor & Destructor Documentation

◆ __construct()

core_badges\output\manage_badge_action_bar::__construct ( badge $badge,
moodle_page $page )

manage_badge_action_bar constructor

Parameters
badge$badgeThe badge we are viewing
moodle_page$pageThe page object

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\manage_badge_action_bar::export_for_template ( renderer_base $output)

Export the action bar.

Parameters
renderer_base$output
Return values
array

Implements templatable.

Reimplemented in core_badges\output\recipients_action_bar.

◆ generate_badge_navigation()

core_badges\output\manage_badge_action_bar::generate_badge_navigation ( )
protected

Generate the options to be displayed when editing a badge.

This feeds into a URL select which will be displayed in the tertiary navigation.

Return values
array

◆ get_badge_administration_mapping_construct()

core_badges\output\manage_badge_action_bar::get_badge_administration_mapping_construct ( )
protected

Returns a multi dimensional array of the links that should be displayed when creating a badge.

The keys of the array feed into the text shown to the user and content of each element contain the following:

  • url URL for the option
  • additionalparams Additional params to feed into the url
  • capability The capabilities to check that governs visibility
    Return values
    array

◆ get_template()

core_badges\output\manage_badge_action_bar::get_template ( )

The template that this tertiary nav should use.

Return values
string

Reimplemented from core_badges\output\base_action_bar.

Reimplemented in core_badges\output\recipients_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: