mod_wiki_renderer Class Reference

Inheritance diagram for mod_wiki_renderer:

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.
	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.
	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.

Member Function Documentation

diff_paging_bar()

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.

Parameters

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

Return values

bool

or string

render_action_bar()

mod_wiki_renderer::render_action_bar

(

\mod_wiki\output\action_bar

$actionbar

)

Renders the action bar.

Parameters

mod_wiki\output\action_bar

$actionbar

Return values

string

The HTML output

wiki_info()

mod_wiki_renderer::wiki_info

(

)

Print the wiki activity information and intro.

Return values

string

Deprecated

since 4.0. Now handled in PAGE's activity header

---

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

• mod/wiki/renderer.php