Inheritance diagram for UserSelectGridHandler:

Public Member Functions
	__construct ()

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

	getFilterSelectionData ($request)

	getRequestArgs ()

	initFeatures ($request, $args)

	initialize ($request, $args=null)

	renderFilter ($request, $filterData=array())

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

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 Member Functions
	getFilterForm ()

	getFilterValues ($filter)

	getItemsNumber ()

	isFilterFormCollapsible ()

	loadData ($request, $filter)

Protected Member Functions inherited from GridHandler
	callFeaturesHook ($hookName, $args)

	doSpecificFetchGridActions ($args, $request, $templateMgr)

&	getDataElementFromRequest ($request, &$elementId)

	getRowDataElement ($request, &$rowId)

	getRowInstance ()

	getRowsSequence ($request)

	noAutocompleteResults ()

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

Protected Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Handle user selector grid requests.

Definition at line 19 of file UserSelectGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

UserSelectGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 29 of file UserSelectGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

UserSelectGridHandler::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 43 of file UserSelectGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ getFilterForm()

UserSelectGridHandler::getFilterForm ( )

protected

Returns a Form object or the path name of a filter template.

Returns: Form|string

Reimplemented from GridHandler.

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

◆ getFilterSelectionData()

UserSelectGridHandler::getFilterSelectionData ( $request )

Method that extracts the user's filter selection from the request either by instantiating the filter's Form object or by reading the request directly (if using a simple filter template only).

Parameters

$request PKPRequest

Returns: array

Reimplemented from GridHandler.

Definition at line 155 of file UserSelectGridHandler.inc.php.

◆ getFilterValues()

UserSelectGridHandler::getFilterValues ( $filter )

protected

Process filter values, assigning default ones if none was set.

Returns: array

Definition at line 204 of file UserSelectGridHandler.inc.php.

Referenced by loadData().

◆ getItemsNumber()

UserSelectGridHandler::getItemsNumber ( )

protected

Define how many items this grid will start loading.

Returns: int

Definition at line 195 of file UserSelectGridHandler.inc.php.

Referenced by initFeatures().

◆ getRequestArgs()

UserSelectGridHandler::getRequestArgs ( )

Get the grid request parameters. These are the parameters that uniquely identify the data within a grid.

NB: You should make sure to authorize and/or validate parameters before you publish them through this interface. Callers will assume that data accessed through this method will not have to be sanitized.

The default implementation tries to retrieve request parameters from a data provider if there is one.

Returns: array

Reimplemented from GridHandler.

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

References PKPHandler\getAuthorizedContextObject().

◆ initFeatures()

UserSelectGridHandler::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 114 of file UserSelectGridHandler.inc.php.

References getItemsNumber().

◆ initialize()

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

See also: PKPHandler::initialize()

Parameters

$request	PKPRequest
$args	array optional

Reimplemented from GridHandler.

Definition at line 55 of file UserSelectGridHandler.inc.php.

References GridHandler\addColumn(), PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), AppLocale\requireComponents(), and GridHandler\setTitle().

◆ isFilterFormCollapsible()

UserSelectGridHandler::isFilterFormCollapsible ( )

protected

Determine whether a filter form should be collapsible.

Returns: boolean

Reimplemented from GridHandler.

Definition at line 187 of file UserSelectGridHandler.inc.php.

◆ loadData()

UserSelectGridHandler::loadData	(	$request,
		$filter
	)

protected

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 123 of file UserSelectGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), getFilterValues(), GridHandler\getGridRangeInfo(), and PKPHandler\getId().

◆ renderFilter()

UserSelectGridHandler::renderFilter	(	$request,
		$filterData = `array()`
	)

Render the filter (a template).

Parameters

$request	PKPRequest
$filterData	Array Data to be used by the filter template.

Returns: string

Reimplemented from GridHandler.

Definition at line 135 of file UserSelectGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and PKPHandler\getId().

Field Documentation

◆ $_userGroupOptions

array UserSelectGridHandler::$_userGroupOptions

(user group ID => user group name) *

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

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

UserSelectGridHandler.inc.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ authorize()

◆ getFilterForm()

◆ getFilterSelectionData()

◆ getFilterValues()

◆ getItemsNumber()

◆ getRequestArgs()

◆ initFeatures()

◆ initialize()

◆ isFilterFormCollapsible()

◆ loadData()

◆ renderFilter()

Field Documentation

◆ $_userGroupOptions