Inheritance diagram for CategoryCategoryGridHandler:

Public Member Functions
	__construct ()

	_getCategoryForm ($request)

	_getContextId ()

	addCategory ($args, $request)

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

	deleteCategory ($args, $request)

	editCategory ($args, $request)

	getCategoryRowIdParameterName ()

	getCategoryRowInstance ()

	getDataElementInCategorySequence ($categoryId, &$category)

	getDataElementSequence ($gridDataElement)

	getRowInstance ()

	initFeatures ($request, $args)

	initialize ($request, $args=null)

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

	loadData ($request, $filter)

	setDataElementInCategorySequence ($parentCategoryId, &$category, $newSequence)

	setDataElementSequence ($request, $categoryId, $category, $newSequence)

	updateCategory ($args, $request)

	uploadImage ($args, $request)

Public Member Functions inherited from CategoryGridHandler
	__construct ($dataProvider=null)

	fetchCategory ($args, $request)

	getCategoryItemsCount ($categoryElement, $request)

	getCurrentCategoryId ()

	getEmptyCategoryRowText ()

&	getGridCategoryDataElements ($request, $categoryElement)

	getJSHandler ()

	getRequestArgs ()

	hasGridDataElementsInCategory ($categoryElement, $request)

	isDataElementInCategorySelected ($categoryId, &$gridDataElement)

	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)

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

	getPublishChangeEvents ()

	getRequestArg ($key)

	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)

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

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

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

	getFilterForm ()

	getFilterSelectionData ($request)

	isFilterFormCollapsible ()

	noAutocompleteResults ()

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

	renderGridBodyPartsInternally ($request)

	renderRowsInternally ($request, &$elements)

Protected Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Handle operations for category management operations.

Definition at line 26 of file CategoryCategoryGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

CategoryCategoryGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 32 of file CategoryCategoryGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _getCategoryForm()

CategoryCategoryGridHandler::_getCategoryForm ( $request )

Get a CategoryForm instance.

Parameters

$request Request

Returns: UserGroupForm

Definition at line 287 of file CategoryCategoryGridHandler.inc.php.

References _getContextId().

Referenced by editCategory(), and updateCategory().

◆ _getContextId()

CategoryCategoryGridHandler::_getContextId ( )

Get context id.

Returns: int

Definition at line 301 of file CategoryCategoryGridHandler.inc.php.

References $_contextId.

Referenced by _getCategoryForm(), loadCategoryData(), and loadData().

◆ addCategory()

CategoryCategoryGridHandler::addCategory	(	$args,
		$request
	)

Handle the add category operation.

Parameters

$args	array
$request	PKPRequest

Definition at line 198 of file CategoryCategoryGridHandler.inc.php.

References editCategory().

◆ authorize()

CategoryCategoryGridHandler::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 56 of file CategoryCategoryGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ deleteCategory()

CategoryCategoryGridHandler::deleteCategory	(	$args,
		$request
	)

Delete a category

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 240 of file CategoryCategoryGridHandler.inc.php.

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

◆ editCategory()

CategoryCategoryGridHandler::editCategory	(	$args,
		$request
	)

Handle the edit category operation.

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 208 of file CategoryCategoryGridHandler.inc.php.

References _getCategoryForm().

Referenced by addCategory().

◆ getCategoryRowIdParameterName()

CategoryCategoryGridHandler::getCategoryRowIdParameterName ( )

Get the category row id parameter name.

Returns: string

Reimplemented from CategoryGridHandler.

Definition at line 164 of file CategoryCategoryGridHandler.inc.php.

◆ getCategoryRowInstance()

CategoryCategoryGridHandler::getCategoryRowInstance ( )

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 179 of file CategoryCategoryGridHandler.inc.php.

◆ getDataElementInCategorySequence()

CategoryCategoryGridHandler::getDataElementInCategorySequence	(		$categoryId,
		&	$category
	)

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 from CategoryGridHandler.

Definition at line 132 of file CategoryCategoryGridHandler.inc.php.

◆ getDataElementSequence()

CategoryCategoryGridHandler::getDataElementSequence ( $gridDataElement )

Override to return the data element sequence value.

Parameters

$gridDataElement mixed

Returns: int

Reimplemented from GridHandler.

Definition at line 148 of file CategoryCategoryGridHandler.inc.php.

◆ getRowInstance()

CategoryCategoryGridHandler::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

Reimplemented from GridHandler.

Definition at line 171 of file CategoryCategoryGridHandler.inc.php.

◆ initFeatures()

CategoryCategoryGridHandler::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 121 of file CategoryCategoryGridHandler.inc.php.

◆ initialize()

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

See also: PKPHandler::initialize()

Parameters

$request	PKPRequest
$args	array optional

Reimplemented from CategoryGridHandler.

Definition at line 66 of file CategoryCategoryGridHandler.inc.php.

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

◆ loadCategoryData()

CategoryCategoryGridHandler::loadCategoryData	(		$request,
		&	$category,
			$filter = `null`
	)

Implement this method to load category data into the grid.

Parameters

$request	PKPRequest
$categoryDataElement	mixed
$filter	mixed

Returns: array

Reimplemented from CategoryGridHandler.

Definition at line 186 of file CategoryCategoryGridHandler.inc.php.

References _getContextId(), and DAORegistry\getDAO().

◆ loadData()

CategoryCategoryGridHandler::loadData	(	$request,
		$filter
	)

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.