Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
SelectableSubmissionFileListCategoryGridHandler Class Reference
Inheritance diagram for SelectableSubmissionFileListCategoryGridHandler:
CategoryGridHandler GridHandler PKPHandler ManageFinalDraftFilesGridHandler ManageReviewFilesGridHandler

Public Member Functions

 authorize ($request, &$args, $roleAssignments)
 
 getCapabilities ()
 
 getCategoryRowInstance ()
 
 getFilesToDownload ($request)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getRowInstance ()
 
 getSelectName ()
 
 getStageId ()
 
 getSubmission ()
 
 initFeatures ($request, $args)
 
 initialize ($request)
 
 isDataElementInCategorySelected ($categoryDataId, &$gridDataElement)
 
 loadData ($request, $filter)
 
 SelectableSubmissionFileListCategoryGridHandler ($dataProvider, $stageId, $capabilities)
 
- Public Member Functions inherited from CategoryGridHandler
 CategoryGridHandler ($dataProvider=null)
 
 fetchCategory (&$args, $request)
 
 getCurrentCategoryId ()
 
 getDataElementInCategorySequence ($categoryId, &$gridDataElement)
 
 getEmptyCategoryRowText ()
 
 getJSHandler ()
 
 getRequestArgs ()
 
 hasGridDataElementsInCategory ($categoryDataElement, $request)
 
 isDataElementInCategorySelected ($categoryId, &$gridDataElement)
 
 setDataElementInCategorySequence ($categoryId, &$gridDataElement, $newSequence)
 
 setEmptyCategoryRowText ($translationKey)
 
 setUrls ($request)
 
- 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 CategoryGridHandler
 $_currentCategoryId = null
 
 $_emptyCategoryRowText = 'grid.noItems'
 
- Public Attributes inherited from GridHandler
 $_actions = array(GRID_ACTION_POSITION_DEFAULT => array())
 
 $_columns = array()
 
 $_data
 
 $_emptyRowText = 'grid.noItems'
 
 $_features
 
 $_footNote = ''
 
 $_instructions = ''
 
 $_itemIterator
 
 $_template
 
 $_title = ''
 
 $_urls
 
- Public Attributes inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_id
 
 $_roleAssignments = array()
 
- Protected Member Functions inherited from CategoryGridHandler
 doSpecificFetchGridActions ($args, $request, &$templateMgr)
 
getCategoryData (&$categoryDataElement, $filter=null)
 
 getCategoryRowIdParameterName ()
 
 getCategoryRowInstance ()
 
 getRequestedCategoryRow ($request, $args)
 
 getRowDataElement ($request, $rowId)
 
 getRowsSequence ($request)
 
 renderRowInternally ($request, $row)
 
 setFirstDataColumn ()
 
- 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 selectable submission file list category grid requests.

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

Member Function Documentation

SelectableSubmissionFileListCategoryGridHandler::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 144 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

SelectableSubmissionFileListCategoryGridHandler::getCapabilities ( )

Get grid capabilities object.

Returns
FilesGridCapabilities

Definition at line 70 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

Referenced by initFeatures().

SelectableSubmissionFileListCategoryGridHandler::getCategoryRowInstance ( )

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

Returns
CategoryGridRow

Definition at line 133 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

References getStageId().

SelectableSubmissionFileListCategoryGridHandler::getFilesToDownload (   $request)

Get all files of this grid to download.

Parameters
$requestRequest
Returns
array

Definition at line 238 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

SelectableSubmissionFileListCategoryGridHandler::getFilterForm ( )

Returns a Form object or the path name of a filter template.

Returns
Form|string

Definition at line 115 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

SelectableSubmissionFileListCategoryGridHandler::getFilterSelectionData (   $request)

Method that extracts the user's filter selection from the request either by instantiating the filter's Form object or by reading the request directly (if using a simple filter template only).

Parameters
$requestPKPRequest
Returns
array

Definition at line 122 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

SelectableSubmissionFileListCategoryGridHandler::getRowInstance ( )

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

Returns
GridRow

Definition at line 224 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

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

SelectableSubmissionFileListCategoryGridHandler::getSelectName ( )

Get the selection name.

Returns
string

Definition at line 275 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

SelectableSubmissionFileListCategoryGridHandler::getStageId ( )

Get the workflow stage id.

Returns
integer

Definition at line 78 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

Referenced by getCategoryRowInstance(), and initFeatures().

SelectableSubmissionFileListCategoryGridHandler::getSubmission ( )

Get the authorized submission.

Returns
Submission

Definition at line 86 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

Referenced by ManageFinalDraftFilesGridHandler\updateFinalDraftFiles().

SelectableSubmissionFileListCategoryGridHandler::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
$requestRequest
$argsarray
Returns
array Array with initialized grid features objects.

Definition at line 212 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

References getCapabilities(), and getStageId().

SelectableSubmissionFileListCategoryGridHandler::initialize (   $request)

Subclasses can override this method to configure the handler.

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

Parameters
$requestPKPRequest
$argsarray

Definition at line 162 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

SelectableSubmissionFileListCategoryGridHandler::isDataElementInCategorySelected (   $categoryDataId,
$gridDataElement 
)
SelectableSubmissionFileListCategoryGridHandler::loadData (   $request,
  $filter 
)

Implement this method to load data into the grid.

Parameters
$requestRequest
$filterarray An associative array with filter data as returned by getFilterSelectionData(). If no filter has been selected by the user then the array will be empty.
Returns
grid data

Definition at line 100 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

SelectableSubmissionFileListCategoryGridHandler::SelectableSubmissionFileListCategoryGridHandler (   $dataProvider,
  $stageId,
  $capabilities 
)

Constructor

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

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


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