Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 401 and 403]

(no description)

File Size: 225 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

participants_action_bar:: (7 methods):
  __construct()
  get_ordered_nodes()
  get_content_for_select()
  get_thirdparty_node_array()
  find_active_page()
  get_dropdown()
  export_for_template()


Class: participants_action_bar  - X-Ref

Class responsible for generating the action bar (tertiary nav) elements in the participants page and related pages.

__construct(object $course, moodle_page $page, ?string $renderedcontent)   X-Ref
Constructor participants_action_bar

param: object $course The course that we are generating the nav for
param: moodle_page $page The page object
param: string|null $renderedcontent Any additional rendered content/actions to be displayed in line with the nav

get_ordered_nodes()   X-Ref
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: array

get_content_for_select()   X-Ref
Get the content for the url_select select box.

return: array

get_thirdparty_node_array()   X-Ref
Gets an array of third party navigation nodes in an array formatted for a url_select element.

return: array|null The thirdparty node array.

find_active_page(array $urlcontent, int $strictness = URL_MATCH_EXACT)   X-Ref
Recursively tries to find a matching url

param: array $urlcontent The content for the url_select
param: int $strictness Strictness for the compare criteria
return: string The matching active url

get_dropdown(\renderer_base $output)   X-Ref
Gets the url_select to be displayed in the participants page if available.

param: \renderer_base $output
return: object|null The content required to render the url_select

export_for_template(\renderer_base $output)   X-Ref
Export the content to be displayed on the participants page.

param: \renderer_base $output
return: array Consists of the following: