Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
renderer_base Class Reference
core

Simple base class for Moodle renderers. More...

Inheritance diagram for renderer_base:
plugin_renderer_base assignfeedback_editpdf_renderer assignfeedback_file_renderer auth_lti\output\renderer auth_oauth2\output\renderer block_lp\output\renderer block_myoverview\output\renderer block_myprofile\output\renderer block_navigation_renderer block_private_files_renderer block_recent_activity_renderer block_recentlyaccessedcourses\output\renderer block_recentlyaccesseditems\output\renderer block_rss_client\output\renderer block_search_forums\output\renderer block_section_links_renderer block_settings_renderer block_starredcourses\output\renderer block_timeline\output\renderer booktool_print\output\renderer core_admin_renderer core_availability_renderer core_backup_renderer core_badges_renderer core_blog_renderer core_cache\output\renderer core_calendar_renderer core_course\output\recommendations\renderer core_course_bulk_activity_completion_renderer core_course_management_renderer core_course_renderer core_customfield\output\renderer core_enrol_renderer core_files_renderer core_grades_renderer core_grading_renderer core_group\output\renderer core_h5p\output\renderer core_message_renderer core_privacy\output\renderer core_question_bank_renderer core_question_renderer core_reportbuilder\output\renderer core_rss_renderer core_search\output\renderer core_tag_renderer core_user\output\myprofile\renderer core_user_renderer core_webservice_renderer enrol_lti\output\renderer factor_email_renderer forumreport_summary_renderer gradeimport_csv_renderer gradereport_history\output\renderer gradereport_overview_renderer gradereport_singleview_renderer gradereport_user_renderer gradingform_guide_renderer gradingform_rubric_renderer message_email\output\renderer mod_assign\output\renderer mod_bigbluebuttonbn\output\renderer mod_book\output\renderer mod_chat_renderer mod_choice_renderer mod_data_renderer mod_feedback\output\renderer mod_folder_renderer mod_forum_renderer mod_glossary\output\renderer mod_lesson_renderer mod_lti\output\renderer mod_quiz\output\edit_renderer mod_quiz\output\renderer mod_scorm_renderer mod_survey_renderer mod_wiki_renderer mod_workshop_renderer qbank_bulkmove\output\renderer qbank_comment\output\renderer qbank_customfields\output\renderer qbank_editquestion\output\renderer qbank_history\output\renderer qbank_managecategories\output\renderer qbank_previewquestion\output\renderer qbank_statistics\output\renderer qbank_tagquestion\output\renderer qbank_usage\output\renderer qbank_viewcreator\output\renderer qbehaviour_renderer qtype_essay_format_renderer_base qtype_renderer quiz_grading_renderer report_competency\output\renderer report_eventlist_renderer report_infectedfiles\output\renderer report_insights\output\renderer report_log_renderer report_loglive_renderer report_loglive_renderer_ajax report_progress\output\renderer tool_analytics\output\renderer tool_behat_renderer tool_brickfield\output\renderer tool_capability_renderer tool_cohortroles\output\renderer tool_customlang\output\renderer tool_dataprivacy\output\renderer tool_filetypes_renderer tool_installaddon_renderer tool_langimport\output\renderer tool_licensemanager\output\renderer tool_lp\output\renderer tool_lpmigrate\output\renderer tool_messageinbound_renderer tool_mfa\output\renderer tool_mobile\output\renderer tool_monitor\output\managerules\renderer tool_monitor\output\managesubs\renderer tool_moodlenet\output\renderer tool_oauth2\output\renderer tool_policy\output\renderer tool_task_renderer tool_templatelibrary\output\renderer tool_usertours\output\renderer

Public Member Functions

 __construct (moodle_page $page, $target)
 Constructor.
 
 add_action_handler (component_action $action, $id=null)
 Adds a JS action for the element with the provided id.
 
 get_compact_logo_url ($maxwidth=300, $maxheight=300)
 Return the site's compact logo URL, if any.
 
 get_logo_url ($maxwidth=null, $maxheight=200)
 Return the site's logo URL, if any.
 
 get_page ()
 Returns the moodle page object.
 
 has_started ()
 Returns true is output has already started, and false if not.
 
 image_url ($imagename, $component='moodle')
 Return the moodle_url for an image.
 
 pix_url ($imagename, $component='moodle')
 Return the direct URL for an image from the pix folder.
 
 render (renderable $widget)
 Returns rendered widget.
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context.
 
 should_display_main_logo ()
 
 should_display_navbar_logo ()
 Whether we should display the logo in the navbar.
 

Static Public Member Functions

static prepare_classes ($classes)
 Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.
 

Protected Member Functions

 get_mustache ()
 Return an instance of the mustache class.
 

Protected Attributes

xhtml_container_stack $opencontainers
 The xhtml_container_stack to use.
 
moodle_page $page
 The Moodle page the renderer has been created to assist with.
 
string $target
 The requested rendering target.
 
array $templatecache = []
 $templatecache The mustache template cache.
 

Detailed Description

Simple base class for Moodle renderers.

Tracks the xhtml_container_stack to use, which is passed in in the constructor.

Also has methods to facilitate generating HTML output.

Copyright
2009 Tim Hunt
License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Since
Moodle 2.0
The documentation for this class was generated from the following file:
Generated on Sun Jun 9 2024 02:55:27 for Moodle PHP Documentation by doxygen 1.11.0