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

Public Member Functions

 authorize ($request, &$args, $roleAssignments)
 
 FileManagementHandler ()
 
 getStageId ()
 
getSubmission ()
 
 initialize ($request, $args)
 
- 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

An abstract class that handles common functionality for controllers that manage files.

Definition at line 19 of file FileManagementHandler.inc.php.

Member Function Documentation

FileManagementHandler::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
$requestRequest
$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
$enforceRestrictedSiteboolean True iff site restrictions are to be enforced
Returns
boolean

Definition at line 33 of file FileManagementHandler.inc.php.

References PKPHandler\addPolicy().

FileManagementHandler::FileManagementHandler ( )

Constructor

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

FileManagementHandler::getStageId ( )

Get the authorized workflow stage.

Returns
integer One of the WORKFLOW_STAGE_ID_* constants.

Definition at line 66 of file FileManagementHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

& FileManagementHandler::getSubmission ( )

The submission to which we upload files.

Returns
Submission

Definition at line 57 of file FileManagementHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

FileManagementHandler::initialize (   $request,
  $args 
)
See Also
PKPHandler::initialize()

Definition at line 45 of file FileManagementHandler.inc.php.


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