Inheritance diagram for MarkupGatewayPlugin:

Public Member Functions
	__construct ($parentPluginName)

	_process ($submissionFile, $fileStage, $target)

	fetch ($args, $request)

	getCssPath ()

	getDescription ()

	getDisplayName ()

	getEnabled ()

	getHideManagement ()

	getJsPath ()

	getManagementVerbs ()

&	getMarkupPlugin ()

	getName ()

	getPluginPath ()

	getTemplatePath ()

Public Member Functions inherited from GatewayPlugin
	getCanDisable ()

	getCanEnable ()

	getCurrentContextId ()

	getPolicies ($request)

	setEnabled ($enabled)

Public Member Functions inherited from Plugin
	__construct ()

	_overridePluginTemplates ($hookName, $args)

	addLocaleData ($locale=null)

	getActions ($request, $actionArgs)

	getCategory ()

	getContextSpecificPluginSettingsFile ()

	getCurrentVersion ()

	getDirName ()

	getInstallControlledVocabFiles ()

	getInstallDataFile ()

	getInstallEmailTemplateDataFile ()

	getInstallEmailTemplatesFile ()

	getInstallFilterConfigFiles ()

	getInstallMigration ()

	getInstallSchemaFile ()

	getInstallSitePluginSettingsFile ()

	getLocaleFilename ($locale)

&	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)

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

	smartyPluginUrl ($params, $smarty)

	updateSchema ($hookName, $args)

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

Protected Member Functions
	_initXMLPSWrapper ($request)

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

Protected Attributes
	$_fileId = null

	$_jobId = null

	$_parentPluginName = null

	$_plugin = null

	$_stageId = null

	$_user = null

	$_xmlpsWrapper = null

Additional Inherited Members
Data Fields inherited from Plugin
	$pluginCategory

	$pluginPath

	$request

Detailed Description

Responds to requests for markup files for particular journal article; sends request to markup an article to Document Markup Server.

Definition at line 19 of file MarkupGatewayPlugin.inc.php.

Constructor & Destructor Documentation

◆ __construct()

MarkupGatewayPlugin::__construct ( $parentPluginName )

Definition at line 63 of file MarkupGatewayPlugin.inc.php.

References PluginRegistry\getPlugin().

Member Function Documentation

◆ _initXMLPSWrapper()

MarkupGatewayPlugin::_initXMLPSWrapper ( $request )

protected

Initialize xmlps wrapper

Returns: void

Definition at line 75 of file MarkupGatewayPlugin.inc.php.

References Plugin\$request, and MarkupConversionHelper\getOTSWrapperInstance().

Referenced by fetch().

◆ _process()

MarkupGatewayPlugin::_process	(	$submissionFile,
		$fileStage,
		$target
	)

Takes care of document markup conversion

Parameters

$submissionFile	mixed SubmissionFile
$fileStage	int Submission stage ID
$target	string Job target (xml-conversion or galley-generate)

Returns: void

Definition at line 292 of file MarkupGatewayPlugin.inc.php.

References DAORegistry\getDAO(), and Plugin\getRequest().

Referenced by fetch().

◆ fetch()

MarkupGatewayPlugin::fetch	(	$args,
		$request
	)

Handles URL requests to trigger document markup processing for given submission;

Accepted parameters: fileId/[int],

Parameters

$args Array of url arguments

Returns: void

Reimplemented from GatewayPlugin.

Definition at line 199 of file MarkupGatewayPlugin.inc.php.

References Plugin\$request, _initXMLPSWrapper(), _process(), fatalError(), DAORegistry\getDAO(), getEnabled(), Plugin\getRequest(), and MarkupConversionHelper\validateAccessToken().

◆ getCssPath()

MarkupGatewayPlugin::getCssPath ( )

Overwrite the JS path with the parent's JS path

Returns: string CSS path

Definition at line 155 of file MarkupGatewayPlugin.inc.php.

References getMarkupPlugin().

◆ getDescription()

MarkupGatewayPlugin::getDescription ( )

Get plugin description

Returns: string Plugin description

Reimplemented from Plugin.

Definition at line 117 of file MarkupGatewayPlugin.inc.php.

◆ getDisplayName()

MarkupGatewayPlugin::getDisplayName ( )

Get plugin display name

Returns: string Plugin display name

Reimplemented from Plugin.

Definition at line 108 of file MarkupGatewayPlugin.inc.php.

◆ getEnabled()

MarkupGatewayPlugin::getEnabled ( )

Get whether or not this plugin is enabled. (Should always return true, as the parent plugin will take care of loading this one when needed)

Returns: boolean

Reimplemented from GatewayPlugin.

Definition at line 175 of file MarkupGatewayPlugin.inc.php.

References getMarkupPlugin().

Referenced by fetch().

◆ getHideManagement()

MarkupGatewayPlugin::getHideManagement ( )

Hide this plugin from the management interface

Returns: bool true

Reimplemented from Plugin.

Definition at line 89 of file MarkupGatewayPlugin.inc.php.

◆ getJsPath()

MarkupGatewayPlugin::getJsPath ( )

Overwrite the JS path with the parent's JS path

Returns: string JS path

Definition at line 165 of file MarkupGatewayPlugin.inc.php.

References getMarkupPlugin().

◆ getManagementVerbs()

MarkupGatewayPlugin::getManagementVerbs ( )

Get the management verbs for this plugin (override to none so that the parent plugin can handle this)

Returns: array

Definition at line 185 of file MarkupGatewayPlugin.inc.php.

◆ getMarkupPlugin()

& MarkupGatewayPlugin::getMarkupPlugin ( )

Get the parent plugin

Returns: MarkupPlugin Markup plugin object

Definition at line 126 of file MarkupGatewayPlugin.inc.php.

References $_plugin.

Referenced by getCssPath(), getEnabled(), getJsPath(), getPluginPath(), and getTemplatePath().

◆ getName()

MarkupGatewayPlugin::getName ( )

Get the name of this plugin. The name must be unique within its category.

Returns: string Name of plugin

Reimplemented from Plugin.

Definition at line 99 of file MarkupGatewayPlugin.inc.php.

◆ getPluginPath()

MarkupGatewayPlugin::getPluginPath ( )

Overwrite plugin path with parent's plugin path

Returns: string Plugin path

Reimplemented from Plugin.

Definition at line 135 of file MarkupGatewayPlugin.inc.php.

References getMarkupPlugin().

◆ getTemplatePath()

MarkupGatewayPlugin::getTemplatePath ( )

Overwrite the template path with the parent's template path

Returns: string Template path

Definition at line 145 of file MarkupGatewayPlugin.inc.php.

References getMarkupPlugin().

Field Documentation

◆ $_fileId

$fileId MarkupGatewayPlugin::$_fileId = null

protected

int submission file id

Definition at line 49 of file MarkupGatewayPlugin.inc.php.

◆ $_jobId

$jobId MarkupGatewayPlugin::$_jobId = null

protected

string job identifier

Definition at line 61 of file MarkupGatewayPlugin.inc.php.

◆ $_parentPluginName

$parentPluginName MarkupGatewayPlugin::$_parentPluginName = null

protected

string Name of parent plugin

Definition at line 25 of file MarkupGatewayPlugin.inc.php.

◆ $_plugin

$plugin MarkupGatewayPlugin::$_plugin = null

protected

MarkupPlugin Reference to markup plugin

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

Referenced by getMarkupPlugin().

◆ $_stageId

$stage MarkupGatewayPlugin::$_stageId = null

protected

int submission stage

Definition at line 55 of file MarkupGatewayPlugin.inc.php.

◆ $_user

$user MarkupGatewayPlugin::$_user = null

protected

User user object

Definition at line 31 of file MarkupGatewayPlugin.inc.php.

◆ $_xmlpsWrapper

$xmlpsWrapper MarkupGatewayPlugin::$_xmlpsWrapper = null

protected

XMLPSWrapper Reference to wrapper class for OTS Service

Definition at line 43 of file MarkupGatewayPlugin.inc.php.

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

MarkupGatewayPlugin.inc.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _initXMLPSWrapper()

◆ _process()

◆ fetch()

◆ getCssPath()

◆ getDescription()

◆ getDisplayName()

◆ getEnabled()

◆ getHideManagement()

◆ getJsPath()

◆ getManagementVerbs()

◆ getMarkupPlugin()

◆ getName()

◆ getPluginPath()

◆ getTemplatePath()

Field Documentation

◆ $_fileId

◆ $_jobId

◆ $_parentPluginName

◆ $_plugin

◆ $_stageId

◆ $_user

◆ $_xmlpsWrapper