Inheritance diagram for QueryNotesGridHandler:

Public Member Functions
	__construct ()

	addNote ($args, $request)

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

	deleteNote ($args, $request)

	getCanManage ($note)

	getQuery ()

	getRequestArgs ()

	getRowInstance ()

	getStageId ()

	getSubmission ()

	initialize ($request, $args=null)

	insertNote ($args, $request)

	loadData ($request, $filter=null)

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
	$_user

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)

	initFeatures ($request, $args)

	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 23 of file QueryNotesGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

QueryNotesGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addNote()

QueryNotesGridHandler::addNote	(	$args,
		$request
	)

Present the form to add a new note.

Parameters

$args	array
$request	PKPRequest

Definition at line 167 of file QueryNotesGridHandler.inc.php.

References getQuery(), and getRequestArgs().

◆ authorize()

QueryNotesGridHandler::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 75 of file QueryNotesGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ deleteNote()

QueryNotesGridHandler::deleteNote	(	$args,
		$request
	)

Delete a query note.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

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

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

◆ getCanManage()

QueryNotesGridHandler::getCanManage ( $note )

Determine whether the current user can manage (delete) a note.

Parameters

$note Note optional

Returns: boolean

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

References PKPHandler\getAuthorizedContextObject().

Referenced by deleteNote(), and loadData().

◆ getQuery()

QueryNotesGridHandler::getQuery ( )

Get the query.

Returns: Query

Definition at line 56 of file QueryNotesGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by addNote(), deleteNote(), getRequestArgs(), getRowInstance(), insertNote(), and loadData().

◆ getRequestArgs()

QueryNotesGridHandler::getRequestArgs ( )

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

Returns: array

Reimplemented from GridHandler.

Definition at line 144 of file QueryNotesGridHandler.inc.php.

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

Referenced by addNote(), getRowInstance(), and insertNote().

◆ getRowInstance()

QueryNotesGridHandler::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; QueryNotesGridRow

Reimplemented from GridHandler.

Definition at line 134 of file QueryNotesGridHandler.inc.php.

References getQuery(), and getRequestArgs().

◆ getStageId()

QueryNotesGridHandler::getStageId ( )

Get the stage id.

Returns: integer

Definition at line 64 of file QueryNotesGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by getRequestArgs().

◆ getSubmission()

QueryNotesGridHandler::getSubmission ( )

Get the authorized submission.

Returns: Submission

Definition at line 48 of file QueryNotesGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by getRequestArgs(), and initialize().

◆ initialize()

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

See also: PKPHandler::initialize()

Parameters

$request	PKPRequest
$args	array optional

Reimplemented from GridHandler.

Definition at line 87 of file QueryNotesGridHandler.inc.php.

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

◆ insertNote()

QueryNotesGridHandler::insertNote	(	$args,
		$request
	)

Insert a new note.

Parameters

$args	array
$request	PKPRequest

Definition at line 179 of file QueryNotesGridHandler.inc.php.

References DAO\getDataChangedEvent(), PKPHandler\getId(), getQuery(), and getRequestArgs().

◆ loadData()

QueryNotesGridHandler::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 155 of file QueryNotesGridHandler.inc.php.

References getCanManage(), and getQuery().

Field Documentation

◆ $_user

User QueryNotesGridHandler::$_user

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

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

QueryNotesGridHandler.inc.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addNote()

◆ authorize()

◆ deleteNote()

◆ getCanManage()

◆ getQuery()

◆ getRequestArgs()

◆ getRowInstance()

◆ getStageId()

◆ getSubmission()

◆ initialize()

◆ insertNote()

◆ loadData()

Field Documentation

◆ $_user