 |
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
|
Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
|
Renderer for outputting the social course format. More...
Public Member Functions | |
| __call ($method, $arguments) | |
| Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief. | |
| add_action_handler (component_action $action, $id=null) | |
| Adds a JS action for the element with the provided id. | |
| add_new_course_button () | |
| Returns HTML to the "add new course" button for the page. | |
| availability_info ($text, $additionalclasses='') | |
| Displays availability info for a course section or course module. | |
| bulk_editing_button (course_format $format) | |
| Render the enable bulk editing button. | |
| course_activitychooser ($courseid) | |
| Build the HTML for the module chooser javascript popup. | |
| course_category ($category) | |
| Renders HTML to display particular course category - list of it's subcategories and courses. | |
| course_category_tree (array $ignored) | |
| Renderers a structured array of courses and categories into a nice XHTML tree structure. | |
| course_index_drawer (course_format $format) | |
| Get the course index drawer with placeholder. | |
| course_info_box (stdClass $course) | |
| Renders course info box. | |
| course_modchooser () | |
| course_search_form ($value='') | |
| Renders html to display a course search form. | |
| course_section_add_cm_control ($course, $section, $sectionreturn=null, $displayoptions=array()) | |
| Renders HTML for the menus to add activities and resources to the current course. | |
| course_section_cm ($course, &$completioninfo, cm_info $mod, $sectionreturn, $displayoptions=[]) | |
| Renders HTML to display one course module in a course section. | |
| course_section_cm_availability (cm_info $mod, $displayoptions=array()) | |
| Renders HTML to show course module availability information (for someone who isn't allowed to see the activity itself, or for staff) | |
| course_section_cm_completion () | |
| course_section_cm_edit_actions ($actions, cm_info $mod=null, $displayoptions=array()) | |
| Renders HTML for displaying the sequence of course module editing buttons. | |
| course_section_cm_list ($course, $section, $sectionreturn=null, $displayoptions=[]) | |
| Renders HTML to display a list of course modules in a course section Also displays "move here" controls in Javascript-disabled mode. | |
| course_section_cm_list_item ($course, &$completioninfo, cm_info $mod, $sectionreturn, $displayoptions=[]) | |
| Renders HTML to display one course module for display within a section. | |
| course_section_cm_name (cm_info $mod, $displayoptions=array()) | |
| Renders html to display a name with the link to the course module on a course page. | |
| course_section_cm_name_title (cm_info $mod, $displayoptions=array()) | |
| Renders html to display a name with the link to the course module on a course page. | |
| course_section_cm_text (cm_info $mod, $displayoptions=array()) | |
| Renders html to display the module content on the course page (i.e. | |
| course_section_cm_unavailable_error_message (cm_info $cm) | |
| Message displayed to the user when they try to access unavailable activity following URL. | |
| course_section_updated (course_format $format, section_info $section) | |
| Get the updated rendered version of a section. | |
| course_section_updated_cm_item (course_format $format, section_info $section, cm_info $cm, array $displayoptions=[]) | |
| Get the updated rendered version of a cm list item. | |
| coursecat_ajax () | |
| Serves requests to /course/category.ajax.php. | |
| courses_list ($courses, $showcategoryname=false, $additionalclasses=null, $paginationurl=null, $totalcount=null, $page=0, $perpage=null) | |
| Displays a custom list of courses with paging bar if necessary. | |
| frontpage () | |
| Outputs contents for frontpage as configured in $CFG->frontpage or $CFG->frontpageloggedin. | |
| frontpage_available_courses () | |
| Returns HTML to print list of available courses for the frontpage. | |
| frontpage_categories_list () | |
| Returns HTML to print tree of course categories (with number of courses) for the frontpage. | |
| frontpage_combo_list () | |
| Returns HTML to print tree with course categories and courses for the frontpage. | |
| frontpage_my_courses () | |
| Returns HTML to print list of courses user is enrolled to for the frontpage. | |
| frontpage_section1 () | |
| Output frontpage summary text and frontpage modules (stored as section 1 in site course) | |
| 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. | |
| has_started () | |
| Returns true is output has already started, and false if not. | |
| hubinfo ($hubinfo) | |
| Hub information (logo - name - description - link) | |
| image_url ($imagename, $component='moodle') | |
| Return the moodle_url for an image. | |
| is_cm_conditionally_hidden (cm_info $mod) | |
| Checks if course module has any conditions that may make it unavailable for all or some of the students. | |
| pix_url ($imagename, $component='moodle') | |
| Return the direct URL for an image from the pix folder. | |
| print_multiple_section_page ($course, $sections, $mods, $modnames, $modnamesused) | |
| Output the html for a multiple section page. | |
| print_single_section_page ($course, $sections, $mods, $modnames, $modnamesused, $displaysection) | |
| Output the html for a single section page. | |
| render (renderable $widget) | |
| Renders the provided widget and returns the HTML to display it. | |
| render_activity_information (\core_course\output\activity_information $page) | |
| Renders the activity information. | |
| render_activity_navigation (\core_course\output\activity_navigation $page) | |
| Renders the activity navigation. | |
| render_from_template ($templatename, $context) | |
| Renders a template by name with the given context. | |
| render_modchooser (renderable $modchooser) | |
| Render a modchooser. | |
| search_courses ($searchcriteria) | |
| Renders html to display search result page. | |
| section_availability ($section) | |
| Displays availability information for the section (hidden, not available unles, etc.) | |
| section_title ($section, $course) | |
| Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page. | |
| section_title_without_link ($section, $course) | |
| Generate the section title to be displayed on the section page, without a link. | |
| sendingbackupinfo ($backupfile) | |
| Display waiting information about backup size during uploading backup process. | |
| should_display_main_logo ($headinglevel=1) | |
| Whether we should display the main logo. | |
| should_display_navbar_logo () | |
| Whether we should display the logo in the navbar. | |
| tagged_courses ($tagid, $exclusivemode=true, $ctx=0, $rec=true, $displayoptions=null) | |
| Renders html to print list of courses tagged with particular tag. | |
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 | |
| add_modchoosertoggle () | |
| change_number_sections ($course, $sectionreturn=null) | |
| Returns controls in the bottom of the page to increase/decrease number of sections. | |
| course_activity_clipboard ($course, $sectionno=null) | |
| Show if something is on on the course clipboard (moving around) | |
| course_category_name (coursecat_helper $chelper, core_course_list_element $course) | |
| Returns HTML to display course category name. | |
| course_category_tree_category (stdClass $category, $depth=1) | |
| Renderers a category for use with course_category_tree. | |
| course_contacts (core_course_list_element $course) | |
| Returns HTML to display course contacts. | |
| course_custom_fields (core_course_list_element $course) | |
| Returns HTML to display course custom fields. | |
| course_enrolment_icons (core_course_list_element $course) | |
| Returns HTML to display course enrolment icons. | |
| course_modchooser_module ($module, $classes=array('option')) | |
| Return the HTML for the specified module adding any required classes. | |
| course_modchooser_module_types ($modules) | |
| Build the HTML for a specified set of modules. | |
| course_modchooser_title ($title, $identifier=null) | |
| course_name (coursecat_helper $chelper, core_course_list_element $course) | |
| Returns HTML to display course name. | |
| course_overview_files (core_course_list_element $course) | |
| Returns HTML to display course overview files. | |
| course_section_cm_classes (cm_info $mod) | |
| Returns the CSS classes for the activity name/content. | |
| course_summary (coursecat_helper $chelper, core_course_list_element $course) | |
| Returns HTML to display course summary. | |
| coursecat_category (coursecat_helper $chelper, $coursecat, $depth) | |
| Returns HTML to display a course category as a part of a tree. | |
| coursecat_category_content (coursecat_helper $chelper, $coursecat, $depth) | |
| Returns HTML to display the subcategories and courses in the given category. | |
| coursecat_coursebox (coursecat_helper $chelper, $course, $additionalclasses='') | |
| Displays one course in the list of courses. | |
| coursecat_coursebox_content (coursecat_helper $chelper, $course) | |
| Returns HTML to display course content (summary, course contacts and optionally category name) | |
| coursecat_courses (coursecat_helper $chelper, $courses, $totalcount=null) | |
| Renders the list of courses. | |
| coursecat_include_js () | |
| Make sure that javascript file for AJAX expanding of courses and categories content is included. | |
| coursecat_subcategories (coursecat_helper $chelper, $coursecat, $depth) | |
| Renders the list of subcategories in a category. | |
| coursecat_tree (coursecat_helper $chelper, $coursecat) | |
| Returns HTML to display a tree of subcategories and courses in the given category. | |
| end_section_list () | |
| Generate the closing container html for a list of sections. | |
| format_summary_text ($section) | |
| Generate html for a section summary text. | |
| frontpage_news ($forum) | |
| Output news for the frontpage (extract from site-wide news forum) | |
| frontpage_part ($skipdivid, $contentsdivid, $header, $contents) | |
| Renders part of frontpage with a skip link (i.e. | |
| frontpage_remote_course (stdClass $course) | |
| Returns HTML to display one remote course. | |
| frontpage_remote_host ($host) | |
| Returns HTML to display one remote host. | |
| get_mustache () | |
| Return an instance of the mustache class. | |
| get_nav_links ($course, $sections, $sectionno) | |
| Generate next/previous section links for naviation. | |
| section_activity_summary ($section, $course, $mods) | |
| Generate a summary of the activites in a section. | |
| section_availability_message ($section, $canviewhidden) | |
| If section is not visible, display the message about that ('Not available until...', that sort of thing). | |
| section_edit_control_items ($course, $section, $onsectionpage=false) | |
| Generate the edit control items of a section. | |
| section_edit_control_menu ($controls, $course, $section) | |
| Generate the edit control action menu. | |
| section_edit_controls () | |
| Old method to print section edit controls. | |
| section_footer () | |
| Generate the display of the footer part of a section. | |
| section_header ($section, $course, $onsectionpage, $sectionreturn=null) | |
| Generate the display of the header part of a section before course modules are included. | |
| section_hidden ($sectionno, $courseorid=null) | |
| Generate the html for a hidden section. | |
| section_left_content ($section, $course, $onsectionpage) | |
| Generate the content to displayed on the left part of a section before course modules are included. | |
| section_nav_selection ($course, $sections, $displaysection) | |
| Generate the html for the 'Jump to' menu on a single section page. | |
| section_right_content ($section, $course, $onsectionpage) | |
| Generate the content to displayed on the right part of a section before course modules are included. | |
| section_summary ($section, $course, $mods) | |
| Generate a summary of a section for display on the 'course index page'. | |
| start_section_list () | |
| Generate the starting container html for a list of sections. | |
| stealth_section_footer () | |
| Generate footer html of a stealth section. | |
| stealth_section_header ($sectionno) | |
| Generate the header html of a stealth section. | |
Protected Attributes | |
| bool | $categoryexpandedonload = false |
| Whether a category content is being initially rendered with children. | |
| core_course_renderer | $courserenderer |
| contains an instance of core course renderer | |
| xhtml_container_stack | $opencontainers |
| The xhtml_container_stack to use. | |
| renderer_base core_renderer | $output |
| A reference to the current renderer. | |
| moodle_page | $page |
| The Moodle page the renderer has been created to assist with. | |
| stdClass | $strings |
| A cache of strings. | |
| string | $target |
| The requested rendering target. | |
| array | $templatecache = [] |
| $templatecache The mustache template cache. | |
Renderer for outputting the social course format.
|
inherited |
Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.
| string | $method | |
| array | $arguments |
| mixed |
|
inherited |
Adds a JS action for the element with the provided id.
This method adds a JS event for the provided component action to the page and then returns the id that the event has been attached to. If no id has been provided then a new ID is generated by html_writer::random_id()
| component_action | $action | |
| string | $id |
| string | id of element, either original submitted or random new if not supplied |
|
protectedinherited |
|
inherited |
Returns HTML to the "add new course" button for the page.
| string |
|
inherited |
Displays availability info for a course section or course module.
| string | $text | |
| string | $additionalclasses |
| string |
|
inherited |
Render the enable bulk editing button.
| course_format | $format | the course format |
| string|null | the enable bulk button HTML (or null if no bulk available). |
|
protectedinherited |
Returns controls in the bottom of the page to increase/decrease number of sections.
| stdClass | $course | |
| int | null | $sectionreturn |
|
protectedinherited |
Show if something is on on the course clipboard (moving around)
While the non ajax course eidtion is still supported, the old clipboard will be emulated by core_courseformat\output\local\content\section\cmlist.
| stdClass | $course | The course entry from DB |
| int | $sectionno | The section number in the course which is being displayed |
| string | HTML to output. |
|
inherited |
Build the HTML for the module chooser javascript popup.
| int | $courseid | The course id to fetch modules for. |
| string |
|
inherited |
Renders HTML to display particular course category - list of it's subcategories and courses.
Invoked from /course/index.php
| int | stdClass | core_course_category | $category |
|
protectedinherited |
Returns HTML to display course category name.
| coursecat_helper | $chelper | |
| core_course_list_element | $course |
| string |
|
finalinherited |
Renderers a structured array of courses and categories into a nice XHTML tree structure.
| array | $ignored | argument ignored |
| string |
|
finalprotectedinherited |
Renderers a category for use with course_category_tree.
| array | $category | |
| int | $depth |
| string |
|
protectedinherited |
Returns HTML to display course contacts.
| core_course_list_element | $course |
| string |
|
protectedinherited |
Returns HTML to display course custom fields.
| core_course_list_element | $course |
| string |
|
protectedinherited |
Returns HTML to display course enrolment icons.
| core_course_list_element | $course |
| string |
|
inherited |
Get the course index drawer with placeholder.
The default course index is loaded after the page is ready. Format plugins can override this method to provide an alternative course index.
If the format is not compatible with the course index, this method will return an empty string.
| course_format | $format | the course format |
| String | the course index HTML. |
|
inherited |
Renders course info box.
| stdClass | $course |
| string |
|
inherited |
|
protectedinherited |
Return the HTML for the specified module adding any required classes.
| object | $module | An object containing the title, and link. An icon, and help text may optionally be specified. If the module contains subtypes in the types option, then these will also be displayed. |
| array | $classes | Additional classes to add to the encompassing div element |
| string | The composed HTML for the module |
|
protectedinherited |
Build the HTML for a specified set of modules.
| array | $modules | A set of modules as used by the course_modchooser_module function |
| string | The composed HTML for the module |
|
protectedinherited |
Returns HTML to display course name.
| coursecat_helper | $chelper | |
| core_course_list_element | $course |
| string |
|
protectedinherited |
Returns HTML to display course overview files.
| core_course_list_element | $course |
| string |
|
inherited |
Renders html to display a course search form.
| string | $value | default value to populate the search field |
| string |
|
inherited |
Renders HTML for the menus to add activities and resources to the current course.
Renders the ajax control (the link which when clicked produces the activity chooser modal). No noscript fallback.
| stdClass | $course | |
| int | $section | relative section number (field course_sections.section) |
| int | $sectionreturn | The section to link back to |
| array | $displayoptions | additional display options, for example blocks add option 'inblock' => true, suggesting to display controls vertically |
| string |
|
inherited |
Renders HTML to display one course module in a course section.
This includes link, content, availability, completion info and additional information that module type wants to display (i.e. number of unread forum posts)
| stdClass | $course | |
| completion_info | $completioninfo | |
| cm_info | $mod | |
| int | null | $sectionreturn | |
| array | $displayoptions |
| string |
|
inherited |
Renders HTML to show course module availability information (for someone who isn't allowed to see the activity itself, or for staff)
| cm_info | $mod | |
| array | $displayoptions |
| string |
|
protectedinherited |
Returns the CSS classes for the activity name/content.
For items which are hidden, unavailable or stealth but should be displayed to current user ($mod->is_visible_on_course_page()), we show those as dimmed. Students will also see as dimmed activities names that are not yet available but should still be displayed (without link) with availability info.
| cm_info | $mod |
| array | array of two elements ($linkclasses, $textclasses) |
|
inherited |
|
inherited |
Renders HTML for displaying the sequence of course module editing buttons.
| action_link[] | $actions | Array of action_link objects |
| cm_info | $mod | The module we are displaying actions for. |
| array | $displayoptions | additional display options: ownerselector => A JS/CSS selector that can be used to find an cm node. If specified the owning node will be given the class 'action-menu-shown' when the action menu is being displayed. donotenhance => If set to true the action menu that gets displayed won't be enhanced by JS. |
| string |
|
inherited |
Renders HTML to display a list of course modules in a course section Also displays "move here" controls in Javascript-disabled mode.
This function calls core_course_renderer::course_section_cm()
| stdClass | $course | course object |
| int | stdClass | section_info | $section | relative section number or section object |
| int | $sectionreturn | section number to return to |
| int | $displayoptions |
| void |
|
inherited |
Renders HTML to display one course module for display within a section.
This function calls: core_course_renderer::course_section_cm()
| stdClass | $course | |
| completion_info | $completioninfo | |
| cm_info | $mod | |
| int | null | $sectionreturn | |
| array | $displayoptions |
| String |
|
inherited |
Renders html to display a name with the link to the course module on a course page.
If module is unavailable for user but still needs to be displayed in the list, just the name is returned without a link
Note, that for course modules that never have separate pages (i.e. labels) this function return an empty string
| cm_info | $mod | |
| array | $displayoptions |
| string |
|
inherited |
Renders html to display a name with the link to the course module on a course page.
If module is unavailable for user but still needs to be displayed in the list, just the name is returned without a link
Note, that for course modules that never have separate pages (i.e. labels) this function return an empty string
| cm_info | $mod | |
| array | $displayoptions |
| string |
|
inherited |
Renders html to display the module content on the course page (i.e.
text of the labels)
| cm_info | $mod | |
| array | $displayoptions |
| string |
|
inherited |
Message displayed to the user when they try to access unavailable activity following URL.
This method is a very simplified version of course_section_cm() to be part of the error notification only. It also does not check if module is visible on course page or not.
The message will be displayed inside notification!
| cm_info | $cm |
| string |
|
inherited |
Get the updated rendered version of a section.
This method will only be used when the course editor requires to get an updated cm item HTML to perform partial page refresh. It will be used for supporting the course editor webservices.
By default, the template used for update a section is the same as when it renders initially, but format plugins are free to override this method to provide extra effects or so.
| course_format | $format | the course format |
| section_info | $section | the section info |
| string | the rendered element |
|
inherited |
Get the updated rendered version of a cm list item.
This method is used when an activity is duplicated or copied in on the client side without refreshing the page. It replaces the course renderer course_section_cm_list_item method but it's scope is different. Note that the previous method is used every time an activity is rendered, independent of it is the initial page loading or an Ajax update. In this case, course_section_updated_cm_item will only be used when the course editor requires to get an updated cm item HTML to perform partial page refresh. It will be used for suporting the course editor webservices.
By default, the template used for update a cm_item is the same as when it renders initially, but format plugins are free to override this methos to provide extra affects or so.
| course_format | $format | the course format |
| section_info | $section | the section info |
| cm_info | $cm | the course module ionfo |
| array | $displayoptions | optional extra display options |
| string | the rendered element |
|
protectedinherited |
Returns HTML to display course summary.
| coursecat_helper | $chelper | |
| core_course_list_element | $course |
| string |
|
inherited |
Serves requests to /course/category.ajax.php.
In this renderer implementation it may expand the category content or course content.
| string |
| coding_exception |
|
protectedinherited |
Returns HTML to display a course category as a part of a tree.
This is an internal function, to display a particular category and all its contents use core_course_renderer::course_category()
| coursecat_helper | $chelper | various display options |
| core_course_category | $coursecat | |
| int | $depth | depth of this category in the current tree |
| string |
|
protectedinherited |
Returns HTML to display the subcategories and courses in the given category.
This method is re-used by AJAX to expand content of not loaded category
| coursecat_helper | $chelper | various display options |
| core_course_category | $coursecat | |
| int | $depth | depth of the category in the current tree |
| string |
|
protectedinherited |
Displays one course in the list of courses.
This is an internal function, to display an information about just one course please use core_course_renderer::course_info_box()
| coursecat_helper | $chelper | various display options |
| core_course_list_element | stdClass | $course | |
| string | $additionalclasses | additional classes to add to the main tag (usually depend on the course position in list - first/last/even/odd) |
| string |
|
protectedinherited |
Returns HTML to display course content (summary, course contacts and optionally category name)
This method is called from coursecat_coursebox() and may be re-used in AJAX
| coursecat_helper | $chelper | various display options |
| stdClass | core_course_list_element | $course |
| string |
|
protectedinherited |
Renders the list of courses.
This is internal function, please use core_course_renderer::courses_list() or another public method from outside of the class
If list of courses is specified in $courses; the argument $chelper is only used to retrieve display options and attributes, only methods get_show_courses(), get_courses_display_option() and get_and_erase_attributes() are called.
| coursecat_helper | $chelper | various display options |
| array | $courses | the list of courses to display |
| int | null | $totalcount | total number of courses (affects display mode if it is AUTO or pagination if applicable), defaulted to count($courses) |
| string |
|
protectedinherited |
Renders the list of subcategories in a category.
| coursecat_helper | $chelper | various display options |
| core_course_category | $coursecat | |
| int | $depth | depth of the category in the current tree |
| string |
|
protectedinherited |
Returns HTML to display a tree of subcategories and courses in the given category.
| coursecat_helper | $chelper | various display options |
| core_course_category | $coursecat | top category (this category's name and description will NOT be added to the tree) |
| string |
|
inherited |
Displays a custom list of courses with paging bar if necessary.
If $paginationurl is specified but $totalcount is not, the link 'View more' appears under the list.
If both $paginationurl and $totalcount are specified, and $totalcount is bigger than count($courses), a paging bar is displayed above and under the courses list.
| array | $courses | array of course records (or instances of core_course_list_element) to show on this page |
| bool | $showcategoryname | whether to add category name to the course description |
| string | $additionalclasses | additional CSS classes to add to the div.courses |
| moodle_url | $paginationurl | url to view more or url to form links to the other pages in paging bar |
| int | $totalcount | total number of courses on all pages, if omitted $paginationurl will be displayed as 'View more' link |
| int | $page | current page number (defaults to 0 referring to the first page) |
| int | $perpage | number of records per page (defaults to $CFG->coursesperpage) |
| string |
|
protectedinherited |
Generate the closing container html for a list of sections.
| string | HTML to output. |
|
protectedinherited |
Generate html for a section summary text.
| stdClass | $section | The course_section entry from DB |
| string | HTML to output. |
|
inherited |
Outputs contents for frontpage as configured in $CFG->frontpage or $CFG->frontpageloggedin.
| string |
|
inherited |
Returns HTML to print list of available courses for the frontpage.
| string |
|
inherited |
Returns HTML to print tree of course categories (with number of courses) for the frontpage.
| string |
|
inherited |
Returns HTML to print tree with course categories and courses for the frontpage.
| string |
|
inherited |
Returns HTML to print list of courses user is enrolled to for the frontpage.
Also lists remote courses or remote hosts if MNET authorisation is used
| string |
|
protectedinherited |
Output news for the frontpage (extract from site-wide news forum)
| stdClass | $forum | record from db table 'forum' that represents the site news forum |
| string |
|
protectedinherited |
Renders part of frontpage with a skip link (i.e.
"My courses", "Site news", etc.)
| string | $skipdivid | |
| string | $contentsdivid | |
| string | $header | Header of the part |
| string | $contents | Contents of the part |
| string |
|
protectedinherited |
Returns HTML to display one remote course.
| stdClass | $course | remote course information, contains properties: id, remoteid, shortname, fullname, hostid, summary, summaryformat, cat_name, hostname |
| string |
|
protectedinherited |
Returns HTML to display one remote host.
| array | $host | host information, contains properties: name, url, count |
| string |
|
inherited |
Output frontpage summary text and frontpage modules (stored as section 1 in site course)
This may be disabled in settings
| string |
|
inherited |
Return the site's compact logo URL, if any.
| int | $maxwidth | The maximum width, or null when the maximum width does not matter. |
| int | $maxheight | The maximum height, or null when the maximum height does not matter. |
| moodle_url|false |
|
inherited |
Return the site's logo URL, if any.
| int | $maxwidth | The maximum width, or null when the maximum width does not matter. |
| int | $maxheight | The maximum height, or null when the maximum height does not matter. |
| moodle_url|false |
|
protectedinherited |
Return an instance of the mustache class.
| Mustache_Engine |
|
protectedinherited |
Generate next/previous section links for naviation.
This element is now a core_courseformat\output\content\section output component and it is displayed using mustache templates instead of a renderer method.
| stdClass | $course | The course entry from DB |
| array | $sections | The course_sections entries from the DB |
| int | $sectionno | The section number in the course which is being displayed |
| array | associative array with previous and next section link |
|
inherited |
Returns true is output has already started, and false if not.
| boolean | true if the header has been printed. |
|
inherited |
Hub information (logo - name - description - link)
| object | $hubinfo |
| string | html code |
|
inherited |
Return the moodle_url for an image.
The exact image location and extension is determined automatically by searching for gif|png|jpg|jpeg, please note there can not be diferent images with the different extension. The imagename is for historical reasons a relative path name, it may be changed later for core images. It is recommended to not use subdirectories in plugin and theme pix directories.
There are three types of images: 1/ theme images - stored in theme/mytheme/pix/, use component 'theme' 2/ core images - stored in /pix/, overridden via theme/mytheme/pix_core/ 3/ plugin images - stored in mod/mymodule/pix, overridden via theme/mytheme/pix_plugins/mod/mymodule/, example: image_url('comment', 'mod_glossary')
| string | $imagename | the pathname of the image |
| string | $component | full plugin name (aka component) or 'theme' |
| moodle_url |
|
inherited |
Checks if course module has any conditions that may make it unavailable for all or some of the students.
| cm_info | $mod |
| bool |
|
inherited |
Return the direct URL for an image from the pix folder.
Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
| string | $imagename | the name of the icon. |
| string | $component | specification of one plugin like in get_string() |
| moodle_url |
|
staticinherited |
Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.
| mixed | $classes | Space-separated string or array of classes |
| string | HTML class attribute value |
|
inherited |
Output the html for a multiple section page.
This is a deprecated method and it is mantain only for compatibilitiy with legacy course formats. Please, to render a single section page use:
$format = course_get_format($course); $outputclass = $format->get_output_classname('content'); $widget = new $outputclass($format); echo $this->render($widget);
| stdClass | $course | The course entry from DB |
| array | $sections | (argument not used) |
| array | $mods | (argument not used) |
| array | $modnames | (argument not used) |
| array | $modnamesused | (argument not used) |
|
inherited |
Output the html for a single section page.
This is a deprecated method and it is mantain only for compatibilitiy with legacy course formats. Please, to render a single section page use:
$format = course_get_format($course); // Set the section to display. $format->set_section_number($displaysection); $outputclass = $format->get_output_classname('content'); $widget = new $outputclass($format); echo $this->render($widget);
| stdClass | $course | The course entry from DB |
| array | $sections | (argument not used) |
| array | $mods | (argument not used) |
| array | $modnames | (argument not used) |
| array | $modnamesused | (argument not used) |
| int | $displaysection | The section number in the course which is being displayed |
|
inherited |
Renders the provided widget and returns the HTML to display it.
Course format templates uses a similar subfolder structure to the renderable classes. This method find out the specific template for a course widget. That's the reason why this render method is different from the normal plugin renderer one.
course format templatables can be rendered using the core_course/local/* templates. Format plugins are free to override the default template location using render_xxx methods as usual.
| renderable | $widget | instance with renderable interface |
| string | the widget HTML |
Reimplemented from plugin_renderer_base.
|
inherited |
Renders the activity information.
Defer to template.
| core_course\output\activity_information | $page |
| string | html for the page |
|
inherited |
Renders the activity navigation.
Defer to template.
| core_course\output\activity_navigation | $page |
| string | html for the page |
|
inherited |
Renders a template by name with the given context.
The provided data needs to be array/stdClass made up of only simple types. Simple types are array,stdClass,bool,int,float,string
| array | stdClass | $context | Context containing data for the template. |
| string|boolean |
|
inherited |
Render a modchooser.
| renderable | $modchooser | The chooser. |
| string |
|
inherited |
Renders html to display search result page.
| array | $searchcriteria | may contain elements: search, blocklist, modulelist, tagid |
| string |
|
protectedinherited |
Generate a summary of the activites in a section.
This element is now a core_courseformat\output\content\section output component and it is displayed using mustache templates instead of a renderer method.
| stdClass | $section | The course_section entry from DB |
| stdClass | $course | the course record from DB |
| array | $mods | (argument not used) |
| string | HTML to output. |
|
inherited |
Displays availability information for the section (hidden, not available unles, etc.)
This element is now a core_courseformat\output\content\section output component and it is displayed using mustache templates instead of a renderer method.
| section_info | $section |
| string |
|
protectedinherited |
If section is not visible, display the message about that ('Not available until...', that sort of thing).
Otherwise, returns blank.
For users with the ability to view hidden sections, it shows the information even though you can view the section and also may include slightly fuller information (so that teachers can tell when sections are going to be unavailable etc). This logic is the same as for activities.
This element is now a core_courseformat\output\content\section output component and it is displayed using mustache templates instead of a renderer method.
| section_info | $section | The course_section entry from DB |
| bool | $canviewhidden | True if user can view hidden sections |
| string | HTML to output |
|
protectedinherited |
Generate the edit control items of a section.
This element is now a core_courseformat\output\content\section output component and it is displayed using mustache templates instead of a renderer method.
| stdClass | $course | The course entry from DB |
| stdClass | $section | The course_section entry from DB |
| bool | $onsectionpage | true if being printed on a section page |
| array | of edit control items |
|
protectedinherited |
Generate the edit control action menu.
The section edit controls are now part of the main core_courseformat\output\local\content\section output and does not use renderer methods anymore.
| array | $controls | The edit control items from section_edit_control_items |
| stdClass | $course | The course entry from DB (not used) |
| stdClass | $section | The course_section entry from DB |
| string | HTML to output. |
|
protectedinherited |
Old method to print section edit controls.
Do not use it!
|
protectedinherited |
Generate the display of the footer part of a section.
This element is integrated into core_courseformat\output\local\content\section output component and it is displayed using mustache templates instead of a renderer method.
| string | HTML to output. |
|
protectedinherited |
Generate the display of the header part of a section before course modules are included.
This element is now a core_courseformat\output\content\section output component and it is displayed using mustache templates instead of a renderer method.
| stdClass | $section | The course_section entry from DB |
| stdClass | $course | The course entry from DB |
| bool | $onsectionpage | true if being printed on a single-section page |
| int | $sectionreturn | The section to return to after an action |
| string | HTML to output. |
|
protectedinherited |
Generate the html for a hidden section.
| int | $sectionno | The section number in the course which is being displayed |
| int | stdClass | $courseorid | The course to get the section name for (object or just course id) |
| string | HTML to output. |
|
protectedinherited |
Generate the content to displayed on the left part of a section before course modules are included.
Spatial references like "left" or "right" are limiting the way formats and themes can extend courses. The elements from this method are now included in the core_courseformat\output\local\content\section output components.
| stdClass | $section | The course_section entry from DB |
| stdClass | $course | The course entry from DB |
| bool | $onsectionpage | true if being printed on a section page |
| string | HTML to output. |
|
protectedinherited |
Generate the html for the 'Jump to' menu on a single section page.
This element is now a core_courseformat\output\content\section output component and it is displayed using mustache templates instead of a renderer method.
| stdClass | $course | The course entry from DB |
| array | $sections | The course_sections entries from the DB |
| int | $displaysection | the current displayed section number. |
| string | HTML to output. |
|
protectedinherited |
Generate the content to displayed on the right part of a section before course modules are included.
Spatial references like "left" or "right" are limiting the way formats and themes can extend courses. The elements from this method are now included in the core_courseformat\output\local\content\section output components.
| stdClass | $section | The course_section entry from DB |
| stdClass | $course | The course entry from DB |
| bool | $onsectionpage | true if being printed on a section page |
| string | HTML to output. |
|
protectedinherited |
Generate a summary of a section for display on the 'course index page'.
This element is now a core_courseformat\output\content\section output component and it is displayed using mustache templates instead of a renderer method.
| stdClass | $section | The course_section entry from DB |
| stdClass | $course | The course entry from DB |
| array | $mods | (argument not used) |
| string | HTML to output. |
|
inherited |
Generate the section title, wraps it in a link to the section page if page is to be displayed on a separate page.
| stdClass | $section | The course_section entry from DB |
| stdClass | $course | The course entry from DB |
| string | HTML to output. |
Reimplemented in format_topics\output\renderer, and format_weeks\output\renderer.
|
inherited |
Generate the section title to be displayed on the section page, without a link.
| stdClass | $section | The course_section entry from DB |
| stdClass | $course | The course entry from DB |
| string | HTML to output. |
Reimplemented in format_topics\output\renderer, and format_weeks\output\renderer.
|
inherited |
Display waiting information about backup size during uploading backup process.
| object | $backupfile | the backup stored_file |
| $html | string |
|
inherited |
Whether we should display the main logo.
| int | $headinglevel | The heading level we want to check against. |
| bool |
|
inherited |
Whether we should display the logo in the navbar.
We will when there are no main logos, and we have compact logo.
| bool |
|
protectedinherited |
Generate the starting container html for a list of sections.
| string | HTML to output. |
|
protectedinherited |
Generate footer html of a stealth section.
This element is now a core_courseformat\output\content\section output component and it is displayed using mustache templates instead of a renderer method.
| string | HTML to output. |
|
protectedinherited |
Generate the header html of a stealth section.
This element is now a core_courseformat\output\content\section output component and it is displayed using mustache templates instead of a renderer method.
| int | $sectionno | The section number in the course which is being displayed |
| string | HTML to output. |
|
inherited |
Renders html to print list of courses tagged with particular tag.
| int | $tagid | id of the tag |
| bool | $exclusivemode | if set to true it means that no other entities tagged with this tag are displayed on the page and the per-page limit may be bigger |
| int | $fromctx | context id where the link was displayed, may be used by callbacks to display items in the same context first |
| int | $ctx | context id where to search for records |
| bool | $rec | search in subcontexts as well |
| array | $displayoptions |
| string | empty string if no courses are marked with this tag or rendered list of courses |
|
protectedinherited |
Whether a category content is being initially rendered with children.
This is mainly used by the core_course_renderer\corsecat_tree() to render the appropriate action for the Expand/Collapse all link on page load.
|
protectedinherited |
contains an instance of core course renderer
|
protectedinherited |
A reference to the current renderer.
The renderer provided here will be determined by the page but will in 90% of cases by the core_renderer
1.11.0