Open Journal Systems  3.3.0
SelectableFileListGridHandler Class Reference
Inheritance diagram for SelectableFileListGridHandler:
FileListGridHandler SubmissionFilesGridHandler GridHandler PKPHandler EditorSelectableReviewAttachmentsGridHandler LimitReviewFilesGridHandler SelectableCopyeditFilesGridHandler SelectableFinalDraftFilesGridHandler SelectableReviewRevisionsGridHandler SelectableSubmissionDetailsFilesGridHandler

Public Member Functions

 __construct ($dataProvider, $stageId, $capabilities=0)
 
 getSelectName ()
 
 initFeatures ($request, $args)
 
 isDataElementSelected ($gridDataElement)
 
- Public Member Functions inherited from FileListGridHandler
 initialize ($request, $args=null)
 
- Public Member Functions inherited from SubmissionFilesGridHandler
 authorize ($request, &$args, $roleAssignments)
 
 getCapabilities ()
 
 getFilesToDownload ($request)
 
 getFilterSelectionData ($request)
 
 getStageId ()
 
 getSubmission ()
 
 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)
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 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)
 

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 SubmissionFilesGridHandler
 $_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 inherited from SubmissionFilesGridHandler
 getFilterColumns ()
 
 getFilterForm ()
 
 getRowInstance ()
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getRowDataElement ($request, &$rowId)
 
 getRowsSequence ($request)
 
 isFilterFormCollapsible ()
 
 loadData ($request, $filter)
 
 noAutocompleteResults ()
 
 renderGridBodyPartsInternally ($request)
 
 renderRowInternally ($request, $row)
 
 renderRowsInternally ($request, &$elements)
 
 setFirstDataColumn ()
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Base grid for selectable file lists. The grid use the SelectableItemFeature to show a check box for each row so that the user can make a selection among grid entries.

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

Constructor & Destructor Documentation

◆ __construct()

SelectableFileListGridHandler::__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 from FileListGridHandler.

Definition at line 28 of file SelectableFileListGridHandler.inc.php.

Member Function Documentation

◆ getSelectName()

SelectableFileListGridHandler::getSelectName ( )

Get the select parameter name to store the selected files.

Returns
string

Reimplemented from GridHandler.

Reimplemented in EditorSelectableReviewAttachmentsGridHandler.

Definition at line 59 of file SelectableFileListGridHandler.inc.php.

◆ initFeatures()

SelectableFileListGridHandler::initFeatures (   $request,
  $args 
)

Override to init grid features. This method is called by GridHandler::initialize() method that use the returned array with the initialized features to add them to grid.

Parameters
$requestPKPRequest
$argsarray
Returns
array Array with initialized grid features objects.

Reimplemented from GridHandler.

Definition at line 39 of file SelectableFileListGridHandler.inc.php.

◆ isDataElementSelected()

SelectableFileListGridHandler::isDataElementSelected (   $gridDataElement)

Returns the current selection state of the grid data element.

Parameters
$gridDataElementmixed
Returns
boolean

Reimplemented from GridHandler.

Reimplemented in LimitReviewFilesGridHandler, SelectableReviewRevisionsGridHandler, SelectableCopyeditFilesGridHandler, SelectableFinalDraftFilesGridHandler, and EditorSelectableReviewAttachmentsGridHandler.

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


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