core\output\sticky_footer Class Reference

Inheritance diagram for core\output\sticky_footer:

Public Member Functions
	__construct (string $stickycontent='', ?string $stickyclasses=null, array $attributes=[])
	Constructor.
	add_attribute (string $atribute, string $value)
	Add extra attributes to the sticky footer element.
	add_classes (string $stickyclasses)
	Add extra classes to the sticky footer.
	export_for_template (\renderer_base $output)
	Export this data so it can be used as the context for a mustache template (core/inplace_editable).
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template.
	get_template_name (renderer_base $renderer)
	Get the name of the template to use for this templatable.
	get_template_name (\renderer_base $renderer)
	Get the name of the template to use for this templatable.
	set_auto_enable (bool $autoenable)
	Set the auto enable value.
	set_content (string $stickycontent)
	Set the footer contents.

Protected Attributes
array	$attributes = []
	extra HTML attributes (attribute => value).
bool	$autoenable = true
	if the footer should auto enable or not.
string	$stickyclasses = 'justify-content-end'
	extra CSS classes.
string	$stickycontent = ''
	content of the sticky footer.

Detailed Description

Copyright

2022 Ferran Recio ferra.nosp@m.n@mo.nosp@m.odle..nosp@m.com

License

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

Constructor & Destructor Documentation

__construct()

core\output\sticky_footer::__construct	(	string	$stickycontent = '',
		?string	$stickyclasses = null,
		array	$attributes = [] )

Constructor.

Parameters

string	$stickycontent	the footer content
string | null	$stickyclasses	extra CSS classes
array	$attributes	extra html attributes (attribute => value)

Member Function Documentation

add_attribute()

core\output\sticky_footer::add_attribute	(	string	$atribute,
		string	$value )

Add extra attributes to the sticky footer element.

Parameters

string	$atribute	the attribute
string	$value	the value

add_classes()

core\output\sticky_footer::add_classes

(

string

$stickyclasses

)

Add extra classes to the sticky footer.

Parameters

string

$stickyclasses

the extra classes

export_for_template() [1/2]

core\output\sticky_footer::export_for_template

(

\renderer_base

$output

)

Export this data so it can be used as the context for a mustache template (core/inplace_editable).

Parameters

renderer_base

$output

typically, the renderer that's calling this function

Return values

array

data context for a mustache template

export_for_template() [2/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.

get_template_name() [1/2]

core\output\named_templatable::get_template_name ( renderer_base $renderer )

inherited

Get the name of the template to use for this templatable.

Parameters

renderer_base

$renderer

The renderer requesting the template name

Return values

string

Implemented in core\output\choicelist, core\output\comboboxsearch, core_course\output\actionbar\group_selector_button, core_course\output\actionbar\group_selector_dropdown_form, core_course\output\actionbar\user_selector_button, core_courseformat\output\local\overview\activityname, and core_courseformat\output\local\overview\overviewtable.

get_template_name() [2/2]

core\output\sticky_footer::get_template_name

(

\renderer_base

$renderer

)

Get the name of the template to use for this templatable.

Parameters

renderer_base

$renderer

The renderer requesting the template name

Return values

string

the template name

set_auto_enable()

core\output\sticky_footer::set_auto_enable

(

bool

$autoenable

)

Set the auto enable value.

Parameters

bool

$autoenable

the footer content

set_content()

core\output\sticky_footer::set_content

(

string

$stickycontent

)

Set the footer contents.

Parameters

string

$stickycontent

the footer content

Member Data Documentation

$stickyclasses

string core\output\sticky_footer::$stickyclasses = 'justify-content-end'

protected

extra CSS classes.

By default, elements are justified to the end.

---

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

• lib/classes/output/sticky_footer.php