booktool_exportimscp

Files
file	access.php
	Book module capability definition.
file	book_exported.php
	booktool_exportimscp book exported event.
file	lib.php
	IMSCP export lib.
file	locallib.php
	Book imscp export lib.
file	log.php
	Export to IMSCP booktool log events definition.
file	provider.php
	Privacy provider implementation for booktool_exportimscp.
file	version.php
	Book IMSCP export plugin version info.

Namespaces
	booktool_exportimscp\event
	booktool_exportimscp\privacy

Classes
class	booktool_exportimscp\event\book_exported
	booktool_exportimscp book exported event class. More...
class	booktool_exportimscp\privacy\provider
	Privacy provider implementation for booktool_exportimscp. More...

Functions
	booktool_exportimscp_build_package ($book, $context)
	Export one book as IMSCP package. More...
	booktool_exportimscp_chapter_content ($chapter, $context)
	Returns the html contents of one book's chapter to be exported as IMSCP. More...
	booktool_exportimscp_extend_settings_navigation (settings_navigation $settings, navigation_node $node)
	Adds module specific settings to the settings block. More...
	booktool_exportimscp_prepare_files ($book, $context)
	Prepare temp area with the files used by book html contents. More...

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

Detailed Description

Function Documentation

booktool_exportimscp_build_package()

booktool_exportimscp_build_package	(		$book,
			$context
	)

Export one book as IMSCP package.

Parameters

stdClass	$book	book instance
context_module	$context

Return values

bool|stored_file

booktool_exportimscp_chapter_content()

booktool_exportimscp_chapter_content	(		$chapter,
			$context
	)

Returns the html contents of one book's chapter to be exported as IMSCP.

Parameters

stdClass	$chapter	the chapter to be exported
context_module	$context	context the chapter belongs to

Return values

string

the contents of the chapter

booktool_exportimscp_extend_settings_navigation()

booktool_exportimscp_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_exportimscp_prepare_files()

booktool_exportimscp_prepare_files	(		$book,
			$context
	)

Prepare temp area with the files used by book html contents.

Parameters

stdClass	$book	book instance
context_module	$context

Variable Documentation

$capabilities

$capabilities

Initial value:

= array(
    'booktool/exportimscp:export' => array(
        'captype' => 'read',
        'contextlevel' => CONTEXT_MODULE
    ),
)

$logs

$logs

Initial value:

= array(
    array('module'=>'book', 'action'=>'exportimscp', 'mtable'=>'book', 'field'=>'name')
)