Open Journal Systems  3.3.0
SubmissionFilesGridHandler Class Reference
Inheritance diagram for SubmissionFilesGridHandler:
GridHandler PKPHandler FileListGridHandler AuthorOpenReviewAttachmentsGridHandler AuthorReviewAttachmentsGridHandler AuthorReviewRevisionsGridHandler AuthorSubmissionDetailsFilesGridHandler CopyeditFilesGridHandler DependentFilesGridHandler EditorReviewAttachmentsGridHandler EditorReviewFilesGridHandler EditorSubmissionDetailsFilesGridHandler FinalDraftFilesGridHandler ProductionReadyFilesGridHandler QueryNoteFilesGridHandler ReviewerReviewAttachmentsGridHandler ReviewerReviewFilesGridHandler SelectableFileListGridHandler SubmissionWizardFilesGridHandler WorkflowReviewRevisionsGridHandler

Public Member Functions

 __construct ($dataProvider, $stageId, $capabilities=0)
 
 authorize ($request, &$args, $roleAssignments)
 
 getCapabilities ()
 
 getFilesToDownload ($request)
 
 getFilterSelectionData ($request)
 
 getStageId ()
 
 getSubmission ()
 
 initialize ($request, $args=null)
 
 renderFilter ($request, $filterData=array())
 
 setCapabilities ($capabilities)
 
- Public Member Functions inherited from GridHandler
 __construct ($dataProvider=null)
 
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn ($column)
 
 fetchCell (&$args, $request)
 
 fetchGrid ($args, $request)
 
 fetchRow ($args, $request)
 
 fetchRows ($args, $request)
 
 getActions ($position=GRID_ACTION_POSITION_ABOVE)
 
 getColumn ($columnId)
 
getColumns ()
 
getColumnsByFlag ($flag)
 
 getColumnsCount ($flag=null)
 
 getDataElementSequence ($gridDataElement)
 
 getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 
 getIsSubcomponent ()
 
 getItemIterator ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestArgs ()
 
 getRequestedRow ($request, $args)
 
 getSelectName ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 isDataElementSelected ($gridDataElement)
 
 renderRow ($request, $row)
 
 saveSequence ($args, $request)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 setEmptyRowText ($emptyRowText)
 
 setFootNote ($footNote)
 
 setGridDataElements ($data)
 
 setTemplate ($template)
 
 setTitle ($title)
 
 setUrls ($request, $extraUrls=array())
 
- Public Member Functions inherited from PKPHandler
 __construct ()
 
 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)
 

Data Fields

 $_capabilities
 
 $_stageId
 
- Data Fields inherited from GridHandler
 $_actions = array(GRID_ACTION_POSITION_DEFAULT => array())
 
 $_columns = array()
 
 $_constants = []
 
 $_data
 
 $_dataProvider
 
 $_emptyRowText = 'grid.noItems'
 
 $_features
 
 $_footNote = ''
 
 $_itemIterator
 
 $_template
 
 $_title = ''
 
 $_urls
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 

Protected Member Functions

 getFilterColumns ()
 
 getFilterForm ()
 
 getRowInstance ()
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getRowDataElement ($request, &$rowId)
 
 getRowsSequence ($request)
 
 initFeatures ($request, $args)
 
 isFilterFormCollapsible ()
 
 loadData ($request, $filter)
 
 noAutocompleteResults ()
 
 renderGridBodyPartsInternally ($request)
 
 renderRowInternally ($request, $row)
 
 renderRowsInternally ($request, &$elements)
 
 setFirstDataColumn ()
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle submission file grid requests.

Definition at line 30 of file SubmissionFilesGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SubmissionFilesGridHandler::__construct (   $dataProvider,
  $stageId,
  $capabilities = 0 
)

Constructor

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

Reimplemented in FileListGridHandler, and SelectableFileListGridHandler.

Definition at line 51 of file SubmissionFilesGridHandler.inc.php.

Member Function Documentation

◆ authorize()

SubmissionFilesGridHandler::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.
Returns
boolean

Reimplemented from GridHandler.

Reimplemented in LimitReviewFilesGridHandler.

Definition at line 106 of file SubmissionFilesGridHandler.inc.php.

References GridHandler\getDataProvider(), and getStageId().

◆ getCapabilities()

SubmissionFilesGridHandler::getCapabilities ( )

◆ getFilesToDownload()

SubmissionFilesGridHandler::getFilesToDownload (   $request)

Definition at line 222 of file SubmissionFilesGridHandler.inc.php.

References GridHandler\getGridDataElements().

Referenced by initialize().

◆ getFilterColumns()

SubmissionFilesGridHandler::getFilterColumns ( )
protected

Get which columns can be used by users to filter data.

Returns
Array

Definition at line 201 of file SubmissionFilesGridHandler.inc.php.

Referenced by renderFilter().

◆ getFilterForm()

SubmissionFilesGridHandler::getFilterForm ( )
protected

@copyDoc GridHandler::getFilterForm()

Reimplemented from GridHandler.

Definition at line 170 of file SubmissionFilesGridHandler.inc.php.

◆ getFilterSelectionData()

SubmissionFilesGridHandler::getFilterSelectionData (   $request)

@copyDoc GridHandler::getFilterSelectionData()

Reimplemented from GridHandler.

Definition at line 190 of file SubmissionFilesGridHandler.inc.php.

◆ getRowInstance()

SubmissionFilesGridHandler::getRowInstance ( )
protected

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

Returns
GridRow

Reimplemented from GridHandler.

Definition at line 214 of file SubmissionFilesGridHandler.inc.php.

References getCapabilities(), and getStageId().

◆ getStageId()

SubmissionFilesGridHandler::getStageId ( )

Get the workflow stage id.

Returns
integer

Definition at line 84 of file SubmissionFilesGridHandler.inc.php.

References $_stageId.

Referenced by authorize(), getRowInstance(), and initialize().

◆ getSubmission()

◆ initialize()

◆ renderFilter()

SubmissionFilesGridHandler::renderFilter (   $request,
  $filterData = array() 
)

@copyDoc GridHandler::renderFilter()

Reimplemented from GridHandler.

Definition at line 177 of file SubmissionFilesGridHandler.inc.php.

References getFilterColumns(), and PKPHandler\getId().

◆ setCapabilities()

SubmissionFilesGridHandler::setCapabilities (   $capabilities)

Set grid capabilities object.

Parameters
$capabilitiesFilesGridCapabilities

Definition at line 76 of file SubmissionFilesGridHandler.inc.php.

Referenced by CopyeditFilesGridHandler\initialize().

Field Documentation

◆ $_capabilities

FilesGridCapabilities SubmissionFilesGridHandler::$_capabilities

Definition at line 36 of file SubmissionFilesGridHandler.inc.php.

Referenced by getCapabilities().

◆ $_stageId

integer SubmissionFilesGridHandler::$_stageId

Definition at line 42 of file SubmissionFilesGridHandler.inc.php.

Referenced by getStageId().


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