API Docs for: 0.8.0
Show:

SiteMapService Class

Defined in: include/service/entities/site_map_service.js:26
Module: Services

Constructor

SiteMapService

(
  • context
)

Defined in include/service/entities/site_map_service.js:26

Parameters:

Methods

_serializeItems

(
  • items
  • cb
)
private

Defined in include/service/entities/site_map_service.js:229

Parameters:

  • items Array
  • cb Function

formatGetResults

(
  • cb
)
Function static

Defined in include/service/entities/site_map_service.js:425

Returns a function that accepts two parameters. The first is an error, if exists, and the second is an array of arrays. The returning function, when executed, reduces the array of arrays down to a single array. NOTE: results are not deduped.

Parameters:

  • cb Function

Returns:

Function:

get

(
  • [options]
  • cb
)

Defined in include/service/entities/site_map_service.js:179

Parameters:

  • [options] Object optional
  • cb Function

getAndSerialize

(
  • [options]
  • cb
)

Defined in include/service/entities/site_map_service.js:154

Parameters:

  • [options] Object optional
  • cb Function

getForArticles

(
  • context
  • cb
)

Defined in include/service/entities/site_map_service.js:262

Parameters:

  • context Object
  • cb Function

getForContent

(
  • context
  • options
  • cb
)

Defined in include/service/entities/site_map_service.js:296

Parameters:

  • context Object
  • options Object
  • cb Function

getForPages

(
  • context
  • cb
)

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

Parameters:

  • context Object
  • cb Function

getForSections

(
  • context
  • cb
)

Defined in include/service/entities/site_map_service.js:310

Parameters:

  • context Object
  • cb Function

getLastModDateStr

(
  • date
)
String static

Defined in include/service/entities/site_map_service.js:400

Formats date objects to a string in the format of: YYYY-MM-DD

Parameters:

  • date Date

Returns:

String:

onPostLoad

(
  • options
  • cb
)
Function static

Defined in include/service/entities/site_map_service.js:324

Returns a function that processes site map items. It calculates the full URL for the item as well as setting the weight and indicating if the items is localized. The returned function accepts two parameters. The first is an error object, if exists. The second is an Array of objects.

Parameters:

  • options Object
    • urlPrefix String
    • weight Decimal
    • localized Boolean
  • cb Function

Returns:

Function:

paddedNumStr

(
  • num
)
String static

Defined in include/service/entities/site_map_service.js:413

Converts the provided number to a string. If the number is less than 10 it is prefix with a '0'.

Parameters:

  • num Integer

Returns:

String:

register

(
  • type
  • callback
)
Boolean static

Defined in include/service/entities/site_map_service.js:361

Registers an item provider. The callback should take two parameters. The first is a context object. The second is callback function.

Parameters:

  • type String
  • callback Function

Returns:

Boolean:

toXml

(
  • items
  • [options]
  • cb
)

Defined in include/service/entities/site_map_service.js:207

Parameters:

  • items Array
  • [options] Object optional
  • cb Function

unregister

(
  • type
)
Boolean static

Defined in include/service/entities/site_map_service.js:381

Unregisters an item provider from the site map service

Parameters:

  • type String

Returns:

Boolean:

Properties

DEFAULT_TEMPLATE

String private static

Defined in include/service/entities/site_map_service.js:114

DEFAULT_URL_TEMPLATE

String private static

Defined in include/service/entities/site_map_service.js:123

onlyThisSite

Boolean

Defined in include/service/entities/site_map_service.js:81

SITE_MAP_REGISTRY

Object private static

Defined in include/service/entities/site_map_service.js:132

siteMapRegistry

Object

Defined in include/service/entities/site_map_service.js:106

The instance of the registry to pull from. Initializes based off of the global configuration

supportedLocales

Array

Defined in include/service/entities/site_map_service.js:99

The locales that are supported for the site as an array of strings

templatePath

String

Defined in include/service/entities/site_map_service.js:87

urlTemplatePath

String

Defined in include/service/entities/site_map_service.js:93