Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
mod_data\output\view_footer Class Reference
Inheritance diagram for mod_data\output\view_footer:
core\output\sticky_footer core\output\named_templatable renderable templatable

Public Member Functions

 __construct (manager $manager, int $totalcount, int $currentpage, int $nowperpage, moodle_url $baseurl, template $parser)
 The class 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)
 Export this data so it can be used as the context for a mustache template (core/inplace_editable).
 
 get_footer_output (renderer_base $output)
 Generate the pre-rendered footer content.
 
 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.
 

Constructor & Destructor Documentation

◆ __construct()

mod_data\output\view_footer::__construct ( manager $manager,
int $totalcount,
int $currentpage,
int $nowperpage,
moodle_url $baseurl,
template $parser )

The class constructor.

Parameters
manager$managerthe activity manager
int$totalcountthe total records count
int$currentpagethe current page
int$nowperpagethe number of elements per page
moodle_url$baseurlthe page base url
template$parserthe current template name

Member Function Documentation

◆ add_attribute()

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

Add extra attributes to the sticky footer element.

Parameters
string$atributethe attribute
string$valuethe value

◆ add_classes()

core\output\sticky_footer::add_classes ( string $stickyclasses)
inherited

Add extra classes to the sticky footer.

Parameters
string$stickyclassesthe extra classes

◆ export_for_template() [1/2]

core\output\sticky_footer::export_for_template ( \renderer_base $output)
inherited

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

Parameters
renderer_base$outputtypically, the renderer that's calling this function
Return values
arraydata context for a mustache template

◆ export_for_template() [2/2]

mod_data\output\view_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$outputtypically, the renderer that's calling this function
Return values
arraydata context for a mustache template

Implements templatable.

◆ get_footer_output()

mod_data\output\view_footer::get_footer_output ( renderer_base $output)

Generate the pre-rendered footer content.

Parameters
renderer_base$outputThe renderer to be used to render the action bar elements.
Return values
stringthe rendered content

◆ get_template_name()

core\output\sticky_footer::get_template_name ( \renderer_base $renderer)
inherited

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

Parameters
renderer_base$rendererThe renderer requesting the template name
Return values
stringthe template name

Implements core\output\named_templatable.

◆ set_auto_enable()

core\output\sticky_footer::set_auto_enable ( bool $autoenable)
inherited

Set the auto enable value.

Parameters
bool$autoenablethe footer content

◆ set_content()

core\output\sticky_footer::set_content ( string $stickycontent)
inherited

Set the footer contents.

Parameters
string$stickycontentthe footer content

Member Data Documentation

◆ $stickyclasses

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

extra CSS classes.

By default, elements are justified to the end.


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