Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_course\local\entity\activity_chooser_footer Class Reference

A class to represent the Activity Chooser footer data. More...

Public Member Functions

 __construct (string $footerjspath, string $footertemplate, ?string $carouseltemplate='')
 Constructor method.
 
 get_carousel_template ()
 Get the carousel rendered template for this plugin.
 
 get_footer_js_file ()
 Get the footer JS file path for this plugin.
 
 get_footer_template ()
 Get the footer rendered template for this plugin.
 

Protected Attributes

string $carouseltemplate
 $carouseltemplate The rendered template for the footer.
 
string $footerjspath
 $footerjspath The path to the plugin JS file to dynamically import later.
 
string $footertemplate
 $footertemplate The rendered template for the footer.
 

Detailed Description

A class to represent the Activity Chooser footer data.

@subpackage course

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

Constructor & Destructor Documentation

◆ __construct()

core_course\local\entity\activity_chooser_footer::__construct ( string $footerjspath,
string $footertemplate,
?string $carouseltemplate = '' )

Constructor method.

Parameters
string$footerjspathJS file to dynamically import later.
string$footertemplateFooter template that has been rendered.
string | null$carouseltemplateCarousel template that may have been rendered.

Member Function Documentation

◆ get_carousel_template()

core_course\local\entity\activity_chooser_footer::get_carousel_template ( )

Get the carousel rendered template for this plugin.

Return values
stringThe template that has been rendered for the chooser carousel.

◆ get_footer_js_file()

core_course\local\entity\activity_chooser_footer::get_footer_js_file ( )

Get the footer JS file path for this plugin.

Return values
stringThe JS file to call functions from.

◆ get_footer_template()

core_course\local\entity\activity_chooser_footer::get_footer_template ( )

Get the footer rendered template for this plugin.

Return values
stringThe template that has been rendered for the chooser footer.

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