Open Monograph Press  3.3.0
NavigationMenuItemHandler Class Reference
Inheritance diagram for NavigationMenuItemHandler:
Handler PKPHandler

Public Member Functions

 authorize ($request, &$args, $roleAssignments)
 
 index ($args, $request)
 
 preview ($args, $request)
 
 view ($args, $request)
 
- 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)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Static Public Member Functions

static setPage ($nmi)
 
- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 

Static Public Attributes

static $nmi
 

Additional Inherited Members

- 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 requests for navigationMenuItem functions.

Definition at line 18 of file NavigationMenuItemHandler.inc.php.

Member Function Documentation

◆ authorize()

NavigationMenuItemHandler::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 PKPHandler.

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

◆ index()

NavigationMenuItemHandler::index (   $args,
  $request 
)

Handle index request (redirect to "view")

Parameters
$argsarray Arguments array.
$requestPKPRequest Request object.

Reimplemented from PKPHandler.

Definition at line 139 of file NavigationMenuItemHandler.inc.php.

◆ preview()

NavigationMenuItemHandler::preview (   $args,
  $request 
)

◆ setPage()

static NavigationMenuItemHandler::setPage (   $nmi)
static

Set a $nmi to view.

Parameters
$nmiNavigationMenuItem

Definition at line 147 of file NavigationMenuItemHandler.inc.php.

References $nmi.

Referenced by PKP\Services\PKPNavigationMenuService\_callbackHandleCustomNavigationMenuItems().

◆ view()

NavigationMenuItemHandler::view (   $args,
  $request 
)

Field Documentation

◆ $nmi

NavigationMenuItem NavigationMenuItemHandler::$nmi
static

The nmi to view

Definition at line 24 of file NavigationMenuItemHandler.inc.php.

Referenced by setPage().


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