lucee.Componentcontentbox.models.BaseEntityMethods
contentbox.models.BaseEntity
contentbox.models.system.Site
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- I model a ContentBox site for multi-site support
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
activeTheme
|
true
|
false
|
|
any
|
adminBar
|
true
|
true
|
false
|
array
|
categories
|
true
|
false
|
|
any
|
contentService
|
true
|
false
|
|
array
|
contentStore
|
true
|
false
|
|
date
|
createdDate
|
true
|
false
|
|
any
|
description
|
true
|
false
|
|
any
|
domain
|
true
|
false
|
|
any
|
domainAliases
|
true
|
false
|
|
any
|
domainRegex
|
true
|
false
|
|
array
|
entries
|
true
|
false
|
|
any
|
homepage
|
cbBlog
|
true
|
false
|
any
|
isActive
|
true
|
true
|
false
|
any
|
isBlogEnabled
|
true
|
true
|
false
|
any
|
isDeleted
|
false
|
true
|
false
|
any
|
isSSL
|
false
|
true
|
false
|
any
|
isSitemapEnabled
|
true
|
true
|
false
|
any
|
keywords
|
true
|
false
|
|
any
|
mediaDisk
|
contentbox
|
true
|
false
|
array
|
menus
|
true
|
false
|
|
date
|
modifiedDate
|
true
|
false
|
|
any
|
name
|
true
|
false
|
|
any
|
notificationEmails
|
true
|
false
|
|
any
|
notifyOnContentStore
|
true
|
true
|
false
|
any
|
notifyOnEntries
|
true
|
true
|
false
|
any
|
notifyOnPages
|
true
|
true
|
false
|
any
|
numberOfCategories
|
true
|
false
|
|
any
|
numberOfContentStore
|
true
|
false
|
|
any
|
numberOfEntries
|
true
|
false
|
|
any
|
numberOfMenus
|
true
|
false
|
|
any
|
numberOfPages
|
true
|
false
|
|
array
|
pages
|
true
|
false
|
|
any
|
poweredByHeader
|
true
|
true
|
false
|
array
|
settings
|
true
|
false
|
|
any
|
siteID
|
true
|
false
|
|
any
|
slug
|
true
|
false
|
|
any
|
tagline
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
any
|
addCategory(any category)
|
any
|
addContentStore(any contentStore)
|
any
|
addEntry(any entry)
|
any
|
addMenu(any menu)
|
any
|
addPage(any page)
|
any
|
addSetting(any setting)
|
string
|
getActiveTheme()
|
string
|
getAdminBar()
|
string
|
getCategories()
|
any
|
getCategory(any slug)
Tries to get a category object by slug if assigned to this site. |
string
|
getContentService()
|
any
|
getContentStore([boolean root='true'])
We make sure we only return contentStore that have no parent to simulate the root hierarchy. |
string
|
getDescription()
|
string
|
getDomain()
|
array
|
getDomainAliases()
Get the domain aliases. |
string
|
getDomainAliasesAsJSON()
Get the domain aliases as a string. |
string
|
getDomainRegex()
|
string
|
getEntries()
|
string
|
getHomepage()
|
struct
|
getInfoSnapshot()
A nice snapshot of this entity used for mementifications. |
string
|
getIsActive()
|
string
|
getIsBlogEnabled()
|
string
|
getIsSSL()
|
string
|
getIsSitemapEnabled()
|
string
|
getKeywords()
|
string
|
getMediaDisk()
|
string
|
getMenus()
|
string
|
getName()
|
string
|
getNotificationEmails()
|
string
|
getNotifyOnContentStore()
|
string
|
getNotifyOnEntries()
|
string
|
getNotifyOnPages()
|
string
|
getNumberOfCategories()
|
numeric
|
getNumberOfContent()
Get the total number of content items in this site. |
string
|
getNumberOfContentStore()
|
string
|
getNumberOfEntries()
|
string
|
getNumberOfMenus()
|
string
|
getNumberOfPages()
|
any
|
getPages([boolean root='true'])
We make sure we only return pages that have no parent to simulate the root hierarchy. |
string
|
getPoweredByHeader()
|
private any
|
getServerName()
Get the server host according to lookup order. |
private any
|
getServerPort()
Get the server port according to lookup order. |
string
|
getSettings()
|
string
|
getSiteID()
|
string
|
getSiteRoot()
Get the site root URL as defined per the settings. |
string
|
getSlug()
|
string
|
getTagline()
|
boolean
|
hasCategory([any category])
|
boolean
|
hasContentStore([any contentStore])
|
boolean
|
hasEntry([any entry])
|
boolean
|
hasMenu([any menu])
|
boolean
|
hasPage([any page])
|
boolean
|
hasSetting([any setting])
|
Site
|
removeAllCategories()
I remove all category associations. |
Site
|
removeAllContentStore()
I remove all contentStore associations. |
Site
|
removeAllEntries()
I remove all entry associations. |
Site
|
removeAllMenus()
I remove all menu associations. |
Site
|
removeAllPages()
I remove all page associations. |
Site
|
removeAllSettings()
I remove all setting associations. |
boolean
|
removeCategory(any category)
|
boolean
|
removeContentStore(any contentStore)
|
boolean
|
removeEntry(any entry)
|
boolean
|
removeMenu(any menu)
|
boolean
|
removePage(any page)
|
boolean
|
removeSetting(any setting)
|
any
|
setActiveTheme(any activeTheme)
|
any
|
setAdminBar(any adminBar)
|
any
|
setCategories(array categories)
|
any
|
setContentService(any contentService)
|
any
|
setContentStore(array contentStore)
|
any
|
setDescription(any description)
|
any
|
setDomain(any domain)
|
Site
|
setDomainAliases([any aliases='[runtime expression]'])
Set the domain aliases. |
any
|
setDomainRegex(any domainRegex)
|
any
|
setEntries(array entries)
|
any
|
setHomepage(any homepage)
|
any
|
setIsActive(any isActive)
|
any
|
setIsBlogEnabled(any isBlogEnabled)
|
any
|
setIsSSL(any isSSL)
|
any
|
setIsSitemapEnabled(any isSitemapEnabled)
|
any
|
setKeywords(any keywords)
|
any
|
setMediaDisk(any mediaDisk)
|
any
|
setMenus(array menus)
|
any
|
setName(any name)
|
any
|
setNotificationEmails(any notificationEmails)
|
any
|
setNotifyOnContentStore(any notifyOnContentStore)
|
any
|
setNotifyOnEntries(any notifyOnEntries)
|
any
|
setNotifyOnPages(any notifyOnPages)
|
any
|
setNumberOfCategories(any numberOfCategories)
|
any
|
setNumberOfContentStore(any numberOfContentStore)
|
any
|
setNumberOfEntries(any numberOfEntries)
|
any
|
setNumberOfMenus(any numberOfMenus)
|
any
|
setNumberOfPages(any numberOfPages)
|
any
|
setPages(array pages)
|
any
|
setPoweredByHeader(any poweredByHeader)
|
any
|
setSettings(array settings)
|
any
|
setSiteID(any siteID)
|
any
|
setSlug(any slug)
|
any
|
setTagline(any tagline)
|
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 |
---|
Constructor
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anycolumn
- activeThemenotnull
- falseormtype
- stringlength
- 255serializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- adminBarnotnull
- trueormtype
- booleanserializable
- trueaccess
- publicrequired
- falseinverse
- truefieldtype
- one-to-manyreturntype
- anycascade
- all-delete-orphanorderby
- slugsingularname
- categoryfkcolumn
- FK_siteIDserializable
- truecfc
- contentbox.models.content.Categorylazy
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- provider:contentService@contentboxpersistent
- falseserializable
- trueaccess
- publicrequired
- falseinverse
- truefieldtype
- one-to-manyreturntype
- anycascade
- all-delete-orphanorderby
- parentfkcolumn
- FK_siteIDserializable
- truecfc
- contentbox.models.content.ContentStorelazy
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- createdDatenotnull
- trueormtype
- timestampupdate
- falsepersistent
- trueserializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- descriptionnotnull
- falseormtype
- stringlength
- 500serializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- domainnotnull
- falseormtype
- stringlength
- 255serializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- domainAliasesnotnull
- falseormtype
- textlength
- 8000serializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- domainRegexnotnull
- falseormtype
- stringlength
- 255serializable
- trueaccess
- publicrequired
- falseinverse
- truefieldtype
- one-to-manyreturntype
- anycascade
- all-delete-orphanorderby
- createdDate descsingularname
- entryfkcolumn
- FK_siteIDserializable
- truecfc
- contentbox.models.content.Entrylazy
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- homepagenotnull
- falseormtype
- stringlength
- 255serializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- isActivenotnull
- trueormtype
- booleanserializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- isBlogEnablednotnull
- trueormtype
- booleanserializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- isDeletednotnull
- trueormtype
- booleanpersistent
- trueserializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- isSSLnotnull
- trueormtype
- booleanserializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- isSitemapEnablednotnull
- trueormtype
- booleanserializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- keywordsnotnull
- falseormtype
- stringlength
- 255serializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- mediaDisknotnull
- falseormtype
- stringlength
- 50serializable
- trueaccess
- publicrequired
- falseinverse
- truefieldtype
- one-to-manyreturntype
- anycascade
- all-delete-orphanorderby
- createdDate descsingularname
- menufkcolumn
- FK_siteIDserializable
- truecfc
- contentbox.models.menu.Menulazy
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- modifiedDatenotnull
- trueormtype
- timestamppersistent
- trueserializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- namenotnull
- trueormtype
- stringlength
- 255serializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- notificationEmailsnotnull
- falseormtype
- stringlength
- 500serializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- notifyOnContentStorenotnull
- trueormtype
- booleanserializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- notifyOnEntriesnotnull
- trueormtype
- booleanserializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- notifyOnPagesnotnull
- trueormtype
- booleanserializable
- trueaccess
- publicrequired
- falsereturntype
- anyformula
- select count(*)
from cb_category as category
where category.FK_siteID = siteIDserializable
- trueaccess
- publicrequired
- falsereturntype
- anyformula
- select count(*)
from cb_contentStore as contentStore, cb_content as content
where contentStore.contentID=content.contentID
and content.FK_siteID = siteIDserializable
- trueaccess
- publicrequired
- falsereturntype
- anyformula
- select count(*)
from cb_entry as entry, cb_content as content
where entry.contentID=content.contentID
and content.FK_siteID = siteIDserializable
- trueaccess
- publicrequired
- falsereturntype
- anyformula
- select count(*)
from cb_menu as menu
where menu.FK_siteID = siteIDserializable
- trueaccess
- publicrequired
- falsereturntype
- anyformula
- select count(*)
from cb_page as page, cb_content as content
where page.contentID=content.contentID
and content.FK_siteID = siteIDserializable
- trueaccess
- publicrequired
- falseinverse
- truefieldtype
- one-to-manyreturntype
- anycascade
- all-delete-orphanorderby
- parentsingularname
- pagefkcolumn
- FK_siteIDserializable
- truecfc
- contentbox.models.content.Pagelazy
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- poweredByHeadernotnull
- trueormtype
- booleanserializable
- trueaccess
- publicrequired
- falseinverse
- truefieldtype
- one-to-manyreturntype
- anycascade
- all-delete-orphanorderby
- namesingularname
- settingfkcolumn
- FK_siteIDserializable
- truecfc
- contentbox.models.system.Settinglazy
- trueaccess
- publicrequired
- falsefieldtype
- idreturntype
- anycolumn
- siteIDormtype
- stringupdate
- falsegenerator
- uuidlength
- 36serializable
- trueaccess
- publicunique
- truerequired
- falsereturntype
- anycolumn
- slugnotnull
- trueormtype
- stringindex
- idx_siteSluglength
- 255serializable
- trueaccess
- publicrequired
- falsereturntype
- anycolumn
- taglinenotnull
- falseormtype
- stringlength
- 255serializable
- trueMethod Detail |
---|
category
contentStore
entry
menu
page
setting
Tries to get a category object by slug if assigned to this site
slug
We make sure we only return contentStore that have no parent to simulate the root hierarchy.
root
- Show only root level contentStore if enabledGet the domain aliases
Get the domain aliases as a string
A nice snapshot of this entity used for mementifications
Get the total number of content items in this site
We make sure we only return pages that have no parent to simulate the root hierarchy.
root
- Show only root level pages if enabledGet the server host according to lookup order 1. x-forwarded-host header 2. cgi.server_host
Get the server port according to lookup order 1. x-forwarded-port header 2. cgi.server_port
Get the site root URL as defined per the settings
category
contentStore
entry
menu
page
setting
I remove all category associations
I remove all contentStore associations
I remove all entry associations
I remove all menu associations
I remove all page associations
I remove all setting associations
category
contentStore
entry
menu
page
setting
activeTheme
adminBar
categories
contentService
contentStore
description
domain
Set the domain aliases. If the value is an array, it will be serialized to JSON as domain aliases are stored as a JSON string.
aliases
- The domain aliases as an array or a JSON array stringdomainRegex
entries
homepage
isActive
isBlogEnabled
isSSL
isSitemapEnabled
keywords
mediaDisk
menus
name
notificationEmails
notifyOnContentStore
notifyOnEntries
notifyOnPages
numberOfCategories
numberOfContentStore
numberOfEntries
numberOfMenus
numberOfPages
pages
poweredByHeader
settings
siteID
slug
tagline