Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
tool_componentlibrary\local\examples\dynamictabs\tab1 Class Reference

Example tab class. More...

Inheritance diagram for tool_componentlibrary\local\examples\dynamictabs\tab1:
core\output\dynamic_tabs\base templatable

Public Member Functions

 add_data (array $data)
 Add custom data to the tab data attributes.
 
 export_for_template (renderer_base $output)
 Export this for use in a mustache template context.
 
 get_data ()
 Return tab data attributes.
 
 get_tab_id ()
 HTML "id" attribute that should be used for this tab, by default the last part of class name.
 
 get_tab_label ()
 The label to be displayed on the tab.
 
 get_template ()
 Template to use to display tab contents.
 
 is_available ()
 Check permission of the current user to access this tab.
 
 require_access ()
 Check that tab is accessible, throw exception otherwise - used from WS requesting tab contents.
 

Protected Attributes

array $data
 

Detailed Description

Example tab class.

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

Member Function Documentation

◆ add_data()

core\output\dynamic_tabs\base::add_data ( array $data)
inherited

Add custom data to the tab data attributes.

Parameters
array$data

◆ export_for_template()

tool_componentlibrary\local\examples\dynamictabs\tab1::export_for_template ( renderer_base $output)

Export this for use in a mustache template context.

Parameters
renderer_base$output
Return values
stdClass

Implements templatable.

◆ get_data()

core\output\dynamic_tabs\base::get_data ( )
inherited

Return tab data attributes.

Return values
array

◆ get_tab_id()

core\output\dynamic_tabs\base::get_tab_id ( )
inherited

HTML "id" attribute that should be used for this tab, by default the last part of class name.

Return values
string

◆ get_tab_label()

tool_componentlibrary\local\examples\dynamictabs\tab1::get_tab_label ( )

The label to be displayed on the tab.

Return values
string

Reimplemented from core\output\dynamic_tabs\base.

◆ get_template()

tool_componentlibrary\local\examples\dynamictabs\tab1::get_template ( )

Template to use to display tab contents.

Return values
string

Reimplemented from core\output\dynamic_tabs\base.

◆ is_available()

tool_componentlibrary\local\examples\dynamictabs\tab1::is_available ( )

Check permission of the current user to access this tab.

Return values
bool

Reimplemented from core\output\dynamic_tabs\base.

◆ require_access()

core\output\dynamic_tabs\base::require_access ( )
finalinherited

Check that tab is accessible, throw exception otherwise - used from WS requesting tab contents.

Exceptions
moodle_exception

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