MarkupHandler Class Reference

Inheritance diagram for MarkupHandler:

Public Member Functions
	__construct ()
	authorize ($request, &$args, $roleAssignments)
	batch ($args, $request)
	convertToXml ($args, $request)
	fetchConversionJobStatus ($args, $request)
	generateGalleyFiles ($args, $request)
	media ($args, $request)
	profile ($args, $request)
	triggerConversion ($args, $request)
Public Member Functions inherited from PKPHandler
	addPolicy ($authorizationPolicy, $addToTop=false)
	addRoleAssignment ($roleIds, $operations)
	getApiToken ()
&	getAuthorizedContext ()
&	getAuthorizedContextObject ($assocType)
&	getDispatcher ()
	getFirstUserContext ($user, $contexts)
	getId ()
	getLastAuthorizationMessage ()
	getRoleAssignment ($roleId)
	getRoleAssignments ()
	getSiteRedirectContext ($request)
	getTargetContext ($request, &$contextsCount=null)
	index ($args, $request)
	initialize ($request)
	markRoleAssignmentsChecked ()
	requireSSL ()
	setApiToken ($apiToken)
	setDispatcher ($dispatcher)
	setEnforceRestrictedSite ($enforceRestrictedSite)
	setId ($id)
	setupTemplate ($request)
	validate ($requiredContexts=null, $request=null)

Protected Member Functions
	_conversion ($args, $request, $params)

Protected Attributes
	$_plugin
Protected Attributes inherited from PKPHandler
	$_apiToken = null

Additional Inherited Members
Static Public Member Functions inherited from PKPHandler
static	getPageParamName ($rangeName)
static	getRangeInfo ($request, $rangeName, $contextData=null)
static	hashPageContext ($request, $contextData=array())
Data Fields inherited from PKPHandler
	$_authorizationDecisionManager
	$_checks = array()
	$_dispatcher
	$_enforceRestrictedSite = true
	$_id
	$_isBackendPage = false
	$_roleAssignments = array()
	$_roleAssignmentsChecked = false

Detailed Description

Handle requests for markup plugin.

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

Constructor & Destructor Documentation

__construct()

MarkupHandler::__construct

(

)

Constructor

Reimplemented from PKPHandler.

Definition at line 28 of file MarkupHandler.inc.php.

References PKPHandler\addRoleAssignment(), and PluginRegistry\getPlugin().

Member Function Documentation

_conversion()

MarkupHandler::_conversion (   $args,   $request,   $params  )

protected

Parameters

$args	array
$request	PKPRequest
$params	array

Returns

JSONMessage

Definition at line 102 of file MarkupHandler.inc.php.

References MarkupConversionHelper\canUseCredentialsFromConfig(), PKPHandler\getAuthorizedContextObject(), PKPTemplateManager\getManager(), MarkupConversionHelper\readCredentialsFromConfig(), and PKPLocale\requireComponents().

Referenced by convertToXml(), and generateGalleyFiles().

authorize()

MarkupHandler::authorize	(		$request,
		&	$args,
			$roleAssignments
	)

Authorize this request.

Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.

NB: This method will be called once for every request only.

Parameters

$request	Request
$args	array request arguments
$roleAssignments	array the operation role assignment, see getRoleAssignment() for more details.

Returns

boolean

Reimplemented from PKPHandler.

Definition at line 46 of file MarkupHandler.inc.php.

References $op, and PKPHandler\addPolicy().

batch()

MarkupHandler::batch	(		$args,
			$request
	)

Display batch conversion page

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage

Definition at line 263 of file MarkupHandler.inc.php.

References PKPTemplateManager\getManager(), and PKPLocale\requireComponents().

convertToXml()

MarkupHandler::convertToXml	(		$args,
			$request
	)

Triggers a job on xml server to convert a dox/pdf document to xml

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage

Definition at line 69 of file MarkupHandler.inc.php.

References _conversion().

fetchConversionJobStatus()

MarkupHandler::fetchConversionJobStatus	(		$args,
			$request
	)

fetch xml job status

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage

Definition at line 192 of file MarkupHandler.inc.php.

References DAORegistry\getDAO(), XMLPSWrapper\JOB_STATUS_COMPLETED, and XMLPSWrapper\JOB_STATUS_FAILED.

generateGalleyFiles()

MarkupHandler::generateGalleyFiles	(		$args,
			$request
	)

Triggers a job on xml server to generate galley files

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage

Definition at line 86 of file MarkupHandler.inc.php.

References _conversion().

media()

MarkupHandler::media	(		$args,
			$request
	)

display images attached to XML document

Parameters

$args	array
$request	PKPRequest

Returns

void

Definition at line 306 of file MarkupHandler.inc.php.

References fatalError(), PKPHandler\getAuthorizedContextObject(), and DAORegistry\getDAO().

profile()

MarkupHandler::profile	(		$args,
			$request
	)

Display login credentials form in case of user specific authentication

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage

Definition at line 231 of file MarkupHandler.inc.php.

References PKPTemplateManager\getManager(), and PKPLocale\requireComponents().

triggerConversion()

MarkupHandler::triggerConversion	(		$args,
			$request
	)

Trigger a job on xml server

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage

Definition at line 154 of file MarkupHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), PKPTemplateManager\getManager(), and PKPLocale\requireComponents().

Field Documentation

$_plugin

MarkupPlugin MarkupHandler::$_plugin

protected

The Document markup plugin

Definition at line 23 of file MarkupHandler.inc.php.

---

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

• MarkupHandler.inc.php