booktool_print\output\renderer Class Reference

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

Inheritance diagram for booktool_print\output\renderer:

Public Member Functions
	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.

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