booktool_print\output\renderer Class Reference

The renderer for the book print tool. More...

Inheritance diagram for booktool_print\output\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.
	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)
	Renders the provided widget and returns the HTML to display it.
	render_from_template ($templatename, $context)
	Renders a template by name with the given context.
	render_print_book_chapter ($chapter, $chapters, $book, $cm)
	Render the print book chapter.
	render_print_book_chapter_dialog_link ()
	Render the print book chapter link.
	render_print_book_chapter_page (print_book_chapter_page $page)
	Render the print book chapter page.
	render_print_book_dialog_link ()
	Render the print book link.
	render_print_book_page (print_book_page $page)
	Render the print book page.
	render_print_book_toc ($chapters, $book, $cm)
	Render the print book table of contents.
	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.

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

Detailed Description

The renderer for the book print tool.

Copyright

2019 Mihail Geshoski

License

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

Member Function Documentation

render_print_book_chapter()

booktool_print\output\renderer::render_print_book_chapter	(		$chapter,
			$chapters,
			$book,
			$cm )

Render the print book chapter.

Parameters

object	$chapter	The book chapter object
array	$chapters	The array of book chapters
object	$book	The book object
object	$cm	The course module object

Return values

array

The array containing the content of the book chapter and visibility information

render_print_book_chapter_dialog_link()

booktool_print\output\renderer::render_print_book_chapter_dialog_link

(

)

Render the print book chapter link.

Return values

string

html for the link

render_print_book_chapter_page()

booktool_print\output\renderer::render_print_book_chapter_page

(

print_book_chapter_page

$page

)

Render the print book chapter page.

Parameters

print_book_chapter_page

$page

Return values

string

html for the page

Exceptions

moodle_exception

render_print_book_dialog_link()

booktool_print\output\renderer::render_print_book_dialog_link

(

)

Render the print book link.

Return values

string

html for the link

render_print_book_page()

booktool_print\output\renderer::render_print_book_page

(

print_book_page

$page

)

Render the print book page.

Parameters

print_book_page

$page

Return values

string

html for the page

Exceptions

moodle_exception

render_print_book_toc()

booktool_print\output\renderer::render_print_book_toc	(		$chapters,
			$book,
			$cm )

Render the print book table of contents.

Parameters

array	$chapters	Array of book chapters
object	$book	The book object
object	$cm	The curse module object

Return values

string

html for the TOC

---

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

• mod/book/tool/print/classes/output/renderer.php