MarkupBatchGatewayPlugin Class Reference

Inheritance diagram for MarkupBatchGatewayPlugin:

Public Member Functions
	__construct ($parentPluginName)
	fetch ($args, $request)
	getDescription ()
	getDisplayName ()
&	getMarkupPlugin ()
	getName ()
	getPluginPath ()
	getSeq ()
Public Member Functions inherited from GatewayPlugin
	getCanDisable ()
	getCanEnable ()
	getCurrentContextId ()
	getEnabled ()
	getPolicies ($request)
	setEnabled ($enabled)
Public Member Functions inherited from Plugin
	__construct ()
	_overridePluginTemplates ($hookName, $args)
	addLocaleData ($locale=null)
	getActions ($request, $actionArgs)
	getCategory ()
	getContextSpecificPluginSettingsFile ()
	getCurrentVersion ()
	getDirName ()
	getHideManagement ()
	getInstallControlledVocabFiles ()
	getInstallDataFile ()
	getInstallEmailTemplateDataFile ()
	getInstallEmailTemplatesFile ()
	getInstallFilterConfigFiles ()
	getInstallMigration ()
	getInstallSchemaFile ()
	getInstallSitePluginSettingsFile ()
	getLocaleFilename ($locale)
&	getRequest ()
	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
	initMarkupConversionHelper ($request, $journal)
Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Protected Attributes
	$_batchConversionHelper = null
	$_markupConversionHelper = null
	$_otsWrapper = null
	$_parentPluginName = null
	$_plugin = null
	$_user = null

Additional Inherited Members
Data Fields inherited from Plugin
	$pluginCategory
	$pluginPath
	$request

Detailed Description

Batch conversion Helper class.

Responds to requests for batch files conversion.

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

Constructor & Destructor Documentation

__construct()

MarkupBatchGatewayPlugin::__construct

(

$parentPluginName

)

Constructor

Parameters

string

$parentPluginName

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

References PluginRegistry\getPlugin().

Member Function Documentation

fetch()

MarkupBatchGatewayPlugin::fetch	(		$args,
			$request
	)

Handles URL requests for sending commands to batch conversion process

Parameters

$args

Array of url arguments

Returns

void

Reimplemented from GatewayPlugin.

Definition at line 146 of file MarkupBatchGatewayPlugin.inc.php.

References $_batchConversionHelper, $_plugin, $_user, Plugin\$request, MarkupConversionHelper\createConversionJobInfo(), fatalError(), DAORegistry\getDAO(), MarkupConversionHelper\getOTSWrapperInstance(), initMarkupConversionHelper(), and MarkupConversionHelper\validateAccessToken().

getDescription()

MarkupBatchGatewayPlugin::getDescription

(

)

Get plugin description

Returns

string Plugin description

Reimplemented from Plugin.

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

getDisplayName()

MarkupBatchGatewayPlugin::getDisplayName

(

)

Get plugin display name

Returns

string Plugin display name

Reimplemented from Plugin.

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

getMarkupPlugin()

& MarkupBatchGatewayPlugin::getMarkupPlugin

(

)

Get the parent plugin

Returns

MarkupPlugin Markup plugin object

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

References $_plugin.

Referenced by getPluginPath().

getName()

MarkupBatchGatewayPlugin::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 90 of file MarkupBatchGatewayPlugin.inc.php.

getPluginPath()

MarkupBatchGatewayPlugin::getPluginPath

(

)

Overwrite plugin path with parent's plugin path

Returns

string Plugin path

Reimplemented from Plugin.

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

References getMarkupPlugin().

getSeq()

MarkupBatchGatewayPlugin::getSeq

(

)

Return a number indicating the sequence in which this plugin should be registered compared to others of its category. Higher = later.

Returns

integer

int

Reimplemented from Plugin.

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

initMarkupConversionHelper()

MarkupBatchGatewayPlugin::initMarkupConversionHelper (   $request,   $journal  )

protected

Creates an instance of markup conversion helper

Parameters

$request	PKPRequest
$journal	Journal

Definition at line 70 of file MarkupBatchGatewayPlugin.inc.php.

References MarkupConversionHelper\getOTSWrapperInstance().

Referenced by fetch().

Field Documentation

$_batchConversionHelper

$helper MarkupBatchGatewayPlugin::$_batchConversionHelper = null

protected

MarkupBatchConversionHelper Batch conversion helper object

Definition at line 34 of file MarkupBatchGatewayPlugin.inc.php.

Referenced by fetch().

$_markupConversionHelper

$helper MarkupBatchGatewayPlugin::$_markupConversionHelper = null

protected

MarkupConversionHelper Markup conversion helper object

Definition at line 29 of file MarkupBatchGatewayPlugin.inc.php.

$_otsWrapper

$otsWrapper MarkupBatchGatewayPlugin::$_otsWrapper = null

protected

XMLPSWrapper Reference to wrapper class for OTS Service

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

$_parentPluginName

$parentPluginName MarkupBatchGatewayPlugin::$_parentPluginName = null

protected

string Name of parent plugin

Definition at line 24 of file MarkupBatchGatewayPlugin.inc.php.

$_plugin

$plugin MarkupBatchGatewayPlugin::$_plugin = null

protected

MarkupPlugin Reference to markup plugin

Definition at line 44 of file MarkupBatchGatewayPlugin.inc.php.

Referenced by fetch(), and getMarkupPlugin().

$_user

$user MarkupBatchGatewayPlugin::$_user = null

protected

User user object

Definition at line 39 of file MarkupBatchGatewayPlugin.inc.php.

Referenced by fetch().

---

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

• MarkupBatchGatewayPlugin.inc.php