Inheritance diagram for ContextGridHandler:

Public Member Functions
	__construct ()

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

	createContext ($args, $request)

	deleteContext ($args, $request)

	editContext ($args, $request)

	getDataElementSequence ($gridDataElement)

	getPublishChangeEvents ()

	initFeatures ($request, $args)

	initialize ($request, $args=null)

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

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

	getRequestArg ($key)

	getRequestArgs ()

	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)

Protected Member Functions
	getRowInstance ()

	loadData ($request, $filter=null)

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

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

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

Constructor & Destructor Documentation

◆ __construct()

ContextGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 23 of file ContextGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

ContextGridHandler::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 39 of file ContextGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ createContext()

ContextGridHandler::createContext	(	$args,
		$request
	)

Add a new context.

Parameters

$args	array
$request	PKPRequest

Definition at line 183 of file ContextGridHandler.inc.php.

References editContext().

◆ deleteContext()

ContextGridHandler::deleteContext	(	$args,
		$request
	)

Delete a context.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 250 of file ContextGridHandler.inc.php.

References PKPServices\get(), and DAO\getDataChangedEvent().

◆ editContext()

ContextGridHandler::editContext	(	$args,
		$request
	)

Edit an existing context.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 194 of file ContextGridHandler.inc.php.

References PKPServices\get(), PKPLocale\getAllLocales(), and PKPTemplateManager\getManager().

Referenced by createContext().

◆ getDataElementSequence()

ContextGridHandler::getDataElementSequence ( $gridDataElement )

Override to return the data element sequence value.

Parameters

$gridDataElement mixed

Returns: int

Reimplemented from GridHandler.

Definition at line 153 of file ContextGridHandler.inc.php.

◆ getPublishChangeEvents()

ContextGridHandler::getPublishChangeEvents ( )

Get the list of "publish data changed" events. Used to update the site context switcher upon create/delete.

Returns: array

Reimplemented from GridHandler.

Definition at line 170 of file ContextGridHandler.inc.php.

◆ getRowInstance()

ContextGridHandler::getRowInstance ( )

protected

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

Returns: GridRow; UserGridRow

Reimplemented from GridHandler.

Definition at line 126 of file ContextGridHandler.inc.php.

◆ initFeatures()

ContextGridHandler::initFeatures	(	$request,
		$args
	)

Reimplemented from GridHandler.

Definition at line 160 of file ContextGridHandler.inc.php.

◆ initialize()

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

See also: PKPHandler::initialize()

Parameters

$request	PKPRequest
$args	array optional

Reimplemented from GridHandler.

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

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

◆ loadData()

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

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.