Base grid for providing a list of files as categories and the requested signoffs on that file as rows. More...

Inheritance diagram for SignoffFilesGridHandler:

Public Member Functions
	_getSignoffCapableUsersId ()
	addAuditor ($args, &$request)
	authorize (&$request, $args, $roleAssignments)
	deleteSignoff ($args, &$request)
	deleteSignOffSignOff ($args, &$request)
	editReminder ($args, &$request)
	getAssocId ()
	getAssocType ()
	getAuditorAutocomplete ($args, &$request)
	getCategoryData (&$monographFile)
	getCategoryRowIdParameterName ()
&	getCategoryRowInstance ()
	getEventType ()
	getFileStage ()
&	getMonograph ()
&	getPublicationFormat ()
	getRequestArgs ()
&	getRowInstance ()
	getStageId ()
	getSymbolic ()
	initialize (&$request)
&	loadData (&$request, $filter)
	returnSignoffRow ($args, &$request)
	saveAddAuditor ($args, &$request)
	sendReminder ($args, &$request)
	setAssocId ($assocId)
	SignoffFilesGridHandler ($stageId, $fileStage, $symbolic, $eventType, $assocType=null, $assocId=null)
	signOffsignOff ($args, &$request)
	viewLibrary ($args, &$request)

Detailed Description

Base grid for providing a list of files as categories and the requested signoffs on that file as rows.

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

Member Function Documentation

SignoffFilesGridHandler._getSignoffCapableUsersId ( )

Get all ids of users that are capable of signing off a signoff.

Returns:: array

Definition at line 686 of file SignoffFilesGridHandler.inc.php.

References getStageId().

Referenced by initialize().

SignoffFilesGridHandler.addAuditor	(	$	args,
		&$	request
	)

Adds an auditor (signoff) to a file

Parameters:

	$args	array
	$request	PKPRequest

Returns:: string Serialized JSON object

Definition at line 384 of file SignoffFilesGridHandler.inc.php.

References getAssocId(), getEventType(), getFileStage(), getPublicationFormat(), getRequestArgs(), getStageId(), and getSymbolic().

SignoffFilesGridHandler.authorize	(	&$	request,
		$	args,
		$	roleAssignments
	)

See also:: PKPHandler.authorize()

Parameters:

	$request	PKPRequest
	$args	array
	$roleAssignments	array

Definition at line 80 of file SignoffFilesGridHandler.inc.php.

References getStageId().

SignoffFilesGridHandler.deleteSignoff	(	$	args,
		&$	request
	)

Delete a user's signoff

Parameters:

	$args	array
	$request	PKPRequest

Returns:: string

Definition at line 506 of file SignoffFilesGridHandler.inc.php.

References MonographFileLog.logEvent().

SignoffFilesGridHandler.deleteSignOffSignOff	(	$	args,
		&$	request
	)

Delete the signoff on the signoff in request.

Parameters:

	$args	array
	$request	PKPRequest

Returns:: string Serialized JSON object

Definition at line 590 of file SignoffFilesGridHandler.inc.php.

SignoffFilesGridHandler.editReminder	(	$	args,
		&$	request
	)

Displays a modal to allow the editor to enter a message to send to the auditor as a reminder.

Parameters:

	$args	array
	$request	PKPRequest

Returns:: string Serialized JSON object

Definition at line 625 of file SignoffFilesGridHandler.inc.php.

References getPublicationFormat(), and getStageId().

SignoffFilesGridHandler.getAssocId ( )

Get the assoc id

Definition at line 269 of file SignoffFilesGridHandler.inc.php.

Referenced by addAuditor(), ProofFilesGridHandler.getRequestArgs(), initialize(), ProofFilesGridHandler.initialize(), loadData(), and saveAddAuditor().

SignoffFilesGridHandler.getAssocType ( )

Get the assoc type

Definition at line 253 of file SignoffFilesGridHandler.inc.php.

Referenced by initialize(), and loadData().

SignoffFilesGridHandler.getAuditorAutocomplete	(	$	args,
		&$	request
	)

Get users for copyediting autocomplete.

Parameters:

	$args	array
	$request	PKPRequest

Returns:: string Serialized JSON object

Definition at line 448 of file SignoffFilesGridHandler.inc.php.

References getStageId().

SignoffFilesGridHandler.getCategoryData ( &$ monographFile )

Get all the signoffs for this category.

See also:: CategoryGridHandler.getCategoryData()

Parameters:

$monographFile

MonographFile

Returns:: array Signoffs

Definition at line 350 of file SignoffFilesGridHandler.inc.php.

References getSymbolic().

SignoffFilesGridHandler.getCategoryRowIdParameterName ( )

See also:: CategoryGridHandler.getCategoryRowIdParameterName()

Definition at line 360 of file SignoffFilesGridHandler.inc.php.

& SignoffFilesGridHandler.getCategoryRowInstance ( )

See also:: CategoryGridHandler.getCategoryRowInstance()

Returns:: CopyeditingFilesGridCategoryRow

Definition at line 335 of file SignoffFilesGridHandler.inc.php.

References getMonograph(), and getStageId().

SignoffFilesGridHandler.getEventType ( )

Get the email key

Definition at line 245 of file SignoffFilesGridHandler.inc.php.

Referenced by addAuditor(), and saveAddAuditor().

SignoffFilesGridHandler.getFileStage ( )

Get the fileStage (for categories)

Definition at line 237 of file SignoffFilesGridHandler.inc.php.

Referenced by addAuditor(), initialize(), loadData(), and saveAddAuditor().

& SignoffFilesGridHandler.getMonograph ( )

Get the monograph associated with this chapter grid.

Returns:: Monograph

Definition at line 211 of file SignoffFilesGridHandler.inc.php.

Referenced by getCategoryRowInstance(), getRequestArgs(), initialize(), and loadData().

& SignoffFilesGridHandler.getPublicationFormat ( )

Get publication format, if any.

Returns:: PublicationFormat

Definition at line 277 of file SignoffFilesGridHandler.inc.php.

Referenced by addAuditor(), editReminder(), ProofFilesGridHandler.initialize(), and sendReminder().

SignoffFilesGridHandler.getRequestArgs ( )

See also:: GridDataProvider.getRequestArgs()

Reimplemented in ProofFilesGridHandler.

Definition at line 285 of file SignoffFilesGridHandler.inc.php.

References getMonograph(), and getStageId().

Referenced by addAuditor(), and initialize().

& SignoffFilesGridHandler.getRowInstance ( )

Get the row handler - override the default row handler

Returns:: CopyeditingFilesGridRow

Reimplemented in ProofFilesGridHandler.

Definition at line 369 of file SignoffFilesGridHandler.inc.php.

References getStageId().

SignoffFilesGridHandler.getStageId ( )

Get the workflow stage id.

Returns:: integer

Definition at line 220 of file SignoffFilesGridHandler.inc.php.

Referenced by _getSignoffCapableUsersId(), addAuditor(), authorize(), editReminder(), getAuditorAutocomplete(), getCategoryRowInstance(), getRequestArgs(), getRowInstance(), initialize(), saveAddAuditor(), and sendReminder().

SignoffFilesGridHandler.getSymbolic ( )

Get the signoff's symbolic

Returns:: string

Definition at line 229 of file SignoffFilesGridHandler.inc.php.

Referenced by addAuditor(), getCategoryData(), initialize(), and saveAddAuditor().

SignoffFilesGridHandler.initialize ( &$ request )

Configure the grid

Parameters:

PKPRequest

$request

Reimplemented in CopyeditingFilesGridHandler, and ProofFilesGridHandler.

Definition at line 107 of file SignoffFilesGridHandler.inc.php.

References _getSignoffCapableUsersId(), getAssocId(), getAssocType(), getFileStage(), getMonograph(), getRequestArgs(), getStageId(), and getSymbolic().

& SignoffFilesGridHandler.loadData	(	&$	request,
		$	filter
	)

See also:: GridHandler.loadData

Definition at line 305 of file SignoffFilesGridHandler.inc.php.

References getAssocId(), getAssocType(), getFileStage(), and getMonograph().

SignoffFilesGridHandler.returnSignoffRow	(	$	args,
		&$	request
	)

Return a grid row with for the copyediting grid

Parameters:

	$args	array
	$request	PKPRequest

Returns:: string Serialized JSON object

Definition at line 488 of file SignoffFilesGridHandler.inc.php.

SignoffFilesGridHandler.saveAddAuditor	(	$	args,
		&$	request
	)

Save the form for adding an auditor to a copyediting file

Parameters:

	$args	array
	$request	PKPRequest

Returns:: string Serialized JSON object

Definition at line 418 of file SignoffFilesGridHandler.inc.php.

References getAssocId(), getEventType(), getFileStage(), getStageId(), and getSymbolic().

SignoffFilesGridHandler.sendReminder	(	$	args,
		&$	request
	)

Send the auditor reminder and close the modal.

Parameters:

	$args	array
	$request	PKPRequest

Returns:: string Serialized JSON object

Definition at line 651 of file SignoffFilesGridHandler.inc.php.

References getPublicationFormat(), and getStageId().

SignoffFilesGridHandler.setAssocId ( $ assocId )

Set the assoc Id

Definition at line 261 of file SignoffFilesGridHandler.inc.php.

Referenced by ProofFilesGridHandler.initialize().

SignoffFilesGridHandler.SignoffFilesGridHandler	(	$	stageId,
		$	fileStage,
		$	symbolic,
		$	eventType,
		$	assocType = `null`,
		$	assocId = `null`
	)

Constructor

Definition at line 50 of file SignoffFilesGridHandler.inc.php.

Referenced by CopyeditingFilesGridHandler.CopyeditingFilesGridHandler(), and ProofFilesGridHandler.ProofFilesGridHandler().

SignoffFilesGridHandler.signOffsignOff	(	$	args,
		&$	request
	)

Let the user signoff on the signoff

Parameters:

	$args	array
	$request	Request

Definition at line 555 of file SignoffFilesGridHandler.inc.php.

References MonographFileLog.logEvent().

SignoffFilesGridHandler.viewLibrary	(	$	args,
		&$	request
	)

Load the (read only) press file library.

Parameters:

	$args	array
	$request	PKPRequest

Returns:: string Serialized JSON object

Definition at line 612 of file SignoffFilesGridHandler.inc.php.

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

controllers/grid/files/signoff/SignoffFilesGridHandler.inc.php

SignoffFilesGridHandler Class Reference

Public Member Functions

Detailed Description

Member Function Documentation