Open Journal Systems  3.3.0
StageParticipantGridHandler Class Reference
Inheritance diagram for StageParticipantGridHandler:
CategoryGridHandler GridHandler PKPHandler

Public Member Functions

 __construct ()
 
 addParticipant ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 deleteParticipant ($args, $request)
 
 fetchTemplateBody ($args, $request)
 
 fetchUserList ($args, $request)
 
 getCategoryRowIdParameterName ()
 
 getIsSubcomponent ()
 
 getJSHandler ()
 
 getRequestArgs ()
 
 getStageId ()
 
 getSubmission ()
 
 initialize ($request, $args=null)
 
 loadCategoryData ($request, &$userGroup, $filter=null)
 
 saveParticipant ($args, $request)
 
 sendNotification ($args, $request)
 
 viewNotify ($args, $request)
 
- Public Member Functions inherited from CategoryGridHandler
 __construct ($dataProvider=null)
 
 fetchCategory ($args, $request)
 
 getCategoryItemsCount ($categoryElement, $request)
 
 getCurrentCategoryId ()
 
 getDataElementInCategorySequence ($categoryId, &$gridDataElement)
 
 getEmptyCategoryRowText ()
 
getGridCategoryDataElements ($request, $categoryElement)
 
 hasGridDataElementsInCategory ($categoryElement, $request)
 
 isDataElementInCategorySelected ($categoryId, &$gridDataElement)
 
 setDataElementInCategorySequence ($categoryId, &$gridDataElement, $newSequence)
 
 setEmptyCategoryRowText ($translationKey)
 
 setGridCategoryDataElements ($request, $categoryElementId, $data)
 
 setUrls ($request, $extraUrls=array())
 
- Public Member Functions inherited from GridHandler
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn ($column)
 
 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)
 
 getDataElementSequence ($gridDataElement)
 
 getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 
 getItemIterator ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestedRow ($request, $args)
 
 getSelectName ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 isDataElementSelected ($gridDataElement)
 
 renderRow ($request, $row)
 
 saveSequence ($args, $request)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 setEmptyRowText ($emptyRowText)
 
 setFootNote ($footNote)
 
 setGridDataElements ($data)
 
 setTemplate ($template)
 
 setTitle ($title)
 
- 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

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

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 CategoryGridHandler
 $_categoryData
 
 $_currentCategoryId = null
 
 $_emptyCategoryRowText = 'grid.noItems'
 
- 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 stageParticipant grid requests.

Definition at line 26 of file StageParticipantGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

StageParticipantGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment(), and GridHandler\setTitle().

Member Function Documentation

◆ _canAdminister()

StageParticipantGridHandler::_canAdminister ( )
protected

Determine whether the current user has admin priveleges for this grid.

Returns
boolean

Definition at line 85 of file StageParticipantGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by getRowInstance(), and initialize().

◆ addParticipant()

StageParticipantGridHandler::addParticipant (   $args,
  $request 
)

Add a participant to the stages

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 276 of file StageParticipantGridHandler.inc.php.

References GridHandler\getGridDataElements(), getStageId(), and getSubmission().

◆ authorize()

StageParticipantGridHandler::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.
Returns
boolean

Reimplemented from GridHandler.

Definition at line 73 of file StageParticipantGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ deleteParticipant()

StageParticipantGridHandler::deleteParticipant (   $args,
  $request 
)

Delete the participant from the user groups

Parameters
$args
$request
Returns
JSONMessage JSON object

Definition at line 364 of file StageParticipantGridHandler.inc.php.

References DAORegistry\getDAO(), DAO\getDataChangedEvent(), getStageId(), getSubmission(), and SubmissionLog\logEvent().

◆ fetchTemplateBody()

StageParticipantGridHandler::fetchTemplateBody (   $args,
  $request 
)

Fetches an email template's message body and returns it via AJAX.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 517 of file StageParticipantGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), PKPHandler\getId(), and getSubmission().

◆ fetchUserList()

StageParticipantGridHandler::fetchUserList (   $args,
  $request 
)

Get the list of users for the specified user group

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

Definition at line 426 of file StageParticipantGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), and getSubmission().

◆ getCategoryRowIdParameterName()

StageParticipantGridHandler::getCategoryRowIdParameterName ( )

Get the category row id parameter name.

Returns
string

Reimplemented from CategoryGridHandler.

Definition at line 215 of file StageParticipantGridHandler.inc.php.

◆ getCategoryRowInstance()

StageParticipantGridHandler::getCategoryRowInstance ( )
protected

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

Reimplemented from CategoryGridHandler.

Definition at line 207 of file StageParticipantGridHandler.inc.php.

References getStageId(), and getSubmission().

◆ getIsSubcomponent()

StageParticipantGridHandler::getIsSubcomponent ( )

Reimplemented from GridHandler.

Definition at line 193 of file StageParticipantGridHandler.inc.php.

◆ getJSHandler()

StageParticipantGridHandler::getJSHandler ( )

Get the js handler for this component.

Returns
string

Reimplemented from CategoryGridHandler.

Definition at line 547 of file StageParticipantGridHandler.inc.php.

◆ getRequestArgs()

StageParticipantGridHandler::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.

Returns
array

Reimplemented from CategoryGridHandler.

Definition at line 222 of file StageParticipantGridHandler.inc.php.

References getSubmission().

◆ getRowInstance()

StageParticipantGridHandler::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 200 of file StageParticipantGridHandler.inc.php.

References _canAdminister(), getStageId(), and getSubmission().

◆ getStageId()

StageParticipantGridHandler::getStageId ( )

◆ getSubmission()

◆ initialize()

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

◆ loadCategoryData()

StageParticipantGridHandler::loadCategoryData (   $request,
$userGroup,
  $filter = null 
)

Implement this method to load category data into the grid.

Parameters
$requestPKPRequest
$categoryDataElementmixed
$filtermixed
Returns
array

Reimplemented from CategoryGridHandler.

Definition at line 175 of file StageParticipantGridHandler.inc.php.

References DAORegistry\getDAO(), getStageId(), and getSubmission().

◆ loadData()

StageParticipantGridHandler::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 236 of file StageParticipantGridHandler.inc.php.

References DAORegistry\getDAO(), PKPHandler\getId(), getStageId(), and getSubmission().

◆ saveParticipant()

StageParticipantGridHandler::saveParticipant (   $args,
  $request 
)

Update the row for the current userGroup's stage participant list.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 298 of file StageParticipantGridHandler.inc.php.

References Application\getApplicationStages(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), GridHandler\getGridDataElements(), getStageId(), getSubmission(), and SubmissionLog\logEvent().

◆ sendNotification()

StageParticipantGridHandler::sendNotification (   $args,
  $request 
)

Send a notification from the notify tab.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 473 of file StageParticipantGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), PKPHandler\getId(), getStageId(), getSubmission(), and PKPHandler\setupTemplate().

◆ viewNotify()

StageParticipantGridHandler::viewNotify (   $args,
  $request 
)

Display the notify tab.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 457 of file StageParticipantGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), PKPHandler\getId(), getSubmission(), and PKPHandler\setupTemplate().


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