API Docs for: 0.8.0
Show:

SectionService Class

Defined in: include/service/entities/section_service.js:25
Module: Services

Service for managing the site's navigation

Constructor

SectionService

(
  • options
)

Defined in include/service/entities/section_service.js:25

Parameters:

  • options Object
    • site String

      uid

    • onlyThisSite Boolean

      should section service only return value set specifically by site rather than defaulting to global

Methods

_removeFromSectionMap

(
  • sid
  • sectionMap
)
private

Defined in include/service/entities/section_service.js:131

Parameters:

  • sid String
  • sectionMap Array

deleteChildren

(
  • parentId
  • cb
)

Defined in include/service/entities/section_service.js:279

Parameters:

  • parentId String
  • cb Function

formatUrl

(
  • navItem
)
static

Defined in include/service/entities/section_service.js:767

Parameters:

  • navItem Object

getFormattedSections

(
  • localizationService
  • [currUrl]
  • cb
)

Defined in include/service/entities/section_service.js:294

Parameters:

  • localizationService Localization
  • [currUrl] String optional
  • cb Function

getParentSelectList

(
  • currItem
  • cb
)

Defined in include/service/entities/section_service.js:359

Parameters:

  • currItem String | ObjectID
  • cb Function

getPillNavOptions

(
  • activePill
)
Array static

Defined in include/service/entities/section_service.js:56

Parameters:

  • activePill String

Returns:

Array:

getSectionData

(
  • uid
  • navItems
  • currUrl
)
static

Defined in include/service/entities/section_service.js:742

Parameters:

  • uid String
  • navItems Object
  • currUrl String

getSectionMapIndex

(
  • sid
  • sectionMap
)
Object private

Defined in include/service/entities/section_service.js:163

Parameters:

  • sid String
  • sectionMap Array

Returns:

Object:

(
  • ls
)
Array static

Defined in include/service/entities/section_service.js:792

Parameters:

Returns:

Array:

isValidType

(
  • type
)
Boolean static

Defined in include/service/entities/section_service.js:827

Parameters:

  • type String | Object

Returns:

Boolean:

removeFromSectionMap

(
  • section
  • [sectionMap]
  • cb
)

Defined in include/service/entities/section_service.js:74

Parameters:

  • section Object
  • [sectionMap] Array optional
  • cb Function

save

(
  • navItem
  • [options]
  • cb
)

Defined in include/service/entities/section_service.js:696

Parameters:

  • navItem Object
  • [options] Object optional
  • cb Function

trimForType

(
  • navItem
)
static

Defined in include/service/entities/section_service.js:386

Parameters:

  • navItem Object

updateNavMap

(
  • section
  • cb
)

Defined in include/service/entities/section_service.js:198

Parameters:

  • section Object
  • cb Function

validate

(
  • navItem
  • cb
)

Defined in include/service/entities/section_service.js:419

Parameters:

  • navItem Object
  • cb Function

validateContentNavItem

(
  • navItem
  • cb
)

Defined in include/service/entities/section_service.js:524

Parameters:

  • navItem Object
  • cb Function

validateLinkNavItem

(
  • navItem
  • cb
)

Defined in include/service/entities/section_service.js:484

Parameters:

  • navItem Object
  • cb Function

validateNavItemContent

(
  • type
  • content
  • cb
)

Defined in include/service/entities/section_service.js:645

Parameters:

  • type String
  • content String
  • cb Function

validateNavItemEditor

(
  • editor
  • cb
)

Defined in include/service/entities/section_service.js:672

Parameters:

  • editor String
  • cb Function

validateNavItemName

(
  • navItem
  • cb
)

Defined in include/service/entities/section_service.js:500

Parameters:

  • navItem Object
  • cb Function

validateNavItemParent

(
  • parent
  • cb
)

Defined in include/service/entities/section_service.js:614

Parameters:

  • parent String
  • cb Function

validateSectionNavItem

(
  • navItem
  • cb
)

Defined in include/service/entities/section_service.js:560

Parameters:

  • navItem Object
  • cb Function

Properties

VALID_TYPES

Object private static

Defined in include/service/entities/section_service.js:40