contentbox.models.content

Class Category

lucee.Component
    extended by contentbox.models.BaseEntityMethods
      extended by contentbox.models.BaseEntity
        extended by contentbox.models.content.Category

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- I am an awesome content category

Class Attributes:
  • entityname : cbCategory
  •  
  • cacheuse : read-write
  •  
  • table : cb_category
  •  
  • synchronized : false
  •  
  • cachename : cbCategory
  •  
  • accessors : false
  •  
  • persistent : true
  •  
    Property Summary
    type property default serializable required
    any category


    • access = public
    • returntype = any
    • column = category
    • notnull = true
    • index = idx_categoryName
    • length = 200
    true false
    any categoryID


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


    • access = public
    • returntype = any
    • inject = provider:categoryService@contentbox
    • persistent = false
    true false
    any contentStoreService


    • access = public
    • returntype = any
    • inject = provider:contentStoreService@contentbox
    • persistent = false
    true false
    date createdDate


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


    • access = public
    • returntype = any
    • inject = provider:entryService@contentbox
    • persistent = false
    true false
    any isDeleted


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


    • access = public
    • returntype = any
    • column = isPublic
    • notnull = false
    • ormtype = boolean
    • index = idx_isPublic
    true true false
    date modifiedDate


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


    • access = public
    • returntype = any
    • formula = select count(*) from cb_contentCategories as contentCategories, cb_contentStore as contentStore, cb_content as content where contentCategories.FK_categoryID=categoryID and contentCategories.FK_contentID = contentStore.contentID and contentStore.contentID = content.contentID
    true false
    any numberOfEntries


    • access = public
    • returntype = any
    • formula = select count(*) from cb_contentCategories as contentCategories, cb_entry as entry, cb_content as content where contentCategories.FK_categoryID=categoryID and contentCategories.FK_contentID = entry.contentID and entry.contentID = content.contentID
    true false
    any numberOfPages


    • access = public
    • returntype = any
    • formula = select count(*) from cb_contentCategories as contentCategories, cb_page as page, cb_content as content where contentCategories.FK_categoryID=categoryID and contentCategories.FK_contentID = page.contentID and page.contentID = content.contentID
    true false
    any pageService


    • access = public
    • returntype = any
    • inject = provider:pageService@contentbox
    • persistent = false
    true false
    any settingService


    • access = public
    • returntype = any
    • inject = provider:settingService@contentbox
    • persistent = false
    true false
    any site


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


    • access = public
    • returntype = any
    • column = slug
    • notnull = true
    • index = idx_categorySlug
    • length = 200
    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    string getCategory()
    string getCategoryID()
    string getCategoryService()
    string getContentStoreService()
    string getEntryService()
    string getIsPublic()
    string getNumberOfContentStore()
    string getNumberOfEntries()
    string getNumberOfPages()
    private numeric getNumberOfPublishedContent(any service)
         Get the number of published content by category and service type.
    numeric getNumberOfPublishedContentStore()
         Helper to get the count of published content store for this category.
    numeric getNumberOfPublishedEntries()
         Helper to get the count of published entries for this category.
    numeric getNumberOfPublishedPages()
         Helper to get the count of published pages for this category.
    string getPageService()
    string getSettingService()
    string getSite()
    any getSiteID()
         Shortcut to get the site id.
    struct getSiteSnapshot()
         Build a site snapshot.
    string getSlug()
    boolean hasSite([any site])
    any setCategory(any category)
    any setCategoryID(any categoryID)
    any setCategoryService(any categoryService)
    any setContentStoreService(any contentStoreService)
    any setEntryService(any entryService)
    any setIsPublic(any isPublic)
    any setNumberOfContentStore(any numberOfContentStore)
    any setNumberOfEntries(any numberOfEntries)
    any setNumberOfPages(any numberOfPages)
    any setPageService(any pageService)
    any setSettingService(any settingService)
    any setSite(any site)
    any setSlug(any slug)
     
    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

    category

    property any category

    Attributes:
    access - public
    required - false
    returntype - any
    column - category
    notnull - true
    index - idx_categoryName
    length - 200
    serializable - true

    categoryID

    property any categoryID

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

    categoryService

    property any categoryService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - provider:categoryService@contentbox
    persistent - false
    serializable - true

    contentStoreService

    property any contentStoreService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - provider:contentStoreService@contentbox
    persistent - false
    serializable - true

    createdDate

    property date createdDate

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

    entryService

    property any entryService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - provider:entryService@contentbox
    persistent - false
    serializable - true

    isDeleted

    property any isDeleted = [false]

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

    isPublic

    property any isPublic = [true]

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

    modifiedDate

    property date modifiedDate

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

    numberOfContentStore

    property any numberOfContentStore

    Attributes:
    access - public
    required - false
    returntype - any
    formula - select count(*) from cb_contentCategories as contentCategories, cb_contentStore as contentStore, cb_content as content where contentCategories.FK_categoryID=categoryID and contentCategories.FK_contentID = contentStore.contentID and contentStore.contentID = content.contentID
    serializable - true

    numberOfEntries

    property any numberOfEntries

    Attributes:
    access - public
    required - false
    returntype - any
    formula - select count(*) from cb_contentCategories as contentCategories, cb_entry as entry, cb_content as content where contentCategories.FK_categoryID=categoryID and contentCategories.FK_contentID = entry.contentID and entry.contentID = content.contentID
    serializable - true

    numberOfPages

    property any numberOfPages

    Attributes:
    access - public
    required - false
    returntype - any
    formula - select count(*) from cb_contentCategories as contentCategories, cb_page as page, cb_content as content where contentCategories.FK_categoryID=categoryID and contentCategories.FK_contentID = page.contentID and page.contentID = content.contentID
    serializable - true

    pageService

    property any pageService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - provider:pageService@contentbox
    persistent - false
    serializable - true

    settingService

    property any settingService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - provider:settingService@contentbox
    persistent - false
    serializable - true

    site

    property any site

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

    slug

    property any slug

    Attributes:
    access - public
    required - false
    returntype - any
    column - slug
    notnull - true
    index - idx_categorySlug
    length - 200
    serializable - true

    Method Detail

    getCategory

    public string getCategory()


    getCategoryID

    public string getCategoryID()


    getCategoryService

    public string getCategoryService()


    getContentStoreService

    public string getContentStoreService()


    getEntryService

    public string getEntryService()


    getIsPublic

    public string getIsPublic()


    getNumberOfContentStore

    public string getNumberOfContentStore()


    getNumberOfEntries

    public string getNumberOfEntries()


    getNumberOfPages

    public string getNumberOfPages()


    getNumberOfPublishedContent

    private numeric getNumberOfPublishedContent(any service)

    Get the number of published content by category and service type

    Parameters:
    service - The target service to use.

    getNumberOfPublishedContentStore

    public numeric getNumberOfPublishedContentStore()

    Helper to get the count of published content store for this category.


    getNumberOfPublishedEntries

    public numeric getNumberOfPublishedEntries()

    Helper to get the count of published entries for this category.


    getNumberOfPublishedPages

    public numeric getNumberOfPublishedPages()

    Helper to get the count of published pages for this category.


    getPageService

    public string getPageService()


    getSettingService

    public string getSettingService()


    getSite

    public string getSite()


    getSiteID

    public any getSiteID()

    Shortcut to get the site id


    getSiteSnapshot

    public struct getSiteSnapshot()

    Build a site snapshot


    getSlug

    public string getSlug()


    hasSite

    public boolean hasSite([any site])

    Parameters:
    site

    setCategory

    public any setCategory(any category)

    Parameters:
    category

    setCategoryID

    public any setCategoryID(any categoryID)

    Parameters:
    categoryID

    setCategoryService

    public any setCategoryService(any categoryService)

    Parameters:
    categoryService

    setContentStoreService

    public any setContentStoreService(any contentStoreService)

    Parameters:
    contentStoreService

    setEntryService

    public any setEntryService(any entryService)

    Parameters:
    entryService

    setIsPublic

    public any setIsPublic(any isPublic)

    Parameters:
    isPublic

    setNumberOfContentStore

    public any setNumberOfContentStore(any numberOfContentStore)

    Parameters:
    numberOfContentStore

    setNumberOfEntries

    public any setNumberOfEntries(any numberOfEntries)

    Parameters:
    numberOfEntries

    setNumberOfPages

    public any setNumberOfPages(any numberOfPages)

    Parameters:
    numberOfPages

    setPageService

    public any setPageService(any pageService)

    Parameters:
    pageService

    setSettingService

    public any setSettingService(any settingService)

    Parameters:
    settingService

    setSite

    public any setSite(any site)

    Parameters:
    site

    setSlug

    public any setSlug(any slug)

    Parameters:
    slug