API Docs for: 0.8.0
Show:

AdminNavigation Class

Defined in: include/admin_navigation.js:27
Module: Admin
Parent Module: Services

Provides function to construct the structure needed to display the navigation in the Admin section of the application.

Item Index

Methods

Properties

Methods

add

(
  • node
  • [site='global']
)
Boolean static

Defined in include/admin_navigation.js:476

Adds a new top level node

Parameters:

  • node Object
  • [site='global'] String optional

Returns:

Boolean:

addChildToSite

(
  • parentId
  • node
  • site
)
Boolean static

Defined in include/admin_navigation.js:444

Adds a new child node to an existing top level node

Parameters:

  • parentId String
  • node Object
  • site String
    • site unique id

Returns:

Boolean:

addToSite

(
  • node
  • site
)
Boolean static

Defined in include/admin_navigation.js:499

Adds a new top level node

Parameters:

  • node Object
  • site String

Returns:

Boolean:

buildNavigation

() Array private static

Defined in include/admin_navigation.js:299

Returns:

Array:

get

(
  • session
  • activeMenuItems
  • ls
)
Object static

Defined in include/admin_navigation.js:421

Retrive the admin navigation hierarchy

Parameters:

  • session Object
  • activeMenuItems Array

    Array of nav item names that are active

  • ls Object

    Localization service

Returns:

Object:

Admin navigation

getAdditions

() Array private static

Defined in include/admin_navigation.js:261

Returns:

Array:

getAdditionsInScope

(
  • additions
  • site
)
private

Defined in include/admin_navigation.js:283

Parameters:

  • additions Object
  • site String

getChildrenAdditions

() Object private static

Defined in include/admin_navigation.js:272

Returns:

Object:

isDefaultNode

(
  • id
)
Boolean private static

Defined in include/admin_navigation.js:410

Parameters:

  • id String

Returns:

Boolean:

isDuplicate

(
  • id
  • navigation
)
Boolean private static

Defined in include/admin_navigation.js:377

Parameters:

  • id String
  • navigation Array

Returns:

Boolean:

localizeNavigation

(
  • navigation
  • ls
)
Array private static

Defined in include/admin_navigation.js:359

Parameters:

Returns:

Array:

remove

(
  • id
  • [site='global']
)
Boolean static

Defined in include/admin_navigation.js:511

Remove a navigation node

Parameters:

  • id Object
  • [site='global'] String optional

Returns:

Boolean:

removeFromSite

(
  • id
  • site
)
Boolean static

Defined in include/admin_navigation.js:561

Remove a navigation node

Parameters:

  • id Object
  • site String

Returns:

Boolean:

removeUnauthorized

(
  • session
  • adminNavigation
  • activeItems
)
Array static

Defined in include/admin_navigation.js:573

Parameters:

  • session Object
  • adminNavigation Array
  • activeItems Array

Returns:

Array:

Properties

additions

Array private static

Defined in include/admin_navigation.js:38

childrenAdditions

Object private static

Defined in include/admin_navigation.js:47

CONTENT_NAV

Unknown private static

Defined in include/admin_navigation.js:74

MULTISITE_NAV

Unknown private static

Defined in include/admin_navigation.js:56