Inheritance diagram for CategoryGridHandler:

Public Member Functions
	__construct ($dataProvider=null)

	fetchCategory ($args, $request)

	getCategoryItemsCount ($categoryElement, $request)

	getCurrentCategoryId ()

	getDataElementInCategorySequence ($categoryId, &$gridDataElement)

	getEmptyCategoryRowText ()

&	getGridCategoryDataElements ($request, $categoryElement)

	getJSHandler ()

	getRequestArgs ()

	hasGridDataElementsInCategory ($categoryElement, $request)

	initialize ($request, $args=null)

	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)

Data Fields
	$_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 Member Functions
	doSpecificFetchGridActions ($args, $request, $templateMgr)

	getCategoryRowIdParameterName ()

	getCategoryRowInstance ()

	getRequestedCategoryRow ($request, $args)

	getRowDataElement ($request, &$rowId)

	getRowsSequence ($request)

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

	renderRowInternally ($request, $row)

	setFirstDataColumn ()

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

&	getDataElementFromRequest ($request, &$elementId)

	getFilterForm ()

	getFilterSelectionData ($request)

	getRowInstance ()

	initFeatures ($request, $args)

	isFilterFormCollapsible ()

	loadData ($request, $filter)

	noAutocompleteResults ()

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

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

Protected Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Class defining basic operations for handling HTML grids with categories.

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

Constructor & Destructor Documentation

◆ __construct()

CategoryGridHandler::__construct ( $dataProvider = null )

Constructor.

Reimplemented from GridHandler.

Reimplemented in PluginGridHandler, and LibraryFileGridHandler.

Definition at line 47 of file CategoryGridHandler.inc.php.

References GridHandler\addColumn().

Member Function Documentation

◆ doSpecificFetchGridActions()

CategoryGridHandler::doSpecificFetchGridActions	(	$args,
		$request,
		$templateMgr
	)

protected

See also: GridHandler::doSpecificFetchGridActions()

Reimplemented from GridHandler.

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

◆ fetchCategory()

CategoryGridHandler::fetchCategory	(	$args,
		$request
	)

Render a category with all the rows inside of it.

Parameters

$args	array
$request	Request

Returns: string the serialized row JSON message or a flag that indicates that the row has not been found.

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

References getRequestedCategoryRow(), and setFirstDataColumn().

◆ getCategoryItemsCount()

CategoryGridHandler::getCategoryItemsCount	(	$categoryElement,
		$request
	)

Get the number of elements inside the passed category element.

Parameters

$categoryElement	mixed
$request	PKPRequest

Returns: int

Definition at line 165 of file CategoryGridHandler.inc.php.

References getGridCategoryDataElements().

◆ getCategoryRowIdParameterName()

CategoryGridHandler::getCategoryRowIdParameterName ( )

protected

Get the category row id parameter name.

Returns: string

Reimplemented in StageParticipantGridHandler, PluginGridHandler, CategoryCategoryGridHandler, and TocGridHandler.

Definition at line 393 of file CategoryGridHandler.inc.php.

Referenced by getRequestArgs(), and renderRowInternally().

◆ getCategoryRowInstance()

CategoryGridHandler::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 in StageParticipantGridHandler, CategoryCategoryGridHandler, PluginGridHandler, SelectableSubmissionFileListCategoryGridHandler, TocGridHandler, and LibraryFileGridHandler.

Definition at line 384 of file CategoryGridHandler.inc.php.

◆ getCurrentCategoryId()

CategoryGridHandler::getCurrentCategoryId ( )

Get the category id that this grid is currently rendering.

Parameters

int

Definition at line 79 of file CategoryGridHandler.inc.php.

References $_currentCategoryId.

Referenced by getRowsSequence().

◆ getDataElementInCategorySequence()

CategoryGridHandler::getDataElementInCategorySequence	(		$categoryId,
		&	$gridDataElement
	)

Override to return the data element sequence value inside the passed category, if needed.

Parameters

$categoryId	int The data element category id.
$gridDataElement	mixed The element to return the sequence.

Returns: int

Reimplemented in TocGridHandler, and CategoryCategoryGridHandler.

Definition at line 91 of file CategoryGridHandler.inc.php.

◆ getEmptyCategoryRowText()

CategoryGridHandler::getEmptyCategoryRowText ( )

Get the empty rows text for a category.

Returns: string

Definition at line 63 of file CategoryGridHandler.inc.php.

References $_emptyCategoryRowText.

◆ getGridCategoryDataElements()

& CategoryGridHandler::getGridCategoryDataElements	(	$request,
		$categoryElement
	)

Get the grid category data.

Parameters

$request	PKPRequest
$categoryElement	mixed The category element.

Returns: array

Definition at line 123 of file CategoryGridHandler.inc.php.

References GridHandler\getFilterSelectionData(), GridHandler\getGridDataElements(), loadCategoryData(), and setGridCategoryDataElements().

Referenced by getCategoryItemsCount(), SelectableSubmissionFileListCategoryGridHandler\getFilesToDownload(), getRowDataElement(), getRowsSequence(), hasGridDataElementsInCategory(), ManageCopyeditFilesGridHandler\updateCopyeditFiles(), ManageFinalDraftFilesGridHandler\updateFinalDraftFiles(), ManageProofFilesGridHandler\updateProofFiles(), ManageQueryNoteFilesGridHandler\updateQueryNoteFiles(), and ManageReviewFilesGridHandler\updateReviewFiles().

◆ getJSHandler()

CategoryGridHandler::getJSHandler ( )

Get the js handler for this component.

Returns: string

Reimplemented from GridHandler.

Reimplemented in StageParticipantGridHandler.

Definition at line 260 of file CategoryGridHandler.inc.php.

◆ getRequestArgs()

CategoryGridHandler::getRequestArgs ( )

See also: GridHandler::getRequestArgs()

Reimplemented from GridHandler.

Reimplemented in StageParticipantGridHandler, TocGridHandler, ManageReviewFilesGridHandler, and ManageProofFilesGridHandler.

Definition at line 241 of file CategoryGridHandler.inc.php.

References $_currentCategoryId, and getCategoryRowIdParameterName().

Referenced by setUrls().

◆ getRequestedCategoryRow()

CategoryGridHandler::getRequestedCategoryRow	(	$request,
		$args
	)

protected

Tries to identify the data element in the grids data source that corresponds to the requested row id. Raises a fatal error if such an element cannot be found.

Parameters

$request	PKPRequest
$args	array

Returns: GridRow the requested grid row, already configured with id and data or null if the row could not been found.

Definition at line 352 of file CategoryGridHandler.inc.php.

References getRowDataElement().

Referenced by fetchCategory().

◆ getRowDataElement()

CategoryGridHandler::getRowDataElement	(		$request,
		&	$rowId
	)

protected

Retrieve a single data element from the grid's data source corresponding to the given row id. If none is found then return null.

Parameters

$request	PKPRequest
$rowId	string The row ID; reference permits modification.

Returns: mixed

Reimplemented from GridHandler.

Definition at line 292 of file CategoryGridHandler.inc.php.

References getGridCategoryDataElements().

Referenced by getRequestedCategoryRow().

◆ getRowsSequence()

CategoryGridHandler::getRowsSequence ( $request )

protected

Return the sequence map of the current loaded grid items. This is not the sequence value of the data represented by the row, it's just the mapping of the rows sequence, in the order that they are loaded. To handle grid items ordering, see OrderItemsFeature class.

Parameters

$request PKPRequest