Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
booktool_print

Namespaces

namespace  booktool_print\event
  
 
namespace  booktool_print\output
  
 
namespace  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.
 
 booktool_print_get_toc ()
 
 booktool_print_get_view_actions ()
 Return read actions.
 

Variables

 $capabilities
 
 $logs
 
 $plugin = 2023041800
 
$plugin component = 'booktool_print'
 
$plugin version = 2023042400
 

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$settingsThe settings navigation object
navigation_node$nodeThe node to add module settings to

◆ booktool_print_get_toc()

booktool_print_get_toc ( )
Deprecated
since Moodle 3.7

◆ 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,
)
),
)
const CAP_ALLOW
Allow permission, overrides CAP_PREVENT defined in parent contexts.
Definition accesslib.php:115
const CONTEXT_MODULE
Course module context level - one instance for each course module.
Definition accesslib.php:130

◆ $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')
)