Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PKPManageFileApiHandler Class Reference
Inheritance diagram for PKPManageFileApiHandler:
Handler PKPHandler ManageFileApiHandler

Public Member Functions

 deleteFile ($args, $request)
 
 getFileManager ($contextId, $submissionId)
 
 indexSubmissionFiles ($submission, $submissionFile)
 
 logDeletionEvent ($request, $submission, $submissionFile, $user)
 
 PKPManageFileApiHandler ()
 
- Public Member Functions inherited from Handler
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, $bestGuess=true)
 
 getWorkingContexts ($request)
 
 Handler ()
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments, $enforceRestrictedSite=true)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getWorkingContexts ($request)
 
 index ($args, $request)
 
 initialize ($request, $args=null)
 
 PKPHandler ()
 
 setDispatcher ($dispatcher)
 
 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())
 
- Public Attributes inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_id
 
 $_roleAssignments = array()
 

Detailed Description

Class defining an AJAX API for file manipulation.

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

Member Function Documentation

PKPManageFileApiHandler::deleteFile (   $args,
  $request 
)

Delete a file or revision

Parameters
$argsarray
$requestRequest
Returns
string a serialized JSON object

Definition at line 52 of file PKPManageFileApiHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), getFileManager(), indexSubmissionFiles(), logDeletionEvent(), and PKPHandler\setupTemplate().

PKPManageFileApiHandler::getFileManager (   $contextId,
  $submissionId 
)

indexes the files associated with a submission.

Parameters
$contextIdint the context id.
$submissionIdint the submission id.
Returns
SubmissionFileManager

Definition at line 161 of file PKPManageFileApiHandler.inc.php.

Referenced by deleteFile().

PKPManageFileApiHandler::indexSubmissionFiles (   $submission,
  $submissionFile 
)

indexes the files associated with a submission. must be overridden by sub classes.

Parameters
$submissionSubmission
$submissionFileSubmissionFile

Definition at line 151 of file PKPManageFileApiHandler.inc.php.

Referenced by deleteFile().

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

logs the deletion event using app-specific logging classes. Must be overridden by sub classes.

Parameters
$requestPKPRequest
$submissionSubmission
$submissionFileSubmissionFile
$userPKPUser

Definition at line 174 of file PKPManageFileApiHandler.inc.php.

Referenced by deleteFile().

PKPManageFileApiHandler::PKPManageFileApiHandler ( )

Constructor.

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

References PKPHandler\addRoleAssignment().


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