MarkupBatchConversionHandler Class Reference

Inheritance diagram for MarkupBatchConversionHandler:

Public Member Functions
	__construct ()
	authorize ($request, &$args, $roleAssignments)
	cancelConversion ($args, $request)
	fetchConversionStatus ($args, $request)
	filesToConvert ($args, $request)
	startConversion ($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 Attributes
	$_plugin = null
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

Handles request for articles batch conversion.

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

Constructor & Destructor Documentation

__construct()

MarkupBatchConversionHandler::__construct

(

)

Constructor

Reimplemented from PKPHandler.

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

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

Member Function Documentation

authorize()

MarkupBatchConversionHandler::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 43 of file MarkupBatchConversionHandler.inc.php.

References $op, and PKPHandler\addPolicy().

cancelConversion()

MarkupBatchConversionHandler::cancelConversion	(		$args,
			$request
	)

Stops running batch conversion

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage

Definition at line 182 of file MarkupBatchConversionHandler.inc.php.

fetchConversionStatus()

MarkupBatchConversionHandler::fetchConversionStatus	(		$args,
			$request
	)

Returns status for running conversion

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage

Definition at line 147 of file MarkupBatchConversionHandler.inc.php.

filesToConvert()

MarkupBatchConversionHandler::filesToConvert	(		$args,
			$request
	)

Provides the list of files to batch convert given a submission

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage

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

References PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), and AppLocale\getLocale().

startConversion()

MarkupBatchConversionHandler::startConversion	(		$args,
			$request
	)

trigger batch conversion

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage

Definition at line 93 of file MarkupBatchConversionHandler.inc.php.

References MarkupConversionHelper\makeAccessToken().

Field Documentation

$_plugin

MarkupPlugin MarkupBatchConversionHandler::$_plugin = null

protected

The Document markup plugin

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

---

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

• MarkupBatchConversionHandler.inc.php