Open Journal Systems  3.3.0
SubmissionChecklistGridHandler Class Reference
Inheritance diagram for SubmissionChecklistGridHandler:
SetupGridHandler GridHandler PKPHandler

Public Member Functions

 __construct ()
 
 addItem ($args, $request)
 
 deleteItem ($args, $request)
 
 editItem ($args, $request)
 
 getDataElementSequence ($gridDataElement)
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 updateItem ($args, $request)
 
- Public Member Functions inherited from SetupGridHandler
 authorize ($request, &$args, $roleAssignments, $contextRequired=true)
 
 uploadImage ($args, $request)
 
- Public Member Functions inherited from GridHandler
 __construct ($dataProvider=null)
 
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn ($column)
 
 authorize ($request, &$args, $roleAssignments)
 
 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)
 
 getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 
 getIsSubcomponent ()
 
 getItemIterator ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestArgs ()
 
 getRequestedRow ($request, $args)
 
 getSelectName ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 isDataElementSelected ($gridDataElement)
 
 renderRow ($request, $row)
 
 saveSequence ($args, $request)
 
 setEmptyRowText ($emptyRowText)
 
 setFootNote ($footNote)
 
 setGridDataElements ($data)
 
 setTemplate ($template)
 
 setTitle ($title)
 
 setUrls ($request, $extraUrls=array())
 
- Public Member Functions inherited from PKPHandler
 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)
 

Protected Member Functions

 getRowInstance ()
 
 loadData ($request, $filter)
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getRowDataElement ($request, &$rowId)
 
 getRowsSequence ($request)
 
 isFilterFormCollapsible ()
 
 noAutocompleteResults ()
 
 renderFilter ($request, $filterData=array())
 
 renderGridBodyPartsInternally ($request)
 
 renderRowInternally ($request, $row)
 
 renderRowsInternally ($request, &$elements)
 
 setFirstDataColumn ()
 

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 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 Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle submissionChecklist grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

SubmissionChecklistGridHandler::__construct ( )

Constructor

Reimplemented from SetupGridHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addItem()

SubmissionChecklistGridHandler::addItem (   $args,
  $request 
)

An action to add a new submissionChecklist

Parameters
$argsarray
$requestPKPRequest

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

References editItem().

◆ deleteItem()

SubmissionChecklistGridHandler::deleteItem (   $args,
  $request 
)

Delete a submissionChecklist

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

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

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

◆ editItem()

SubmissionChecklistGridHandler::editItem (   $args,
  $request 
)

An action to edit a submissionChecklist

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

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

Referenced by addItem().

◆ getDataElementSequence()

SubmissionChecklistGridHandler::getDataElementSequence (   $gridDataElement)

Override to return the data element sequence value.

Parameters
$gridDataElementmixed
Returns
int

Reimplemented from GridHandler.

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

◆ getRowInstance()

SubmissionChecklistGridHandler::getRowInstance ( )
protected

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

Returns
GridRow

Reimplemented from GridHandler.

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

◆ initFeatures()

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

Reimplemented from GridHandler.

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

◆ initialize()

SubmissionChecklistGridHandler::initialize (   $request,
  $args = null 
)

◆ loadData()

SubmissionChecklistGridHandler::loadData (   $request,
  $filter 
)
protected

Implement this method to load data into the grid.

Parameters
$requestPKPRequest
$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

Reimplemented from GridHandler.

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

References AppLocale\getLocale().

◆ setDataElementSequence()

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

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

Reimplemented from GridHandler.

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

References AppLocale\getLocale().

◆ updateItem()

SubmissionChecklistGridHandler::updateItem (   $args,
  $request 
)

Update a submissionChecklist

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

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

References DAO\getDataChangedEvent().


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