Inheritance diagram for PluginGridHandler:

Public Member Functions
	__construct ($roles)

	_showUploadPluginForm ($function, $request)

	deletePlugin ($args, $request)

	disable ($args, $request)

	enable ($args, $request)

	getCategoryRowIdParameterName ()

	getFilterSelectionData ($request)

	initialize ($request, $args=null)

	loadCategoryData ($request, &$categoryDataElement, $filter=null)

	manage ($args, $request)

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

	saveUploadPlugin ($args, $request)

	upgradePlugin ($args, $request)

	uploadPlugin ($args, $request)

	uploadPluginFile ($args, $request)

Public Member Functions inherited from CategoryGridHandler
	fetchCategory ($args, $request)

	getCategoryItemsCount ($categoryElement, $request)

	getCurrentCategoryId ()

	getDataElementInCategorySequence ($categoryId, &$gridDataElement)

	getEmptyCategoryRowText ()

&	getGridCategoryDataElements ($request, $categoryElement)

	getJSHandler ()

	getRequestArgs ()

	hasGridDataElementsInCategory ($categoryElement, $request)

	isDataElementInCategorySelected ($categoryId, &$gridDataElement)

	setDataElementInCategorySequence ($categoryId, &$gridDataElement, $newSequence)

	setEmptyCategoryRowText ($translationKey)

	setGridCategoryDataElements ($request, $categoryElementId, $data)

	setUrls ($request, $extraUrls=array())

Public Member Functions inherited from GridHandler
	addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)

	addColumn ($column)

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

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

	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)

Public Member Functions inherited from PKPHandler
	__construct ()

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

	getFilterForm ()

	loadData ($request, $filter)

Protected Member Functions inherited from CategoryGridHandler
	doSpecificFetchGridActions ($args, $request, $templateMgr)

	getRequestedCategoryRow ($request, $args)

	getRowDataElement ($request, &$rowId)

	getRowsSequence ($request)

	renderRowInternally ($request, $row)

	setFirstDataColumn ()

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

&	getDataElementFromRequest ($request, &$elementId)

	getRowInstance ()

	initFeatures ($request, $args)

	isFilterFormCollapsible ()

	noAutocompleteResults ()

	renderGridBodyPartsInternally ($request)

	renderRowsInternally ($request, &$elements)

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 CategoryGridHandler
	$_categoryData

	$_currentCategoryId = null

	$_emptyCategoryRowText = 'grid.noItems'

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

Definition at line 20 of file PluginGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PluginGridHandler::__construct ( $roles )

Constructor

Parameters

$roles array

Reimplemented from CategoryGridHandler.

Definition at line 25 of file PluginGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _showUploadPluginForm()

PluginGridHandler::_showUploadPluginForm	(	$function,
		$request
	)

Fetch upload plugin form.

Parameters

$function	string
$request	PKPRequest Request object

Returns: JSONMessage JSON object

Definition at line 391 of file PluginGridHandler.inc.php.

Referenced by upgradePlugin(), and uploadPlugin().

◆ deletePlugin()

PluginGridHandler::deletePlugin	(	$args,
		$request
	)

Delete plugin.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 346 of file PluginGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), Core\getBaseDir(), PluginRegistry\getCategories(), DAORegistry\getDAO(), and DAO\getDataChangedEvent().

◆ disable()

PluginGridHandler::disable	(	$args,
		$request
	)

Disable a plugin.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 263 of file PluginGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and DAO\getDataChangedEvent().

◆ enable()

PluginGridHandler::enable	(	$args,
		$request
	)

Enable a plugin.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 243 of file PluginGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and DAO\getDataChangedEvent().

◆ getCategoryRowIdParameterName()

PluginGridHandler::getCategoryRowIdParameterName ( )

Get the category row id parameter name.

Returns: string

Reimplemented from CategoryGridHandler.

Definition at line 206 of file PluginGridHandler.inc.php.

◆ getCategoryRowInstance()

PluginGridHandler::getCategoryRowInstance ( )

protected

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

Returns: CategoryGridRow

Reimplemented from CategoryGridHandler.

Definition at line 146 of file PluginGridHandler.inc.php.

◆ getFilterForm()

PluginGridHandler::getFilterForm ( )

protected

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

Returns: Form|string

Reimplemented from GridHandler.

Definition at line 111 of file PluginGridHandler.inc.php.

◆ getFilterSelectionData()

PluginGridHandler::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 118 of file PluginGridHandler.inc.php.

◆ initialize()

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

See also: PKPHandler::initialize()

Parameters

$request	PKPRequest
$args	array optional

Reimplemented from CategoryGridHandler.

Definition at line 42 of file PluginGridHandler.inc.php.

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

◆ loadCategoryData()

PluginGridHandler::loadCategoryData	(		$request,
		&	$categoryDataElement,
			$filter = `null`
	)

Implement this method to load category data into the grid.

Parameters

$request	PKPRequest
$categoryDataElement	mixed
$filter	mixed

Returns: array

Reimplemented from CategoryGridHandler.

Reimplemented in SettingsPluginGridHandler.

Definition at line 154 of file PluginGridHandler.inc.php.

References Core\getCurrentDate(), DAORegistry\getDAO(), PluginRegistry\loadCategory(), and VersionCheck\parseVersionXML().

◆ loadData()

PluginGridHandler::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 213 of file PluginGridHandler.inc.php.

References PluginRegistry\getCategories().

Referenced by renderFilter().

◆ manage()

PluginGridHandler::manage	(	$args,
		$request
	)

Manage a plugin.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 232 of file PluginGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ renderFilter()

PluginGridHandler::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 132 of file PluginGridHandler.inc.php.

References loadData().

◆ saveUploadPlugin()

PluginGridHandler::saveUploadPlugin	(	$args,
		$request
	)

Save upload plugin file form.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 326 of file PluginGridHandler.inc.php.

References DAO\getDataChangedEvent().

◆ upgradePlugin()

PluginGridHandler::upgradePlugin	(	$args,
		$request
	)

Show upload plugin form to update an existing plugin.

Parameters

$args	array
$request	PKPRequest

Returns: string

Definition at line 293 of file PluginGridHandler.inc.php.

References _showUploadPluginForm().

◆ uploadPlugin()

PluginGridHandler::uploadPlugin	(	$args,
		$request
	)

Show upload plugin form to upload a new plugin.

Parameters

$args	array
$request	PKPRequest

Returns: string

Definition at line 283 of file PluginGridHandler.inc.php.

References _showUploadPluginForm().

◆ uploadPluginFile()

PluginGridHandler::uploadPluginFile	(	$args,
		$request
	)

Upload a plugin file.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 303 of file PluginGridHandler.inc.php.

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

PluginGridHandler.inc.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _showUploadPluginForm()

◆ deletePlugin()

◆ disable()

◆ enable()

◆ getCategoryRowIdParameterName()

◆ getCategoryRowInstance()

◆ getFilterForm()

◆ getFilterSelectionData()

◆ initialize()

◆ loadCategoryData()

◆ loadData()

◆ manage()

◆ renderFilter()

◆ saveUploadPlugin()

◆ upgradePlugin()

◆ uploadPlugin()

◆ uploadPluginFile()