Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
SubmissionChecklistGridHandler Class Reference
Inheritance diagram for SubmissionChecklistGridHandler:
SetupGridHandler GridHandler PKPHandler

Public Member Functions

 addItem ($args, $request)
 
 deleteItem ($args, $request)
 
 editItem ($args, $request)
 
 getDataElementSequence ($gridDataElement)
 
 getRowInstance ()
 
 initFeatures ($request, $args)
 
 initialize ($request)
 
 loadData ($request, $filter)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 SubmissionChecklistGridHandler ()
 
 updateItem ($args, $request)
 
- Public Member Functions inherited from SetupGridHandler
 authorize ($request, &$args, $roleAssignments, $contextRequired=true)
 
 initialize ($request)
 
 SetupGridHandler ()
 
 uploadImage ($args, $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 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

Handle submissionChecklist grid requests.

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

Member Function Documentation

SubmissionChecklistGridHandler::addItem (   $args,
  $request 
)

An action to add a new submissionChecklist

Parameters
$argsarray
$requestPKPRequest

Definition at line 113 of file SubmissionChecklistGridHandler.inc.php.

References editItem().

SubmissionChecklistGridHandler::deleteItem (   $args,
  $request 
)

Delete a submissionChecklist

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 166 of file SubmissionChecklistGridHandler.inc.php.

References DAO\getDataChangedEvent(), AppLocale\getLocale(), and AppLocale\getSupportedLocales().

SubmissionChecklistGridHandler::editItem (   $args,
  $request 
)

An action to edit a submissionChecklist

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 125 of file SubmissionChecklistGridHandler.inc.php.

References JSONMessage\getString().

Referenced by addItem().

SubmissionChecklistGridHandler::getDataElementSequence (   $gridDataElement)

Override to return the data element sequence value.

Parameters
$gridDataElementmixed
Returns
int

Definition at line 196 of file SubmissionChecklistGridHandler.inc.php.

SubmissionChecklistGridHandler::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 88 of file SubmissionChecklistGridHandler.inc.php.

SubmissionChecklistGridHandler::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 80 of file SubmissionChecklistGridHandler.inc.php.

SubmissionChecklistGridHandler::initialize (   $request)
SubmissionChecklistGridHandler::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 95 of file SubmissionChecklistGridHandler.inc.php.

References AppLocale\getLocale().

SubmissionChecklistGridHandler::setDataElementSequence (   $request,
  $rowId,
  $gridDataElement,
  $newSequence 
)

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

Definition at line 203 of file SubmissionChecklistGridHandler.inc.php.

References AppLocale\getLocale().

SubmissionChecklistGridHandler::SubmissionChecklistGridHandler ( )

Constructor

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

References PKPHandler\addRoleAssignment().

SubmissionChecklistGridHandler::updateItem (   $args,
  $request 
)

Update a submissionChecklist

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 142 of file SubmissionChecklistGridHandler.inc.php.

References DAO\getDataChangedEvent().


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