core_course\output\activity_navigation Class Reference

The class activity navigation renderable. More...

Inheritance diagram for core_course\output\activity_navigation:

Public Member Functions
	__construct ($prevmod, $nextmod, $activitylist=array())
	Constructor.
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template.
	export_for_template (\renderer_base $output)
	Export this data so it can be used as the context for a mustache template.

Public Attributes
url_select	$activitylist = null
	The url select object for the activity selector menu.
action_link	$nextlink = null
	The action link object for the next link.
action_link	$prevlink = null
	The action link object for the prev link.

Detailed Description

The class activity navigation renderable.

Copyright

2017 Mark Nelson markn.nosp@m.@moo.nosp@m.dle.c.nosp@m.om

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

core_course\output\activity_navigation::__construct	(		$prevmod,
			$nextmod,
			$activitylist = array() )

Constructor.

Parameters

cm_info | null	$prevmod	The previous module to display, null if none.
cm_info | null	$nextmod	The next module to display, null if none.
array	$activitylist	The list of activity URLs (as key) and names (as value) for the activity dropdown menu.

Member Function Documentation

export_for_template() [1/2]

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

inherited

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

1. No complex types - only stdClass, array, int, string, float, bool
2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).

Parameters

renderer_base

$output

Used to do a final render of any components that need to be rendered for export.

Return values

stdClass|array

Implemented in core\output\action_menu, core\output\actions\component_action, core\output\activity_header, core\output\checkbox_toggleall, core\output\choicelist, core\output\chooser, core\output\chooser_item, core\output\chooser_section, core\output\comboboxsearch, core\output\context_header, core\output\custom_menu_item, core\output\dynamic_tabs, core\output\help_icon, core\output\initials_bar, core\output\paging_bar, core\output\pix_icon, core\output\pix_icon_font, core\output\progress_bar, core\output\select_menu, core\output\single_select, core\output\tabobject, core\output\tabtree, core\output\task_indicator, core\output\url_select, core_calendar\output\humandate, core_calendar\output\humantimeperiod, core_course\output\actionbar\group_selector_button, core_course\output\actionbar\group_selector_dropdown_form, core_course\output\actionbar\initials_dropdown_form, core_course\output\actionbar\user_selector_button, core_course\output\activity_completion, core_course\output\activity_dates, core_course\output\activity_icon, core_course\output\activitychooserbutton, core_course\output\completion_action_bar, core_courseformat\output\local\content\basecontrolmenu, core_courseformat\output\local\content\cm\controlmenu, core_courseformat\output\local\content\cm, core_courseformat\output\local\content\section, core_courseformat\output\local\overview\activityname, core_courseformat\output\local\overview\overviewtable, core_grades\output\penalty_indicator, core_reportbuilder\output\custom_report, core_reportbuilder\output\dynamictabs\access, core_reportbuilder\output\dynamictabs\audience, core_reportbuilder\output\dynamictabs\editor, core_reportbuilder\output\dynamictabs\schedules, core_reportbuilder\output\report_action, and core_reportbuilder\output\system_report.

export_for_template() [2/2]

core_course\output\activity_navigation::export_for_template

(

\renderer_base

$output

)

Export this data so it can be used as the context for a mustache template.

Parameters

renderer_base

$output

Renderer base.

Return values

stdClass

---

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

• course/classes/output/activity_navigation.php