Inheritance diagram for ArticleGalleyGridHandler:

Public Member Functions
	__construct ()

	addGalley ($args, $request)

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

	canEdit ()

	clearPubId ($args, $request)

	deleteGalley ($args, $request)

	editGalley ($args, $request)

	editGalleyTab ($args, $request)

	fetchRow ($args, $request)

	getDataElementSequence ($row)

	getGalley ()

	getJSHandler ()

	getPublication ()

	getRequestArgs ()

	getRowInstance ()

	getSubmission ()

	identifiers ($args, $request)

	initFeatures ($request, $args)

	initialize ($request, $args=null)

	loadData ($request, $filter=null)

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

	updateGalley ($args, $request)

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

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

	getPublishChangeEvents ()

	getRequestArg ($key)

	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)

Data Fields
	$_request

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

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

Protected Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Handle article galley grid requests.

Definition at line 22 of file ArticleGalleyGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

ArticleGalleyGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 33 of file ArticleGalleyGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addGalley()

ArticleGalleyGridHandler::addGalley	(	$args,
		$request
	)

Add a galley

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 273 of file ArticleGalleyGridHandler.inc.php.

References getPublication(), and getSubmission().

◆ authorize()

ArticleGalleyGridHandler::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 85 of file ArticleGalleyGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ canEdit()

ArticleGalleyGridHandler::canEdit ( )

Can the current user edit the galleys in this grid?

The user must have an allowed role in one of the assigned stages. If the user is not assigned, they can edit if they are an editor or admin.

Returns: boolean

Definition at line 452 of file ArticleGalleyGridHandler.inc.php.

References PKPServices\get(), PKPHandler\getAuthorizedContextObject(), and getPublication().

Referenced by getRowInstance(), initFeatures(), and initialize().

◆ clearPubId()

ArticleGalleyGridHandler::clearPubId	(	$args,
		$request
	)

Clear galley pub id

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 255 of file ArticleGalleyGridHandler.inc.php.

References Application\getRepresentationDAO(), and getSubmission().

◆ deleteGalley()

ArticleGalleyGridHandler::deleteGalley	(	$args,
		$request
	)

Delete a galley.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 290 of file ArticleGalleyGridHandler.inc.php.

References PKPServices\get(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), getGalley(), PKPHandler\getId(), getSubmission(), and Application\getSubmissionSearchIndex().

◆ editGalley()

ArticleGalleyGridHandler::editGalley	(	$args,
		$request
	)

Edit a galley metadata modal

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

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

References getGalley(), PKPHandler\getId(), PKPTemplateManager\getManager(), getPublication(), getSubmission(), and PluginRegistry\loadCategory().

◆ editGalleyTab()

ArticleGalleyGridHandler::editGalleyTab	(	$args,
		$request
	)

Edit a galley

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 381 of file ArticleGalleyGridHandler.inc.php.

References getGalley(), getPublication(), and getSubmission().

◆ fetchRow()

ArticleGalleyGridHandler::fetchRow	(	$args,
		$request
	)

Render a row and send it to the client. If the row no longer exists then inform the client.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object.

Reimplemented from GridHandler.

Definition at line 431 of file ArticleGalleyGridHandler.inc.php.

References GridHandler\getRequestedRow().

◆ getDataElementSequence()

ArticleGalleyGridHandler::getDataElementSequence ( $row )

Override to return the data element sequence value.

Parameters

$gridDataElement mixed

Returns: int

Reimplemented from GridHandler.

Definition at line 161 of file ArticleGalleyGridHandler.inc.php.

◆ getGalley()

ArticleGalleyGridHandler::getGalley ( )

Get the authorized galley.

Returns: ArticleGalley

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

References PKPHandler\getAuthorizedContextObject().

Referenced by deleteGalley(), editGalley(), editGalleyTab(), and updateGalley().

◆ getJSHandler()

ArticleGalleyGridHandler::getJSHandler ( )

See also: GridHandler::getJSHandler()

Reimplemented from GridHandler.

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

◆ getPublication()

ArticleGalleyGridHandler::getPublication ( )

Get the authorized publication.

Returns: Publication

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

References PKPHandler\getAuthorizedContextObject().

Referenced by addGalley(), canEdit(), editGalley(), editGalleyTab(), getRequestArgs(), getRowInstance(), initialize(), loadData(), and updateGalley().

◆ getRequestArgs()

ArticleGalleyGridHandler::getRequestArgs ( )

Get the arguments that will identify the data in the grid. Overridden by child grids.

Returns: array

Reimplemented from GridHandler.

Definition at line 196 of file ArticleGalleyGridHandler.inc.php.

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

Referenced by updateIdentifiers().

◆ getRowInstance()

ArticleGalleyGridHandler::getRowInstance ( )

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

Returns: GridRow; ArticleGalleyGridRow

Reimplemented from GridHandler.

Definition at line 182 of file ArticleGalleyGridHandler.inc.php.

References canEdit(), getPublication(), and getSubmission().

◆ getSubmission()

ArticleGalleyGridHandler::getSubmission ( )

Get the authorized submission.

Returns: Submission

Definition at line 51 of file ArticleGalleyGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by addGalley(), clearPubId(), deleteGalley(), editGalley(), editGalleyTab(), getRequestArgs(), getRowInstance(), initialize(), and updateGalley().

◆ identifiers()

ArticleGalleyGridHandler::identifiers	(	$args,
		$request
	)

Edit article galley pub ids

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

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

References Application\getRepresentationDAO().

◆ initFeatures()

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

$request	PKPRequest
$args	array

Returns: array Array with initialized grid features objects.

Reimplemented from GridHandler.

Definition at line 149 of file ArticleGalleyGridHandler.inc.php.

References canEdit().

◆ initialize()

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

See also: PKPHandler::initialize()

Parameters

$request	PKPRequest
$args	array optional

Reimplemented from GridHandler.

Definition at line 105 of file ArticleGalleyGridHandler.inc.php.

References GridHandler\addAction(), GridHandler\addColumn(), canEdit(), getPublication(), getSubmission(), AppLocale\requireComponents(), and GridHandler\setTitle().

◆ loadData()

ArticleGalleyGridHandler::loadData	(	$request,
		$filter = `null`
	)

Implement this method to load data into the grid.

Parameters

$request	PKPRequest
$filter	array 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.