Inheritance diagram for HtmlMonographFilePlugin:

Public Member Functions
	_getHTMLContents ($request, $monograph, $publicationFormat, $submissionFile)

	_handleOmpUrl ($matchArray)

	downloadCallback ($hookName, $params)

	getContextSpecificPluginSettingsFile ()

	getDescription ()

	getDisplayName ()

	register ($category, $path, $mainContextId=null)

	viewCallback ($hookName, $params)

Public Member Functions inherited from LazyLoadPlugin
	getCanDisable ()

	getCanEnable ()

	getCurrentContextId ()

	getEnabled ($contextId=null)

	getName ()

	setEnabled ($enabled)

Public Member Functions inherited from Plugin
	__construct ()

	_overridePluginTemplates ($hookName, $args)

	addLocaleData ($locale=null)

	getActions ($request, $actionArgs)

	getCategory ()

	getCurrentVersion ()

	getDirName ()

	getEnabled ()

	getHideManagement ()

	getInstallControlledVocabFiles ()

	getInstallDataFile ()

	getInstallEmailTemplateDataFile ()

	getInstallEmailTemplatesFile ()

	getInstallFilterConfigFiles ()

	getInstallMigration ()

	getInstallSchemaFile ()

	getInstallSitePluginSettingsFile ()

	getLocaleFilename ($locale)

	getPluginPath ()

&	getRequest ()

	getSeq ()

	getSetting ($contextId, $name)

	getTemplatePath ($inCore=false)

	getTemplateResource ($template=null, $inCore=false)

	import ($class)

	installContextSpecificSettings ($hookName, $args)

	installControlledVocabs ($hookName, $args)

	installData ($hookName, $args)

	installEmailTemplateData ($hookName, $args)

	installEmailTemplates ($hookName, $args)

	installFilters ($hookName, $args)

	installLocale ($hookName, $args)

	installSiteSettings ($hookName, $args)

	isSitePlugin ()

	manage ($args, $request)

	smartyPluginUrl ($params, $smarty)

	updateSchema ($hookName, $args)

	updateSetting ($contextId, $name, $value, $type=null)

Additional Inherited Members
Data Fields inherited from Plugin
	$pluginCategory

	$pluginPath

	$request

Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Detailed Description

Class for HtmlMonographFile plugin.

Definition at line 18 of file HtmlMonographFilePlugin.inc.php.

Member Function Documentation

◆ _getHTMLContents()

HtmlMonographFilePlugin::_getHTMLContents	(	$request,
		$monograph,
		$publicationFormat,
		$submissionFile
	)

Return string containing the contents of the HTML file. This function performs any necessary filtering, like image URL replacement.

Parameters

$request	PKPRequest
$monograph	Monograph
$publicationFormat	PublicationFormat
$submissionFile	SubmissionFile

Returns: string

Definition at line 124 of file HtmlMonographFilePlugin.inc.php.

References Plugin\$request, DAORegistry\getDAO(), and PKPTemplateManager\getManager().

Referenced by downloadCallback().

◆ _handleOmpUrl()

HtmlMonographFilePlugin::_handleOmpUrl ( $matchArray )

Definition at line 188 of file HtmlMonographFilePlugin.inc.php.

References Plugin\$request, PKPApplication\get(), and strtolower_codesafe().

◆ downloadCallback()

HtmlMonographFilePlugin::downloadCallback	(	$hookName,
		$params
	)

Callback to rewrite and serve HTML content.

Parameters

string	$hookName
array	$args

Definition at line 97 of file HtmlMonographFilePlugin.inc.php.

References Plugin\$request, _getHTMLContents(), HookRegistry\call(), and PKPApplication\get().

◆ getContextSpecificPluginSettingsFile()

HtmlMonographFilePlugin::getContextSpecificPluginSettingsFile ( )

Install default settings on press creation.

Returns: string

Reimplemented from Plugin.

Definition at line 37 of file HtmlMonographFilePlugin.inc.php.

References Plugin\getPluginPath().

◆ getDescription()

HtmlMonographFilePlugin::getDescription ( )

Get a description of the plugin.

Reimplemented from Plugin.

Definition at line 52 of file HtmlMonographFilePlugin.inc.php.

◆ getDisplayName()

HtmlMonographFilePlugin::getDisplayName ( )

Get the display name of this plugin.

Returns: String

Reimplemented from Plugin.

Definition at line 45 of file HtmlMonographFilePlugin.inc.php.

◆ register()

HtmlMonographFilePlugin::register	(	$category,
		$path,
		$mainContextId = `null`
	)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters

$category	String Name of category plugin was registered to
$path	String The path the plugin was found in
$mainContextId	integer To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.