 |
Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
|
Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
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. | |
| diff ($pageid, $old, $new, $options=array()) | |
| diff_paging_bar ($minpage, $maxpage, $page, $baseurl, $pagevar='page', $nocurr=false) | |
| Prints a single paging bar to provide access to other versions. | |
| 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. | |
| image_url ($imagename, $component='moodle') | |
| Return the moodle_url for an image. | |
| menu_admin ($pageid, $currentselect) | |
| menu_map ($pageid, $currentselect) | |
| page_index () | |
| pix_url ($imagename, $component='moodle') | |
| Return the direct URL for an image from the pix folder. | |
| prettyview_link ($page) | |
| render (renderable $widget) | |
| Renders the provided widget and returns the HTML to display it. | |
| render_action_bar (\mod_wiki\output\action_bar $actionbar) | |
| Renders the action bar. | |
| render_from_template ($templatename, $context) | |
| Renders a template by name with the given context. | |
| render_wiki_files_tree (wiki_files_tree $tree) | |
| search_result ($records, $subwiki) | |
| 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. | |
| tabs ($page, $tabitems, $options) | |
| wiki_files_tree ($context, $subwiki) | |
| wiki_info () | |
| Print the wiki activity information and intro. | |
| wiki_print_subwiki_selector ($wiki, $subwiki, $page, $pagetype='view') | |
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. | |
| htmllize_tree ($tree, $dir) | |
| Internal function - creates htmls structure suitable for YUI tree. | |
Protected Attributes | |
| 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. | |
| string | $target |
| The requested rendering target. | |
| array | $templatecache = [] |
| $templatecache The mustache template cache. | |
|
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 |
| mod_wiki_renderer::diff_paging_bar | ( | $minpage, | |
| $maxpage, | |||
| $page, | |||
| $baseurl, | |||
| $pagevar = 'page', | |||
| $nocurr = false ) |
Prints a single paging bar to provide access to other versions.
| int | $minpage | First page to be displayed in the bar |
| int | $maxpage | Last page to be displayed in the bar |
| int | $page | The page you are currently viewing |
| mixed | $baseurl | If this is a string then it is the url which will be appended with $pagevar, an equals sign and the page number. If this is a moodle_url object then the pagevar param will be replaced by the page no, for each page. |
| string | $pagevar | This is the variable name that you use for the page number in your code (ie. 'tablepage', 'blogpage', etc) |
| bool | $nocurr | do not display the current page as a link |
| bool | $return | whether to return an output string or echo now |
| bool | or 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 |
|
inherited |
Returns true is output has already started, and false if not.
| boolean | true if the header has been printed. |
|
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 |
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 |
Renders the provided widget and returns the HTML to display it.
| renderable | $widget | instance with renderable interface |
| string |
Reimplemented from renderer_base.
Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.
| mod_wiki_renderer::render_action_bar | ( | \mod_wiki\output\action_bar | $actionbar | ) |
Renders the action bar.
| mod_wiki\output\action_bar | $actionbar |
| string | The HTML output |
|
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 |
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 |
| mod_wiki_renderer::wiki_info | ( | ) |
Print the wiki activity information and intro.
| string |
|
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