Open Journal Systems  3.3.0
NavigationMenuItemsGridHandler Class Reference
Inheritance diagram for NavigationMenuItemsGridHandler:
GridHandler PKPHandler

Public Member Functions

 __construct ()
 
 addNavigationMenuItem ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 deleteNavigationMenuItem ($args, $request)
 
 editNavigationMenuItem ($args, $request)
 
 initialize ($request, $args=null)
 
 updateNavigationMenuItem ($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)
 
 getDataElementSequence ($gridDataElement)
 
 getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 
 getIsSubcomponent ()
 
 getItemIterator ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestArgs ()
 
 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)
 
 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)
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getRowDataElement ($request, &$rowId)
 
 getRowsSequence ($request)
 
 initFeatures ($request, $args)
 
 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 NavigationMenuItems grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

NavigationMenuItemsGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addNavigationMenuItem()

NavigationMenuItemsGridHandler::addNavigationMenuItem (   $args,
  $request 
)

Add NavigationMenuItem

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

Definition at line 214 of file NavigationMenuItemsGridHandler.inc.php.

◆ authorize()

NavigationMenuItemsGridHandler::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
$requestRequest
$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
Returns
boolean

Reimplemented from GridHandler.

Definition at line 45 of file NavigationMenuItemsGridHandler.inc.php.

References PKPHandler\addPolicy(), and DAORegistry\getDAO().

◆ deleteNavigationMenuItem()

NavigationMenuItemsGridHandler::deleteNavigationMenuItem (   $args,
  $request 
)

Delete a navigation Menu item.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 237 of file NavigationMenuItemsGridHandler.inc.php.

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

◆ editNavigationMenuItem()

NavigationMenuItemsGridHandler::editNavigationMenuItem (   $args,
  $request 
)

Display form to edit a navigation menu item object.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 193 of file NavigationMenuItemsGridHandler.inc.php.

◆ getRowInstance()

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

Reimplemented from GridHandler.

Definition at line 134 of file NavigationMenuItemsGridHandler.inc.php.

◆ initialize()

NavigationMenuItemsGridHandler::initialize (   $request,
  $args = null 
)

◆ loadData()

NavigationMenuItemsGridHandler::loadData (   $request,
  $filter 
)
protected

Implement this method to load data into the grid.

Parameters
$requestPKPRequest
$filterarray 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 119 of file NavigationMenuItemsGridHandler.inc.php.

References DAORegistry\getDAO().

◆ updateNavigationMenuItem()

NavigationMenuItemsGridHandler::updateNavigationMenuItem (   $args,
  $request 
)

Update NavigationMenuItem

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

Definition at line 149 of file NavigationMenuItemsGridHandler.inc.php.

References DAO\getDataChangedEvent().


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