contentbox.models.system

Class Setting

lucee.Component
    extended by contentbox.models.BaseEntityMethods
      extended by contentbox.models.BaseEntity
        extended by contentbox.models.system.Setting

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- I am a system setting. A system setting can be core or non-core. The difference is that core settings cannot be deleted from the geek settings UI to prevent caos. Admins would have to remove core settings via the DB only as a precautionary measure.

Class Attributes:
  • entityname : cbSetting
  •  
  • cacheuse : read-write
  •  
  • table : cb_setting
  •  
  • synchronized : false
  •  
  • cachename : cbSetting
  •  
  • accessors : false
  •  
  • persistent : true
  •  
    Property Summary
    type property default serializable required
    date createdDate


    • access = public
    • returntype = any
    • column = createdDate
    • notnull = true
    • ormtype = timestamp
    • update = false
    • persistent = true
    true false
    any isCore


    • access = public
    • returntype = any
    • column = isCore
    • notnull = true
    • ormtype = boolean
    • index = idx_core
    false true false
    any isDeleted


    • access = public
    • returntype = any
    • column = isDeleted
    • notnull = true
    • ormtype = boolean
    • persistent = true
    false true false
    date modifiedDate


    • access = public
    • returntype = any
    • column = modifiedDate
    • notnull = true
    • ormtype = timestamp
    • persistent = true
    true false
    any name


    • access = public
    • returntype = any
    • column = name
    • notnull = true
    • length = 100
    true false
    any settingID


    • access = public
    • fieldtype = id
    • returntype = any
    • column = settingID
    • ormtype = string
    • update = false
    • generator = uuid
    • length = 36
    true false
    any site


    • access = public
    • fieldtype = many-to-one
    • returntype = any
    • notnull = false
    • fkcolumn = FK_siteID
    • cfc = contentbox.models.system.Site
    • lazy = true
    true false
    any value


    • access = public
    • returntype = any
    • column = value
    • notnull = true
    • ormtype = text
    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    string getIsCore()
    string getName()
    string getSettingID()
    string getSite()
    any getSiteID()
         Shortcut to get the site id associated with this setting.
    struct getSiteSnapshot()
         Build a site snapshot.
    string getValue()
    boolean hasSite([any site])
    any setIsCore(any isCore)
    any setName(any name)
    any setSettingID(any settingID)
    any setSite(any site)
    any setValue(any value)
     
    Methods inherited from class contentbox.models.BaseEntity
    getCreatedDate, getIsDeleted, getModifiedDate, setCreatedDate, setIsDeleted, setModifiedDate
     
    Methods inherited from class contentbox.models.BaseEntityMethods
    appendToMemento, appendToMementoProfile, arrayWrap, getDisplayCreatedDate, getDisplayModifiedDate, getEntityName, getId, includeMixin, isLoaded, preInsert, preUpdate
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    createdDate

    property date createdDate

    Attributes:
    access - public
    required - false
    returntype - any
    column - createdDate
    notnull - true
    ormtype - timestamp
    update - false
    persistent - true
    serializable - true

    isCore

    property any isCore = [false]

    Attributes:
    access - public
    required - false
    returntype - any
    column - isCore
    notnull - true
    ormtype - boolean
    index - idx_core
    serializable - true

    isDeleted

    property any isDeleted = [false]

    Attributes:
    access - public
    required - false
    returntype - any
    column - isDeleted
    notnull - true
    ormtype - boolean
    persistent - true
    serializable - true

    modifiedDate

    property date modifiedDate

    Attributes:
    access - public
    required - false
    returntype - any
    column - modifiedDate
    notnull - true
    ormtype - timestamp
    persistent - true
    serializable - true

    name

    property any name

    Attributes:
    access - public
    required - false
    returntype - any
    column - name
    notnull - true
    length - 100
    serializable - true

    settingID

    property any settingID

    Attributes:
    access - public
    required - false
    fieldtype - id
    returntype - any
    column - settingID
    ormtype - string
    update - false
    generator - uuid
    length - 36
    serializable - true

    site

    property any site

    Attributes:
    access - public
    required - false
    fieldtype - many-to-one
    returntype - any
    notnull - false
    fkcolumn - FK_siteID
    serializable - true
    cfc - contentbox.models.system.Site
    lazy - true

    value

    property any value

    Attributes:
    access - public
    required - false
    returntype - any
    column - value
    notnull - true
    ormtype - text
    serializable - true

    Method Detail

    getIsCore

    public string getIsCore()


    getName

    public string getName()


    getSettingID

    public string getSettingID()


    getSite

    public string getSite()


    getSiteID

    public any getSiteID()

    Shortcut to get the site id associated with this setting

    Returns:
    The associated site id or empty if none

    getSiteSnapshot

    public struct getSiteSnapshot()

    Build a site snapshot


    getValue

    public string getValue()


    hasSite

    public boolean hasSite([any site])

    Parameters:
    site

    setIsCore

    public any setIsCore(any isCore)

    Parameters:
    isCore

    setName

    public any setName(any name)

    Parameters:
    name

    setSettingID

    public any setSettingID(any settingID)

    Parameters:
    settingID

    setSite

    public any setSite(any site)

    Parameters:
    site

    setValue

    public any setValue(any value)

    Parameters:
    value