ManageFileApiHandler Class Reference

Inheritance diagram for ManageFileApiHandler:

Public Member Functions
	__construct ()
	clearPubId ($args, $request)
	detachEntities ($submissionFile, $submissionId, $stageId)
	identifiers ($args, $request)
	logDeletionEvent ($request, $submission, $submissionFile, $user)
	removeFileIndex ($submission, $submissionFile)
	updateIdentifiers ($args, $request)
Public Member Functions inherited from PKPManageFileApiHandler
	authorize ($request, &$args, $roleAssignments)
	deleteFile ($args, $request)
	editMetadata ($args, $request)
	editMetadataTab ($args, $request)
	getFileManager ($contextId, $submissionId)
	saveMetadata ($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)

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
Protected Member Functions inherited from PKPManageFileApiHandler
	getUpdateNotifications ()
Protected Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Class defining an AJAX API for file manipulation.

Definition at line 20 of file ManageFileApiHandler.inc.php.

Constructor & Destructor Documentation

__construct()

ManageFileApiHandler::__construct

(

)

Constructor.

Reimplemented from PKPManageFileApiHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

clearPubId()

ManageFileApiHandler::clearPubId	(		$args,
			$request
	)

Clear proof submission file pub id.

Parameters

$args	array
$request	Request

Returns

JSONMessage JSON object

Definition at line 74 of file ManageFileApiHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

detachEntities()

ManageFileApiHandler::detachEntities	(		$submissionFile,
			$submissionId,
			$stageId
	)

Detach any dependent entities to this file upload.

Parameters

$submissionFile	SubmissionFile
$submissionId	integer
$stageId	integer

Reimplemented from PKPManageFileApiHandler.

Definition at line 129 of file ManageFileApiHandler.inc.php.

References DAORegistry\getDAO().

identifiers()

ManageFileApiHandler::identifiers	(		$args,
			$request
	)

Edit proof submission file pub ids.

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage JSON object

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

References PKPHandler\getAuthorizedContextObject().

logDeletionEvent()

ManageFileApiHandler::logDeletionEvent	(		$request,
			$submission,
			$submissionFile,
			$user
	)

logs the deletion event using app-specific logging classes.

Parameters

$request	PKPRequest
$submission	Submission
$submissionFile	SubmissionFile
$user	User

Reimplemented from PKPManageFileApiHandler.

Definition at line 107 of file ManageFileApiHandler.inc.php.

References SubmissionFileLog\logEvent(), and SubmissionLog\logEvent().

removeFileIndex()

ManageFileApiHandler::removeFileIndex	(		$submission,
			$submissionFile
	)

Remove the submission file index.

Parameters

$submission	Submission
$submissionFile	SubmissionFile

Reimplemented from PKPManageFileApiHandler.

Definition at line 91 of file ManageFileApiHandler.inc.php.

References Application\getSubmissionSearchIndex().

updateIdentifiers()

ManageFileApiHandler::updateIdentifiers	(		$args,
			$request
	)

Update proof submission file pub ids.

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage JSON object

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

References PKPHandler\getAuthorizedContextObject(), and DAO\getDataChangedEvent().

---

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

• ManageFileApiHandler.inc.php