Inheritance diagram for QueriesGridHandler:

Public Member Functions
	__construct ()

	_getCurrentUserCanLeave ($queryId)

	addQuery ($args, $request)

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

	closeQuery ($args, $request)

	deleteQuery ($args, $request)

	editQuery ($args, $request)

	getAccessHelper ()

	getAssocId ()

	getAssocType ()

	getCellProvider ()

	getDataElementSequence ($row)

	getQuery ()

	getQueryNotesGridHandlerName ()

	getRequestArgs ()

	getRowInstance ()

	getStageId ()

	getSubmission ()

	initFeatures ($request, $args)

	initialize ($request, $args=null)

	leaveQuery ($args, $request)

	loadData ($request, $filter=null)

	openQuery ($args, $request)

	participants ($args, $request)

	readQuery ($args, $request)

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

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

	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)

	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

	$_stageId

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

base PKP class to handle query grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

QueriesGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 39 of file QueriesGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _getCurrentUserCanLeave()

QueriesGridHandler::_getCurrentUserCanLeave ( $queryId )

Check if the current user can leave a query. Only allow if query has more than two participants.

Parameters

$queryId int

Returns: boolean

Definition at line 596 of file QueriesGridHandler.inc.php.

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

Referenced by leaveQuery(), participants(), and readQuery().

◆ addQuery()

QueriesGridHandler::addQuery	(	$args,
		$request
	)

Add a query

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 301 of file QueriesGridHandler.inc.php.

References getAccessHelper(), getAssocId(), getAssocType(), and getStageId().

◆ authorize()

QueriesGridHandler::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 117 of file QueriesGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ closeQuery()

QueriesGridHandler::closeQuery	(	$args,
		$request
	)

Close an open query.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

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

References getAccessHelper(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), and getQuery().

◆ deleteQuery()

QueriesGridHandler::deleteQuery	(	$args,
		$request
	)

Delete a query.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 321 of file QueriesGridHandler.inc.php.

References getAssocId(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), getQuery(), and getStageId().

◆ editQuery()

QueriesGridHandler::editQuery	(	$args,
		$request
	)

Edit a query

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 496 of file QueriesGridHandler.inc.php.

References getAccessHelper(), getAssocId(), getAssocType(), getQuery(), and getStageId().

◆ getAccessHelper()

QueriesGridHandler::getAccessHelper ( )

Get an instance of the queries grid access helper

Returns: QueriesGridAccessHelper

Definition at line 262 of file QueriesGridHandler.inc.php.

References PKPHandler\getAuthorizedContext().

Referenced by addQuery(), closeQuery(), editQuery(), getCellProvider(), getRowInstance(), initFeatures(), initialize(), loadData(), openQuery(), readQuery(), and updateQuery().

◆ getAssocId()

QueriesGridHandler::getAssocId ( )

Get the query assoc ID.

Returns: int

Definition at line 92 of file QueriesGridHandler.inc.php.

References getSubmission().

Referenced by addQuery(), deleteQuery(), editQuery(), loadData(), setDataElementSequence(), and updateQuery().

◆ getAssocType()

QueriesGridHandler::getAssocType ( )

Get the query assoc type.

Returns: int ASSOC_TYPE_...

Definition at line 84 of file QueriesGridHandler.inc.php.

Referenced by addQuery(), editQuery(), loadData(), setDataElementSequence(), and updateQuery().

◆ getCellProvider()

QueriesGridHandler::getCellProvider ( )

Create and return a data provider for this grid.

Returns: GridCellProvider

Definition at line 100 of file QueriesGridHandler.inc.php.

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

Referenced by initialize().

◆ getDataElementSequence()

QueriesGridHandler::getDataElementSequence ( $row )

Override to return the data element sequence value.

Parameters

$gridDataElement mixed

Returns: int

Reimplemented from GridHandler.

Definition at line 231 of file QueriesGridHandler.inc.php.

◆ getQuery()

QueriesGridHandler::getQuery ( )

Get the authorized query.

Returns: Query

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

References PKPHandler\getAuthorizedContextObject().

Referenced by closeQuery(), deleteQuery(), editQuery(), openQuery(), participants(), readQuery(), and updateQuery().

◆ getQueryNotesGridHandlerName()

QueriesGridHandler::getQueryNotesGridHandlerName ( )

Get the name of the query notes grid handler.

Returns: string

Definition at line 389 of file QueriesGridHandler.inc.php.

Referenced by readQuery().

◆ getRequestArgs()

QueriesGridHandler::getRequestArgs ( )

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

Returns: array

Reimplemented from GridHandler.

Definition at line 272 of file QueriesGridHandler.inc.php.

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

Referenced by initialize(), readQuery(), and updateQuery().

◆ getRowInstance()

QueriesGridHandler::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; QueriesGridRow

Reimplemented from GridHandler.

Definition at line 249 of file QueriesGridHandler.inc.php.

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

◆ getStageId()

QueriesGridHandler::getStageId ( )

Get the stage id.

Returns: integer

Definition at line 76 of file QueriesGridHandler.inc.php.

References $_stageId.

Referenced by addQuery(), deleteQuery(), editQuery(), getCellProvider(), getRequestArgs(), getRowInstance(), initFeatures(), initialize(), loadData(), and updateQuery().

◆ getSubmission()

QueriesGridHandler::getSubmission ( )

Get the authorized submission.

Returns: Submission

Definition at line 60 of file QueriesGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by getAssocId(), getCellProvider(), getRequestArgs(), and getRowInstance().

◆ initFeatures()

QueriesGridHandler::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 219 of file QueriesGridHandler.inc.php.

References getAccessHelper(), and getStageId().

◆ initialize()

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

See also: PKPHandler::initialize()

Parameters

$request	PKPRequest
$args	array optional

Reimplemented from GridHandler.

Definition at line 136 of file QueriesGridHandler.inc.php.

References GridHandler\addAction(), GridHandler\addColumn(), getAccessHelper(), getCellProvider(), getRequestArgs(), getStageId(), AppLocale\requireComponents(), and GridHandler\setTitle().

◆ leaveQuery()

QueriesGridHandler::leaveQuery	(	$args,
		$request
	)

Leave query

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 576 of file QueriesGridHandler.inc.php.

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

◆ loadData()

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

Returns: grid data

Reimplemented from GridHandler.

Definition at line 282 of file QueriesGridHandler.inc.php.

References getAccessHelper(), getAssocId(), getAssocType(), DAORegistry\getDAO(), and getStageId().

◆ openQuery()

QueriesGridHandler::openQuery	(	$args,
		$request
	)

Open a closed query.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 359 of file QueriesGridHandler.inc.php.

References getAccessHelper(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), and getQuery().

◆ participants()

QueriesGridHandler::participants	(	$args,
		$request
	)

Fetch the list of participants for a query

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 463 of file QueriesGridHandler.inc.php.

References _getCurrentUserCanLeave(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), and getQuery().

◆ readQuery()

QueriesGridHandler::readQuery	(	$args,
		$request
	)

Read a query

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 399 of file QueriesGridHandler.inc.php.

References _getCurrentUserCanLeave(), getAccessHelper(), PKPTemplateManager\getManager(), getQuery(), getQueryNotesGridHandlerName(), and getRequestArgs().

◆ setDataElementSequence()

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

Override to set the data element new sequence.

Parameters

$request	PKPRequest
$rowId	int
$gridDataElement	mixed
$newSequence	int

Reimplemented from GridHandler.

Definition at line 238 of file QueriesGridHandler.inc.php.

References getAssocId(), getAssocType(), and DAORegistry\getDAO().

◆ updateQuery()

QueriesGridHandler::updateQuery	(	$args,
		$request
	)

Save a query

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 519 of file QueriesGridHandler.inc.php.

References getAccessHelper(), getAssocId(), getAssocType(), DAO\getDataChangedEvent(), getQuery(), getRequestArgs(), and getStageId().

Field Documentation

◆ $_request

PKPRequest QueriesGridHandler::$_request

Definition at line 34 of file QueriesGridHandler.inc.php.

◆ $_stageId

integer QueriesGridHandler::$_stageId

WORKFLOW_STAGE_ID_...

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

Referenced by getStageId().

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

QueriesGridHandler.inc.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getCurrentUserCanLeave()

◆ addQuery()

◆ authorize()

◆ closeQuery()

◆ deleteQuery()

◆ editQuery()

◆ getAccessHelper()

◆ getAssocId()

◆ getAssocType()

◆ getCellProvider()

◆ getDataElementSequence()

◆ getQuery()

◆ getQueryNotesGridHandlerName()

◆ getRequestArgs()

◆ getRowInstance()

◆ getStageId()

◆ getSubmission()

◆ initFeatures()

◆ initialize()

◆ leaveQuery()

◆ loadData()

◆ openQuery()

◆ participants()

◆ readQuery()

◆ setDataElementSequence()

◆ updateQuery()

Field Documentation

◆ $_request

◆ $_stageId