Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
CategoryGridHandler Class Reference
Inheritance diagram for CategoryGridHandler:
GridHandler PKPHandler

Public Member Functions

_getInitializedCategoryRowInstance (&$request, $elementId, &$element)
 
 _renderCategoriesInternally (&$request)
 
 _renderCategoryInternally (&$request, &$categoryRow)
 
 CategoryGridHandler ($dataProvider=null)
 
 doSpecificFetchGridActions ($args, $request, &$templateMgr)
 
 fetchCategory (&$args, &$request)
 
getCategoryData (&$categoryDataElement, $filter=null)
 
 getCategoryDataElementSequence (&$gridDataElement)
 
 getCategoryRowIdParameterName ()
 
getCategoryRowInstance ()
 
 getEmptyCategoryRowText ()
 
 getJSHandler ()
 
 getRequestArgs ()
 
getRequestedCategoryRow ($request, $args)
 
 getRowDataElement ($request, $rowId)
 
 renderRowInternally ($request, $row)
 
 saveCategoryDataElementSequence (&$gridDataElement, $newSequence)
 
 saveRowDataElementSequence ($gridDataElement, $categoryId, $newSequence)
 
 setEmptyCategoryRowText ($translationKey)
 
 setFirstDataColumn ()
 
 setUrls (&$request)
 
- Public Member Functions inherited from GridHandler
 _addFeatures ($features)
 
 _fixColumnWidths ()
 
_getInitializedRowInstance (&$request, $elementId, &$element, $isModified=false)
 
 _renderCellInternally (&$request, &$row, &$column)
 
 _renderGridBodyPartsInternally (&$request)
 
 _renderRowsInternally (&$request, &$elements)
 
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn (&$column)
 
 authorize (&$request, &$args, $roleAssignments)
 
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, &$request, &$templateMgr)
 
 fetchCell (&$args, &$request)
 
 fetchGrid ($args, &$request)
 
 fetchRow (&$args, &$request)
 
 getActions ($position=GRID_ACTION_POSITION_ABOVE)
 
getColumn ($columnId)
 
getColumns ()
 
getColumnsByFlag ($flag)
 
 getColumnsCount ($flag)
 
getDataElementFromRequest (&$request, &$elementId)
 
getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getInstructions ()
 
 getIsSubcomponent ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRangeInfo ($rangeName, $contextData=null)
 
 getRequestArg ($key)
 
 getRequestArgs ()
 
getRequestedRow ($request, $args)
 
 getRowDataElement ($request, $rowId)
 
 getRowDataElementSequence (&$gridDataElement)
 
getRowInstance ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 GridHandler ($dataProvider=null)
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 initFeatures (&$request, $args)
 
 initialize (&$request, $args=null)
 
loadData (&$request, $filter)
 
 noAutocompleteResults ()
 
 renderFilter ($request, $filterData=array())
 
 renderRowInternally (&$request, &$row)
 
 saveRowDataElementSequence (&$request, $rowId, &$gridDataElement, $newSequence)
 
 saveSequence ($args, &$request)
 
 setEmptyRowText ($emptyRowText)
 
 setFirstDataColumn ()
 
 setFootNote ($footNote)
 
 setGridDataElements (&$data)
 
 setInstructions ($instructions)
 
 setTemplate ($template)
 
 setTitle ($title)
 
 setUrls (&$request, $extraUrls=array())
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy (&$authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize (&$request, &$args, $roleAssignments)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
getRangeInfo ($rangeName, $contextData=null)
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 hashPageContext ($contextData=array())
 
 index ()
 
 initialize (&$request, $args=null)
 
 PKPHandler ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Detailed Description

Class defining basic operations for handling HTML grids with categories.

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

Member Function Documentation

& CategoryGridHandler::_getInitializedCategoryRowInstance ( $request,
  $elementId,
$element 
)

Instantiate a new row.

Parameters
$requestRequest
$elementIdstring
$elementmixed
$isModifiedboolean optional
Returns
GridRow

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

References GridHandler\callFeaturesHook(), getCategoryRowInstance(), PKPHandler\getId(), and getRequestArgs().

Referenced by _renderCategoriesInternally(), and getRequestedCategoryRow().

CategoryGridHandler::_renderCategoriesInternally ( $request)

Render all the categories internally

Parameters
$requestPKPRequest

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

References _getInitializedCategoryRowInstance(), _renderCategoryInternally(), and GridHandler\getGridDataElements().

Referenced by doSpecificFetchGridActions().

CategoryGridHandler::_renderCategoryInternally ( $request,
$categoryRow 
)

Render a category row and its data.

Parameters
$requestPKPRequest
$categoryRowGridCategoryRow
Returns
String HTML for all the rows (including category)

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

References GridHandler\_renderRowsInternally(), getCategoryData(), GridHandler\getColumns(), GridHandler\getFilterSelectionData(), and renderRowInternally().

Referenced by _renderCategoriesInternally(), and fetchCategory().

CategoryGridHandler::CategoryGridHandler (   $dataProvider = null)

Constructor.

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

References GridHandler\addColumn().

CategoryGridHandler::doSpecificFetchGridActions (   $args,
  $request,
$templateMgr 
)
See Also
GridHandler::doSpecificFetchGridActions($args, $request)

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

References _renderCategoriesInternally().

CategoryGridHandler::fetchCategory ( $args,
$request 
)

Render a category with all the rows inside of it.

Parameters
$argsarray
$requestRequest
Returns
string the serialized row JSON message or a flag that indicates that the row has not been found.

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

References _renderCategoryInternally(), getRequestedCategoryRow(), and setFirstDataColumn().

& CategoryGridHandler::getCategoryData ( $categoryDataElement,
  $filter = null 
)

Fetch the contents of a category.

Parameters
$categoryDataElementmixed
Returns
array

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

References GridHandler\getDataProvider().

Referenced by _renderCategoryInternally(), and getRowDataElement().

CategoryGridHandler::getCategoryDataElementSequence ( $gridDataElement)

Get the category data element sequence value.

Parameters
$gridDataElementmixed
Returns
int

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

CategoryGridHandler::getCategoryRowIdParameterName ( )

Get the category row id parameter name.

Returns
string

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

Referenced by getRequestArgs(), and renderRowInternally().

& CategoryGridHandler::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

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

Referenced by _getInitializedCategoryRowInstance().

CategoryGridHandler::getEmptyCategoryRowText ( )

Get the empty rows text for a category.

Returns
string

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

CategoryGridHandler::getJSHandler ( )
See Also
GridHandler::getJSHandler()

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

CategoryGridHandler::getRequestArgs ( )
& CategoryGridHandler::getRequestedCategoryRow (   $request,
  $args 
)

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
$requestPKPRequest
$argsarray
Returns
GridRow the requested grid row, already configured with id and data or null if the row could not been found.

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

References _getInitializedCategoryRowInstance(), and getRowDataElement().

Referenced by fetchCategory().

CategoryGridHandler::getRowDataElement (   $request,
  $rowId 
)
CategoryGridHandler::renderRowInternally (   $request,
  $row 
)
CategoryGridHandler::saveCategoryDataElementSequence ( $gridDataElement,
  $newSequence 
)

Operation to save the category data element new sequence.

Parameters
$gridDataElementmixed
$newSequenceint

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

CategoryGridHandler::saveRowDataElementSequence (   $gridDataElement,
  $categoryId,
  $newSequence 
)
CategoryGridHandler::setEmptyCategoryRowText (   $translationKey)

Set the empty rows text for a category.

Parameters
string$translationKey

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

CategoryGridHandler::setFirstDataColumn ( )
See Also
GridHandler::setFirstDataColumn()

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

References GridHandler\getColumns().

Referenced by fetchCategory().

CategoryGridHandler::setUrls ( $request)
See Also
GridHandler::setUrls()

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


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