Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core\output\participants_action_bar Class Reference
Inheritance diagram for core\output\participants_action_bar:
renderable

Public Member Functions

 __construct (object $course, moodle_page $page, ?string $renderedcontent)
 Constructor participants_action_bar.
 
 export_for_template (\renderer_base $output)
 Export the content to be displayed on the participants page.
 
 get_dropdown (\renderer_base $output)
 Gets the url_select to be displayed in the participants page if available.
 

Protected Member Functions

 find_active_page (array $urlcontent, int $strictness=URL_MATCH_EXACT)
 Recursively tries to find a matching url.
 
 get_content_for_select ()
 Get the content for the url_select select box.
 
 get_ordered_nodes ()
 Return the nodes required to be displayed in the url_select box.
 
 get_thirdparty_node_array ()
 Gets an array of third party navigation nodes in an array formatted for a url_select element.
 

Constructor & Destructor Documentation

◆ __construct()

core\output\participants_action_bar::__construct ( object $course,
moodle_page $page,
?string $renderedcontent )

Constructor participants_action_bar.

Parameters
object$courseThe course that we are generating the nav for
moodle_page$pageThe page object
string | null$renderedcontentAny additional rendered content/actions to be displayed in line with the nav

Member Function Documentation

◆ export_for_template()

core\output\participants_action_bar::export_for_template ( \renderer_base $output)

Export the content to be displayed on the participants page.

Parameters
renderer_base$output
Return values
arrayConsists of the following:
  • urlselect A stdclass representing the standard navigation options to be fed into a urlselect
  • renderedcontent Rendered content to be displayed in line with the tertiary nav

◆ find_active_page()

core\output\participants_action_bar::find_active_page ( array $urlcontent,
int $strictness = URL_MATCH_EXACT )
protected

Recursively tries to find a matching url.

Parameters
array$urlcontentThe content for the url_select
int$strictnessStrictness for the compare criteria
Return values
stringThe matching active url

◆ get_content_for_select()

core\output\participants_action_bar::get_content_for_select ( )
protected

Get the content for the url_select select box.

Return values
array

◆ get_dropdown()

core\output\participants_action_bar::get_dropdown ( \renderer_base $output)

Gets the url_select to be displayed in the participants page if available.

Parameters
renderer_base$output
Return values
object|nullThe content required to render the url_select

◆ get_ordered_nodes()

core\output\participants_action_bar::get_ordered_nodes ( )
protected

Return the nodes required to be displayed in the url_select box.

The nodes are divided into 3 sections each with the heading as the key.

Return values
array

◆ get_thirdparty_node_array()

core\output\participants_action_bar::get_thirdparty_node_array ( )
protected

Gets an array of third party navigation nodes in an array formatted for a url_select element.

Return values
array|nullThe thirdparty node array.

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