Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct () | |
authorize ($request, &$args, $roleAssignments) | |
deleteFile ($args, $request) | |
detachEntities ($submissionFile, $submissionId, $stageId) | |
editMetadata ($args, $request) | |
editMetadataTab ($args, $request) | |
getFileManager ($contextId, $submissionId) | |
logDeletionEvent ($request, $submission, $submissionFile, $user) | |
removeFileIndex ($submission, $submissionFile) | |
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) | |
Protected Member Functions | |
getUpdateNotifications () | |
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 Attributes inherited from PKPHandler | |
$_apiToken = null | |
Class defining an AJAX API for file manipulation.
Definition at line 20 of file PKPManageFileApiHandler.inc.php.
PKPManageFileApiHandler::__construct | ( | ) |
Constructor.
Reimplemented from PKPHandler.
Reimplemented in ManageFileApiHandler.
Definition at line 25 of file PKPManageFileApiHandler.inc.php.
References PKPHandler\addRoleAssignment(), and AppLocale\requireComponents().
PKPManageFileApiHandler::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.
$request | Request |
$args | array request arguments |
$roleAssignments | array the operation role assignment, see getRoleAssignment() for more details. |
Reimplemented from PKPHandler.
Definition at line 38 of file PKPManageFileApiHandler.inc.php.
References PKPHandler\addPolicy().
PKPManageFileApiHandler::deleteFile | ( | $args, | |
$request | |||
) |
Delete a file or revision
$args | array |
$request | Request |
Definition at line 54 of file PKPManageFileApiHandler.inc.php.
References PKPNotificationOperationManager\createTrivialNotification(), detachEntities(), PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), getFileManager(), logDeletionEvent(), removeFileIndex(), and PKPHandler\setupTemplate().
PKPManageFileApiHandler::detachEntities | ( | $submissionFile, | |
$submissionId, | |||
$stageId | |||
) |
Detach any dependent entities to this file upload.
$submissionFile | SubmissionFile |
$submissionId | integer |
$stageId | integer |
Reimplemented in ManageFileApiHandler.
Definition at line 276 of file PKPManageFileApiHandler.inc.php.
References DAORegistry\getDAO().
Referenced by deleteFile().
PKPManageFileApiHandler::editMetadata | ( | $args, | |
$request | |||
) |
Edit submission file metadata modal.
$args | array |
$request | Request |
Definition at line 136 of file PKPManageFileApiHandler.inc.php.
References editMetadataTab(), PKPHandler\getAuthorizedContextObject(), and PKPTemplateManager\getManager().
PKPManageFileApiHandler::editMetadataTab | ( | $args, | |
$request | |||
) |
Edit submission file metadata tab.
$args | array |
$request | Request |
Definition at line 154 of file PKPManageFileApiHandler.inc.php.
References PKPHandler\getAuthorizedContextObject().
Referenced by editMetadata().
PKPManageFileApiHandler::getFileManager | ( | $contextId, | |
$submissionId | |||
) |
Get the submission file manager.
$contextId | int the context id. |
$submissionId | int the submission id. |
Definition at line 247 of file PKPManageFileApiHandler.inc.php.
Referenced by deleteFile().
|
protected |
Get the list of notifications to be updated on metadata form submission.
Definition at line 266 of file PKPManageFileApiHandler.inc.php.
Referenced by saveMetadata().
|
abstract |
Logs the deletion event using app-specific logging classes. Must be implemented by subclasses.
$request | PKPRequest |
$submission | Submission |
$submissionFile | SubmissionFile |
$user | User |
Reimplemented in ManageFileApiHandler.
Referenced by deleteFile().
|
abstract |
Remove the submission file index.
$submission | Submission |
$submissionFile | SubmissionFile |
Reimplemented in ManageFileApiHandler.
Referenced by deleteFile().
PKPManageFileApiHandler::saveMetadata | ( | $args, | |
$request | |||
) |
Save the metadata of the latest revision of the requested submission file.
$args | array |
$request | Request |
Definition at line 170 of file PKPManageFileApiHandler.inc.php.
References PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), Application\getSubmissionSearchIndex(), getUpdateNotifications(), and SubmissionLog\logEvent().