Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
FilesListbuilderHandler Class Reference
Inheritance diagram for FilesListbuilderHandler:
ListbuilderHandler GridHandler PKPHandler CopyeditingFilesListbuilderHandler ProofFilesListbuilderHandler

Public Member Functions

 authorize ($request, &$args, $roleAssignments, $stageId)
 FilesListbuilderHandler ($fileStage)
 getFileStage ()
 getOptions ($submissionFiles)
 getRequestArgs ()
 getRowDataElement ($request, $rowId)
 initialize ($request)
 setupTemplate ($request)
- Public Member Functions inherited from ListbuilderHandler
 deleteEntry ($request, $rowId)
 fetch ($args, $request)
 fetchOptions ($args, $request)
 getAddItemLinkAction ($actionRequest)
 getNewRowId ($request)
 getOptions ($request)
 getSaveFieldName ()
 getSaveType ()
 getSourceType ()
 getTemplate ()
 initialize ($request, $addItemLink=true)
 insertEntry ($request, $newRowId)
 ListbuilderHandler ()
 save ($args, $request)
 setSaveFieldName ($fieldName)
 setSaveType ($saveType)
 setSourceType ($sourceType)
 unpack ($request, $data, $deletionCallback=null, $insertionCallback=null, $updateCallback=null)
 updateEntry ($request, $rowId, $newRowId)
- 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)

Public Attributes

- Public Attributes inherited from ListbuilderHandler
 $_saveFieldName = null
- 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()

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 Member Functions inherited from ListbuilderHandler
 getRowInstance ()
- 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 class for selecting files to add a user to.

Definition at line 18 of file

Member Function Documentation

FilesListbuilderHandler::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 52 of file

References PKPHandler\addPolicy().

FilesListbuilderHandler::FilesListbuilderHandler (   $fileStage)


Definition at line 26 of file

References PKPHandler\addRoleAssignment().

FilesListbuilderHandler::getFileStage ( )
FilesListbuilderHandler::getOptions (   $submissionFiles)

Load possible items to populate drop-down list with.

$submissionFilesArray Submission files of this submission.

Definition at line 87 of file

FilesListbuilderHandler::getRequestArgs ( )

Get the grid request parameters. These are the parameters that uniquely identify the data within a grid.

NB: You should make sure to authorize and/or validate parameters before you publish them through this interface. Callers will assume that data accessed through this method will not have to be sanitized.

The default implementation tries to retrieve request parameters from a data provider if there is one.


Definition at line 102 of file

References PKPHandler\getAuthorizedContextObject().

FilesListbuilderHandler::getRowDataElement (   $request,

Retrieve a single data element from the grid's data source corresponding to the given row id. If none is found then return null.


Definition at line 121 of file

References PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), getFileStage(), and ListbuilderHandler\getNewRowId().

FilesListbuilderHandler::initialize (   $request)
FilesListbuilderHandler::setupTemplate (   $request)

Set up the basic template.


Definition at line 112 of file

References AppLocale\requireComponents().

Member Data Documentation


File stage

Definition at line 21 of file

Referenced by getFileStage().

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