Inheritance diagram for IssueGridHandler:

Public Member Functions
	__construct ()

	access ($args, $request)

	addIssue ($args, $request)

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

	clearIssueObjectsPubIds ($args, $request)

	clearPubId ($args, $request)

	deleteCoverImage ($args, $request)

	deleteIssue ($args, $request)

	editIssue ($args, $request)

	editIssueData ($args, $request)

	getAssignPublicIdentifiersFormTemplate ()

	identifiers ($args, $request)

	initialize ($request, $args=null)

	issueGalleys ($args, $request)

	issueToc ($args, $request)

	publishIssue ($args, $request)

	setCurrentIssue ($args, $request)

	unpublishIssue ($args, $request)

	updateAccess ($args, $request)

	updateIdentifiers ($args, $request)

	updateIssue ($args, $request)

	uploadFile ($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)

	getRequestArgs ()

	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)

Protected Member Functions
	_addCenterColumns ($issueGridCellProvider)

	getRowInstance ()

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 ()

	loadData ($request, $filter)

	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 issues grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

IssueGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Reimplemented in BackIssueGridHandler.

Definition at line 28 of file IssueGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _addCenterColumns()

IssueGridHandler::_addCenterColumns ( $issueGridCellProvider )

protected

Private function to add central columns to the grid. May be overridden by subclasses.

Parameters

$issueGridCellProvider IssueGridCellProvider

Reimplemented in BackIssueGridHandler.

Definition at line 109 of file IssueGridHandler.inc.php.

Referenced by initialize().

◆ access()

IssueGridHandler::access	(	$args,
		$request
	)

An action to edit an issue's access settings

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 259 of file IssueGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ addIssue()

IssueGridHandler::addIssue	(	$args,
		$request
	)

An action to add a new issue

Parameters

$args	array
$request	PKPRequest

Definition at line 129 of file IssueGridHandler.inc.php.

References editIssueData().

◆ authorize()

IssueGridHandler::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

$request	Request
$args	array request arguments
$roleAssignments	array the operation role assignment, see getRoleAssignment() for more details.

Returns: boolean

Reimplemented from GridHandler.

Definition at line 52 of file IssueGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ clearIssueObjectsPubIds()

IssueGridHandler::clearIssueObjectsPubIds	(	$args,
		$request
	)

Clear issue objects pub ids

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 391 of file IssueGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ clearPubId()

IssueGridHandler::clearPubId	(	$args,
		$request
	)

Clear issue pub id

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 375 of file IssueGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ deleteCoverImage()

IssueGridHandler::deleteCoverImage	(	$args,
		$request
	)

Delete an uploaded cover image.

Parameters

$args	array `coverImage` string Filename of the cover image to be deleted. `issueId` int Id of the issue this cover image is attached to
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 199 of file IssueGridHandler.inc.php.

References DAORegistry\getDAO(), and AppLocale\getLocale().

◆ deleteIssue()

IssueGridHandler::deleteIssue	(	$args,
		$request
	)

Removes an issue

Parameters

$args	array
$request	PKPRequest

Definition at line 296 of file IssueGridHandler.inc.php.

References PKPServices\get(), PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), and DAO\getDataChangedEvent().

◆ editIssue()

IssueGridHandler::editIssue	(	$args,
		$request
	)

An action to edit an issue

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 141 of file IssueGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), PKPTemplateManager\getManager(), and PluginRegistry\getPlugins().

◆ editIssueData()

IssueGridHandler::editIssueData	(	$args,
		$request
	)

An action to edit an issue's identifying data

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 159 of file IssueGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by addIssue().

◆ getAssignPublicIdentifiersFormTemplate()

IssueGridHandler::getAssignPublicIdentifiersFormTemplate ( )

Get the template for the assign public identifiers form.

Returns: string

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

Referenced by publishIssue().

◆ getRowInstance()

IssueGridHandler::getRowInstance ( )

protected

Get the row handler - override the default row handler

Returns: IssueGridRow

Reimplemented from GridHandler.

Reimplemented in ExportableIssuesListGridHandler.

Definition at line 117 of file IssueGridHandler.inc.php.

◆ identifiers()

IssueGridHandler::identifiers	(	$args,
		$request
	)

An action to edit issue pub ids

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 342 of file IssueGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ initialize()

IssueGridHandler::initialize	(	$request,
		$args = `null`
	)

See also: PKPHandler::initialize()

Parameters

$request	PKPRequest
$args	array optional

Reimplemented from GridHandler.

Reimplemented in BackIssueGridHandler, and FutureIssueGridHandler.

Definition at line 68 of file IssueGridHandler.inc.php.

References _addCenterColumns(), GridHandler\addColumn(), and AppLocale\requireComponents().

◆ issueGalleys()

IssueGridHandler::issueGalleys	(	$args,
		$request
	)

Displays the issue galleys page.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 420 of file IssueGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and PKPTemplateManager\getManager().

◆ issueToc()

IssueGridHandler::issueToc	(	$args,
		$request
	)

Display the table of contents

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 407 of file IssueGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and PKPTemplateManager\getManager().

◆ publishIssue()

IssueGridHandler::publishIssue	(	$args,
		$request
	)

Publish issue

Parameters

$args	array
$request	Request

Definition at line 439 of file IssueGridHandler.inc.php.

References HookRegistry\call(), PKPServices\get(), getAssignPublicIdentifiersFormTemplate(), PKPHandler\getAuthorizedContextObject(), Core\getCurrentDate(), DAORegistry\getDAO(), and DAO\getDataChangedEvent().

◆ setCurrentIssue()

IssueGridHandler::setCurrentIssue	(	$args,
		$request
	)

Set Issue as current

Parameters

$args	array
$request	PKPRequest

Definition at line 591 of file IssueGridHandler.inc.php.

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

◆ unpublishIssue()

IssueGridHandler::unpublishIssue	(	$args,
		$request
	)

Unpublish a previously-published issue

Parameters

$args	array
$request	PKPRequest

Definition at line 540 of file IssueGridHandler.inc.php.

References HookRegistry\call(), PKPServices\get(), PKPHandler\getAuthorizedContextObject(), and DAORegistry\getDAO().

◆ updateAccess()

IssueGridHandler::updateAccess	(	$args,
		$request
	)

Update an issue's access settings

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 274 of file IssueGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and DAO\getDataChangedEvent().

◆ updateIdentifiers()

IssueGridHandler::updateIdentifiers	(	$args,
		$request
	)

Update issue pub ids

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 356 of file IssueGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and DAO\getDataChangedEvent().

◆ updateIssue()

IssueGridHandler::updateIssue	(	$args,
		$request
	)

Update an issue

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 236 of file IssueGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and DAO\getDataChangedEvent().

◆ uploadFile()

IssueGridHandler::uploadFile	(	$args,
		$request
	)

An action to upload an issue file. Used for issue cover images.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

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

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

IssueGridHandler.inc.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addCenterColumns()

◆ access()

◆ addIssue()

◆ authorize()

◆ clearIssueObjectsPubIds()

◆ clearPubId()

◆ deleteCoverImage()

◆ deleteIssue()

◆ editIssue()

◆ editIssueData()

◆ getAssignPublicIdentifiersFormTemplate()

◆ getRowInstance()

◆ identifiers()

◆ initialize()

◆ issueGalleys()

◆ issueToc()

◆ publishIssue()

◆ setCurrentIssue()

◆ unpublishIssue()

◆ updateAccess()

◆ updateIdentifiers()

◆ updateIssue()

◆ uploadFile()