◆ __construct()
core\output\participants_action_bar::__construct |
( |
object | $course, |
|
|
moodle_page | $page, |
|
|
?string | $renderedcontent ) |
Constructor participants_action_bar.
- Parameters
-
object | $course | The course that we are generating the nav for |
moodle_page | $page | The page object |
string | null | $renderedcontent | Any additional rendered content/actions to be displayed in line with the nav |
◆ 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
-
- Return values
-
array | Consists 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 | $urlcontent | The content for the url_select |
int | $strictness | Strictness for the compare criteria |
- Return values
-
string | The 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
-
◆ 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
-
- Return values
-
object|null | The 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
-
◆ 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|null | The thirdparty node array. |
The documentation for this class was generated from the following file:
- lib/classes/output/participants_action_bar.php