PdfJsViewerPlugin Class Reference

Inheritance diagram for PdfJsViewerPlugin:

Public Member Functions
	getContextSpecificPluginSettingsFile ()
	getDescription ()
	getDisplayName ()
	issueCallback ($hookName, $args)
	register ($category, $path, $mainContextId=null)
	submissionCallback ($hookName, $args)
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

This plugin enables embedding of the pdf.js viewer for PDF display.

Definition at line 17 of file PdfJsViewerPlugin.inc.php.

Member Function Documentation

getContextSpecificPluginSettingsFile()

PdfJsViewerPlugin::getContextSpecificPluginSettingsFile

(

)

Install default settings on context creation.

Returns

string

Reimplemented from Plugin.

Definition at line 40 of file PdfJsViewerPlugin.inc.php.

References Plugin\getPluginPath().

getDescription()

PdfJsViewerPlugin::getDescription

(

)

Get a description of this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 54 of file PdfJsViewerPlugin.inc.php.

getDisplayName()

PdfJsViewerPlugin::getDisplayName

(

)

Get the display name for this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 47 of file PdfJsViewerPlugin.inc.php.

issueCallback()

PdfJsViewerPlugin::issueCallback	(		$hookName,
			$args
	)

Callback that renders the issue galley.

Parameters

$hookName	string
$args	array

Returns

boolean

Definition at line 119 of file PdfJsViewerPlugin.inc.php.

References $application, Plugin\$request, PKPApplication\get(), PKPTemplateManager\getManager(), and Plugin\getTemplateResource().

register()

PdfJsViewerPlugin::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.

Returns

boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from LazyLoadPlugin.

Definition at line 21 of file PdfJsViewerPlugin.inc.php.

References Plugin\getEnabled(), HookRegistry\register(), and AppLocale\requireComponents().

submissionCallback()

PdfJsViewerPlugin::submissionCallback	(		$hookName,
			$args
	)

Callback that renders the submission galley.

Parameters

$hookName	string
$args	array

Returns

boolean

Definition at line 64 of file PdfJsViewerPlugin.inc.php.

References $application, Plugin\$request, PKPApplication\get(), PKPTemplateManager\getManager(), and Plugin\getTemplateResource().

---

The documentation for this class was generated from the following file:

• PdfJsViewerPlugin.inc.php