API Docs for: 0.8.0
Show:

SettingsServiceFactory Class

Defined in: include/system/settings.js:24
Module: Session

SettingServiceFactory - Creates a service that will provide access to settings

Constructor

SettingsServiceFactory

()

Defined in include/system/settings.js:24

Item Index

Methods

Properties

Methods

getBaseObjectService

(
  • options
)

Defined in include/system/settings.js:105

Parameters:

  • options Object
    • site String
    • onlyThisSite Boolean

getService

(
  • useMemory
  • useCache
  • site
  • onlyThisSite
)
SimpleLayeredService static

Defined in include/system/settings.js:65

Creates a new instance of the settings service

Parameters:

  • useMemory Boolean
  • useCache Boolean
  • site String

    siteId

  • onlyThisSite Boolean

    whether this service should only return setting specified by site

Returns:

SimpleLayeredService:

getServiceBySite

(
  • site
  • onlyThisSite
)
static

Defined in include/system/settings.js:50

Creates a new instance of settings service with specified site, using the memory and cache settings of pb config

Parameters:

  • site String
  • onlyThisSite Boolean=

Properties

count

Integer private static

Defined in include/system/settings.js:31

Tracks the number of instances created

TYPE

String private static

Defined in include/system/settings.js:40

The collection that contains settings