Public Member Functions | |
| _callbackHandleCustomNavigationMenuItems ($hookName, $args) | |
| arrayToObject ($class, $array) | |
| getDisplayStatus (&$navigationMenuItem, &$navigationMenu) | |
| getMenuItemCustomEditTemplates () | |
| getMenuItemTypes () | |
| getMenuTree (&$navigationMenu) | |
| loadMenuTree (&$navigationMenu) | |
| populateNMIAssignmentContainedObjects (&$nmiAssignment) | |
| setAllNMILocalisedTitles ($nmi) | |
| setNMITitleLocalized ($nmi) | |
| transformNavMenuItemTitle ($templateMgr, &$navigationMenuItem) | |
Detailed Description
Definition at line 20 of file PKPNavigationMenuService.inc.php.
Member Function Documentation
◆ _callbackHandleCustomNavigationMenuItems()
| PKP\Services\PKPNavigationMenuService::_callbackHandleCustomNavigationMenuItems | ( | $hookName, | |
| $args | |||
| ) |
Callback to be registered from PKPTemplateManager for the LoadHandler hook. Used by the Custom NMI to point their URL target to [context]/[path]
- Parameters
-
mixed $hookName mixed $args
- Returns
- boolean true if the callback has handled the request.
Definition at line 627 of file PKPNavigationMenuService.inc.php.
References $op, PKPApplication\get(), DAORegistry\getDAO(), and NavigationMenuItemHandler\setPage().
◆ arrayToObject()
| PKP\Services\PKPNavigationMenuService::arrayToObject | ( | $class, | |
| $array | |||
| ) |
Helper function to transform the json_decoded cached NavigationMenu object (stdClass) to the actual NavigationMenu object Some changes on the NavigationMenu objects must be reflected here
- Parameters
-
mixed $class mixed $array
- Returns
- mixed
Definition at line 464 of file PKPNavigationMenuService.inc.php.
Referenced by PKP\Services\PKPNavigationMenuService\getMenuTree().
◆ getDisplayStatus()
| PKP\Services\PKPNavigationMenuService::getDisplayStatus | ( | & | $navigationMenuItem, |
| & | $navigationMenu | ||
| ) |
Callback for display menu item functionallity
Definition at line 129 of file PKPNavigationMenuService.inc.php.
References $op, HookRegistry\call(), PKPApplication\get(), Application\getContextDAO(), AppLocale\getLocale(), PKPTemplateManager\getManager(), Validation\isLoggedIn(), Validation\isLoggedInAs(), and PKP\Services\PKPNavigationMenuService\transformNavMenuItemTitle().
◆ getMenuItemCustomEditTemplates()
| PKP\Services\PKPNavigationMenuService::getMenuItemCustomEditTemplates | ( | ) |
Return all custom edit navigationMenuItemTypes Templates.
- Returns
- array
Definition at line 111 of file PKPNavigationMenuService.inc.php.
References HookRegistry\call().
◆ getMenuItemTypes()
| PKP\Services\PKPNavigationMenuService::getMenuItemTypes | ( | ) |
Return all default navigationMenuItemTypes.
- Returns
- array
Definition at line 26 of file PKPNavigationMenuService.inc.php.
References HookRegistry\call(), and AppLocale\requireComponents().
◆ getMenuTree()
| PKP\Services\PKPNavigationMenuService::getMenuTree | ( | & | $navigationMenu | ) |
Get a tree of NavigationMenuItems assigned to this menu
- Parameters
-
$navigationMenu \NavigationMenu
Definition at line 427 of file PKPNavigationMenuService.inc.php.
References PKP\Services\PKPNavigationMenuService\arrayToObject(), DAORegistry\getDAO(), and PKP\Services\PKPNavigationMenuService\loadMenuTree().
◆ loadMenuTree()
| PKP\Services\PKPNavigationMenuService::loadMenuTree | ( | & | $navigationMenu | ) |
Definition at line 375 of file PKPNavigationMenuService.inc.php.
References DAORegistry\getDAO().
Referenced by PKP\Services\PKPNavigationMenuService\getMenuTree().
◆ populateNMIAssignmentContainedObjects()
| PKP\Services\PKPNavigationMenuService::populateNMIAssignmentContainedObjects | ( | & | $nmiAssignment | ) |
Populate the navigationMenuItem and the children properties of the NMIAssignment object
- Parameters
-
$nmiAssignment \NavigationMenuItemAssignment The NMIAssignment object passed by reference
Definition at line 533 of file PKPNavigationMenuService.inc.php.
References DAORegistry\getDAO().
◆ setAllNMILocalisedTitles()
| PKP\Services\PKPNavigationMenuService::setAllNMILocalisedTitles | ( | $nmi | ) |
Sets the title of a navigation menu item, depending on its title or locale-key
- Parameters
-
$nmi \NavigationMenuItem The NMI to set its title
Definition at line 598 of file PKPNavigationMenuService.inc.php.
References AppLocale\getSupportedFormLocales(), and AppLocale\requireComponents().
◆ setNMITitleLocalized()
| PKP\Services\PKPNavigationMenuService::setNMITitleLocalized | ( | $nmi | ) |
Sets the title of a navigation menu item, depending on its title or locale-key
- Parameters
-
$nmi \NavigationMenuItem The NMI to set its title
Definition at line 581 of file PKPNavigationMenuService.inc.php.
References AppLocale\getLocale(), and AppLocale\requireComponents().
◆ transformNavMenuItemTitle()
| PKP\Services\PKPNavigationMenuService::transformNavMenuItemTitle | ( | $templateMgr, | |
| & | $navigationMenuItem | ||
| ) |
Transform an item title if the title includes a {$variable}
- Parameters
-
$templateMgr \TemplateManager $navigationMenu \NavigationMenu
Definition at line 509 of file PKPNavigationMenuService.inc.php.
References AppLocale\getLocale().
Referenced by PKP\Services\PKPNavigationMenuService\getDisplayStatus(), and APP\Services\NavigationMenuService\getDisplayStatusCallback().
The documentation for this class was generated from the following file:
