Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
FileSignoffGridHandler Class Reference
Inheritance diagram for FileSignoffGridHandler:
SubmissionFilesGridHandler GridHandler PKPHandler FairCopyFilesGridHandler ReviewRevisionsGridHandler AuthorReviewRevisionsGridHandler WorkflowReviewRevisionsGridHandler

Public Member Functions

 FileSignoffGridHandler ($dataProvider, $stageId, $symbolic, $capabilities)
 
 getSymbolic ()
 
 initialize ($request)
 
 signOffFile ($args, $request)
 
- Public Member Functions inherited from SubmissionFilesGridHandler
 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()
 
 $_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 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

Base grid for file lists that allow for file signoff. This grid shows signoff columns in addition to the file name.

Definition at line 24 of file FileSignoffGridHandler.inc.php.

Member Function Documentation

FileSignoffGridHandler::FileSignoffGridHandler (   $dataProvider,
  $stageId,
  $symbolic,
  $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 38 of file FileSignoffGridHandler.inc.php.

FileSignoffGridHandler::getSymbolic ( )

Get the signoff's symbolic

Returns
integer

Definition at line 119 of file FileSignoffGridHandler.inc.php.

FileSignoffGridHandler::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 49 of file FileSignoffGridHandler.inc.php.

FileSignoffGridHandler::signOffFile (   $args,
  $request 
)

Sign off the given file revision.

Parameters
$argsarray
$requestRequest

Definition at line 132 of file FileSignoffGridHandler.inc.php.


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