Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
SubmissionFilesGridHandler Class Reference
Inheritance diagram for SubmissionFilesGridHandler:
GridHandler PKPHandler FileListGridHandler FileSignoffGridHandler ProductionReadyFilesGridHandler AuthorReviewAttachmentsGridHandler AuthorSubmissionDetailsFilesGridHandler DependentFilesGridHandler EditorReviewAttachmentsGridHandler EditorReviewFilesGridHandler EditorSubmissionDetailsFilesGridHandler FinalDraftFilesGridHandler ReviewerReviewAttachmentsGridHandler ReviewerReviewFilesGridHandler SelectableFileListGridHandler SubmissionDetailsFilesGridHandler SubmissionWizardFilesGridHandler FairCopyFilesGridHandler ReviewRevisionsGridHandler

Public Member Functions

 authorize ($request, &$args, $roleAssignments)
 getCapabilities ()
 getRowInstance ()
 getStageId ()
getSubmission ()
 initialize ($request)
 SubmissionFilesGridHandler (&$dataProvider, $stageId, $capabilities)
- Public Member Functions inherited from GridHandler
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 addColumn ($column)
 authorize ($request, &$args, $roleAssignments, $enforceRestrictedSite=true)
 fetchCell (&$args, $request)
 fetchGrid ($args, $request)
 fetchRow (&$args, $request)
 getActions ($position=GRID_ACTION_POSITION_ABOVE)
 getColumn ($columnId)
getColumns ()
getColumnsByFlag ($flag)
 getColumnsCount ($flag)
 getDataElementSequence (&$gridDataElement)
 getDataProvider ()
 getEmptyRowText ()
 getFeatures ()
 getFootNote ()
getGridDataElements ($request)
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 getInstructions ()
 getIsSubcomponent ()
 getItemIterator ()
 getJSHandler ()
 getPublishChangeEvents ()
 getRequestArg ($key)
 getRequestArgs ()
 getRequestedRow ($request, $args)
 getSelectName ()
 getTemplate ()
 getTitle ()
 getUrls ()
 GridHandler ($dataProvider=null)
 hasColumn ($columnId)
 hasGridDataElements ($request)
 initialize ($request, $args=null)
 isDataElementSelected ($gridDataElement)
 renderRow ($request, $row)
 saveSequence ($args, $request)
 setDataElementSequence ($request, $rowId, &$gridDataElement, $newSequence)
 setEmptyRowText ($emptyRowText)
 setFootNote ($footNote)
 setGridDataElements ($data)
 setInstructions ($instructions)
 setTemplate ($template)
 setTitle ($title)
 setUrls ($request, $extraUrls=array())
- 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 GridHandler
 $_actions = array(GRID_ACTION_POSITION_DEFAULT => array())
 $_columns = array()
 $_emptyRowText = 'grid.noItems'
 $_footNote = ''
 $_instructions = ''
 $_title = ''
- Public Attributes inherited from PKPHandler
 $_checks = array()
 $_roleAssignments = array()
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 doSpecificFetchGridActions ($args, $request, $templateMgr)
getDataElementFromRequest ($request, &$elementId)
 getFilterForm ()
 getFilterSelectionData ($request)
 getRowDataElement ($request, $rowId)
 getRowInstance ()
 getRowsSequence ($request)
 initFeatures ($request, &$args)
 loadData ($request, $filter)
 noAutocompleteResults ()
 renderFilter ($request, $filterData=array())
 renderGridBodyPartsInternally ($request)
 renderRowInternally ($request, $row)
 renderRowsInternally ($request, &$elements)
 setFirstDataColumn ()

Detailed Description

Handle submission file grid requests.

Definition at line 29 of file

Member Function Documentation

SubmissionFilesGridHandler::authorize (   $request,

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.

$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
$enforceRestrictedSiteboolean True iff site restrictions are to be enforced

Definition at line 97 of file

SubmissionFilesGridHandler::getCapabilities ( )
SubmissionFilesGridHandler::getRowInstance ( )

Get a new instance of a grid row. May be overridden by subclasses if they want to provide a custom row definition.


Definition at line 160 of file

References GridHandler\getGridDataElements().

SubmissionFilesGridHandler::getStageId ( )

Get the workflow stage id.


Definition at line 75 of file

Referenced by getSubmission().

& SubmissionFilesGridHandler::getSubmission ( )
SubmissionFilesGridHandler::initialize (   $request)

Subclasses can override this method to configure the handler.

NB: This method will be called after validation and authorization.


Definition at line 115 of file

SubmissionFilesGridHandler::SubmissionFilesGridHandler ( $dataProvider,


$stageIdinteger One of the WORKFLOW_STAGE_ID_* constants.
$capabilitiesinteger A bit map with zero or more FILE_GRID_* capabilities set.

Definition at line 50 of file

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