Open Journal Systems  3.3.0
SubmissionEventLogGridHandler Class Reference
Inheritance diagram for SubmissionEventLogGridHandler:
GridHandler PKPHandler SubmissionFileEventLogGridHandler

Public Member Functions

 __construct ()
 
 _formatEmail ($emailLogEntry)
 
 authorize ($request, &$args, $roleAssignments)
 
 getRequestArgs ()
 
 getSubmission ()
 
 initialize ($request, $args=null)
 
 setSubmission ($submission)
 
 viewEmail ($args, $request)
 
- Public Member Functions inherited from GridHandler
 __construct ($dataProvider=null)
 
 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)
 
 getIsSubcomponent ()
 
 getItemIterator ()
 
 getJSHandler ()
 
 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)
 
 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)
 

Data Fields

 $_isCurrentUserAssignedAuthor
 
 $_submission
 
- 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 Member Functions

 getRowInstance ()
 
 loadData ($request, $filter=null)
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getRowDataElement ($request, &$rowId)
 
 getRowsSequence ($request)
 
 initFeatures ($request, $args)
 
 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())
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Grid handler presenting the submission event log grid.

Definition at line 27 of file SubmissionEventLogGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SubmissionEventLogGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 43 of file SubmissionEventLogGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _formatEmail()

SubmissionEventLogGridHandler::_formatEmail (   $emailLogEntry)

Format the contents of the email

Parameters
$emailLogEntryEmailLogEntry
Returns
string Formatted email

Definition at line 226 of file SubmissionEventLogGridHandler.inc.php.

References PKPString\stripUnsafeHtml().

Referenced by viewEmail().

◆ authorize()

SubmissionEventLogGridHandler::authorize (   $request,
$args,
  $roleAssignments 
)
See also
PKPHandler::authorize()
Parameters
$requestPKPRequest
$argsarray
$roleAssignmentsarray

Reimplemented from GridHandler.

Reimplemented in SubmissionFileEventLogGridHandler.

Definition at line 81 of file SubmissionEventLogGridHandler.inc.php.

References PKPHandler\addPolicy(), and PKPHandler\getAuthorizedContextObject().

◆ getRequestArgs()

SubmissionEventLogGridHandler::getRequestArgs ( )

Get the arguments that will identify the data in the grid In this case, the monograph.

Returns
array

Reimplemented from GridHandler.

Reimplemented in SubmissionFileEventLogGridHandler.

Definition at line 174 of file SubmissionEventLogGridHandler.inc.php.

References getSubmission().

◆ getRowInstance()

SubmissionEventLogGridHandler::getRowInstance ( )
protected
See also
GridHandler::getRowInstance()
Returns
EventLogGridRow

Reimplemented from GridHandler.

Definition at line 165 of file SubmissionEventLogGridHandler.inc.php.

References getSubmission().

◆ getSubmission()

SubmissionEventLogGridHandler::getSubmission ( )

Get the submission associated with this grid.

Returns
Submission

Definition at line 59 of file SubmissionEventLogGridHandler.inc.php.

References $_submission.

Referenced by getRequestArgs(), getRowInstance(), and loadData().

◆ initialize()

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

◆ loadData()

SubmissionEventLogGridHandler::loadData (   $request,
  $filter = null 
)
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.

Reimplemented in SubmissionFileEventLogGridHandler.

Definition at line 185 of file SubmissionEventLogGridHandler.inc.php.

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

◆ setSubmission()

SubmissionEventLogGridHandler::setSubmission (   $submission)

Set the Submission

Parameters
$submissionSubmission

Definition at line 67 of file SubmissionEventLogGridHandler.inc.php.

Referenced by initialize().

◆ viewEmail()

SubmissionEventLogGridHandler::viewEmail (   $args,
  $request 
)

Get the contents of the email

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

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

References _formatEmail(), and DAORegistry\getDAO().

Field Documentation

◆ $_isCurrentUserAssignedAuthor

boolean SubmissionEventLogGridHandler::$_isCurrentUserAssignedAuthor

Is the current user assigned as an author to this submission

Definition at line 38 of file SubmissionEventLogGridHandler.inc.php.

◆ $_submission

Submission SubmissionEventLogGridHandler::$_submission

Definition at line 32 of file SubmissionEventLogGridHandler.inc.php.

Referenced by getSubmission().


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