booktool_print

Files
file	access.php
	Book module capability definition.
file	book_printed.php
	booktool_print book printed event.
file	chapter_printed.php
	booktool_print chapter printed event.
file	lib.php
	Print lib.
file	locallib.php
	Book print lib.
file	log.php
	Print booktool log events definition.
file	print_book_chapter_page.php
	Class containing data for the view book page.
file	print_book_page.php
	Class containing data for the view book page.
file	provider.php
	Privacy provider implementation for booktool_print.
file	renderer.php
	Defines the renderer for the book print tool.
file	version.php
	Book print plugin version info.

Namespaces
	booktool_print\event
	booktool_print\output
	booktool_print\privacy

Classes
class	booktool_print\event\book_printed
	booktool_print book printed event class. More...
class	booktool_print\event\chapter_printed
	booktool_print chapter printed event class. More...
class	booktool_print\output\print_book_chapter_page
	Class containing data for the print book page. More...
class	booktool_print\output\print_book_page
	Class containing data for the print book page. More...
class	booktool_print\output\renderer
	The renderer for the book print tool. More...
class	booktool_print\privacy\provider
	Privacy provider implementation for booktool_print. More...

Functions
	booktool_print_extend_settings_navigation (settings_navigation $settings, navigation_node $node)
	Adds module specific settings to the settings block. More...
	booktool_print_get_toc ($chapters, $book, $cm)
	Generate toc structure and titles. More...
	booktool_print_get_view_actions ()
	Return read actions. More...

Variables
	$capabilities
	$logs
$plugin	component = 'booktool_print'
$plugin	requires = 2019111200
$plugin	version = 2019111800

Detailed Description

Function Documentation

booktool_print_extend_settings_navigation()

booktool_print_extend_settings_navigation	(	settings_navigation	$settings,
		navigation_node	$node
	)

Adds module specific settings to the settings block.

Parameters

settings_navigation	$settings	The settings navigation object
navigation_node	$node	The node to add module settings to

booktool_print_get_toc()

booktool_print_get_toc	(		$chapters,
			$book,
			$cm
	)

Generate toc structure and titles.

Deprecated:

since Moodle 3.7

Parameters

array	$chapters
stdClass	$book
stdClass	$cm

Return values

array

booktool_print_get_view_actions()

booktool_print_get_view_actions

(

)

Return read actions.

Note: This is not used by new logging system. Event with crud = 'r' and edulevel = LEVEL_PARTICIPATING will be considered as view action.

Return values

array

Variable Documentation

$capabilities

$capabilities

Initial value:

= array(
    'booktool/print:print' => array(
        'captype' => 'read',
        'contextlevel' => CONTEXT_MODULE,
        'archetypes' => array(
            'guest' => CAP_ALLOW,
            'frontpage' => CAP_ALLOW,
            'student' => CAP_ALLOW,
            'teacher' => CAP_ALLOW,
            'editingteacher' => CAP_ALLOW,
            'manager' => CAP_ALLOW,
        )
    ),
)

$logs

$logs

Initial value:

= array(
    array('module' => 'book', 'action' => 'print', 'mtable' => 'book', 'field' => 'name'),
    array('module' => 'book', 'action' => 'print chapter', 'mtable' => 'book_chapters', 'field' => 'title')
)