lucee.Componentcontentbox.models.exporters.ContentBoxExporter
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Export ContentBox data based on user selection. This is a transient object
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
HTMLHelper
|
true
|
false
|
|
any
|
authorService
|
true
|
false
|
|
any
|
categoryService
|
true
|
false
|
|
any
|
contentStoreService
|
true
|
false
|
|
struct
|
dataServiceMappings
The location of the data services used for exporting.
|
true
|
false
|
|
struct
|
descriptor
Describes what will be exported.
|
true
|
false
|
|
any
|
entryService
|
true
|
false
|
|
array
|
exporters
The exporters to use.
|
true
|
false
|
|
struct
|
filePathMappings
The location of the file mappings used for exporting.
|
true
|
false
|
|
any
|
log
|
true
|
false
|
|
any
|
menuService
|
true
|
false
|
|
any
|
moduleService
|
true
|
false
|
|
any
|
moduleSettings
|
true
|
false
|
|
any
|
pageService
|
true
|
false
|
|
any
|
permissionService
|
true
|
false
|
|
any
|
roleService
|
true
|
false
|
|
any
|
securityRuleService
|
true
|
false
|
|
any
|
securityService
|
true
|
false
|
|
any
|
settingService
|
true
|
false
|
|
any
|
siteService
|
true
|
false
|
|
any
|
templateService
|
true
|
false
|
|
any
|
themeService
|
true
|
false
|
|
any
|
widgetService
|
true
|
false
|
|
any
|
wirebox
|
true
|
false
|
|
any
|
zipUtil
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
ContentBoxExporter
|
addExporter(any exporter)
Adds an exporter that will define how a particular resource is exported. |
private struct
|
buildDescriptor()
Creates descriptor structure. |
struct
|
export()
Processes export!. |
private struct
|
findConfig(string key)
Retrieves correct config defintion based on key arguments. |
string
|
getAuthorService()
|
string
|
getCategoryService()
|
string
|
getContentStoreService()
|
string
|
getDataServiceMappings()
|
struct
|
getDescriptor()
Gets the descriptor def for the export, it builds it first. |
string
|
getEntryService()
|
string
|
getExporters()
|
string
|
getFilePathMappings()
|
string
|
getHTMLHelper()
|
string
|
getLog()
|
string
|
getMenuService()
|
string
|
getModuleService()
|
string
|
getModuleSettings()
|
string
|
getPageService()
|
string
|
getPermissionService()
|
string
|
getRoleService()
|
string
|
getSecurityRuleService()
|
string
|
getSecurityService()
|
string
|
getSettingService()
|
string
|
getSiteService()
|
string
|
getTemplateService()
|
string
|
getThemeService()
|
string
|
getWidgetService()
|
string
|
getWirebox()
|
string
|
getZipUtil()
|
any
|
onDIComplete()
On DI Complete. |
any
|
setAuthorService(any authorService)
|
any
|
setCategoryService(any categoryService)
|
any
|
setContentStoreService(any contentStoreService)
|
any
|
setDataServiceMappings(struct dataServiceMappings)
|
any
|
setDescriptor(struct descriptor)
|
any
|
setEntryService(any entryService)
|
any
|
setExporters(array exporters)
|
any
|
setFilePathMappings(struct filePathMappings)
|
any
|
setHTMLHelper(any HTMLHelper)
|
any
|
setLog(any log)
|
any
|
setMenuService(any menuService)
|
any
|
setModuleService(any moduleService)
|
any
|
setModuleSettings(any moduleSettings)
|
any
|
setPageService(any pageService)
|
any
|
setPermissionService(any permissionService)
|
any
|
setRoleService(any roleService)
|
any
|
setSecurityRuleService(any securityRuleService)
|
any
|
setSecurityService(any securityService)
|
any
|
setSettingService(any settingService)
|
any
|
setSiteService(any siteService)
|
any
|
setTemplateService(any templateService)
|
any
|
setThemeService(any themeService)
|
any
|
setWidgetService(any widgetService)
|
any
|
setWirebox(any wirebox)
|
any
|
setZipUtil(any zipUtil)
|
ContentBoxExporter
|
setup(struct targets)
Setup method to configure service. |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyinject
- HTMLHelper@coldboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:authorService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:categoryService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:contentStoreService@contentboxserializable
- trueThe location of the data services used for exporting
access
- publicrequired
- falsereturntype
- anyserializable
- trueDescribes what will be exported
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:entryService@contentboxserializable
- trueThe exporters to use
access
- publicrequired
- falsereturntype
- anyserializable
- trueThe location of the file mappings used for exporting
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- logbox:logger:{this}serializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:menuService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:moduleService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- coldbox:setting:modulesserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:pageService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:permissionService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:roleService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:securityRuleService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:securityService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:settingService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:siteService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:emailtemplateService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:themeService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:widgetService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- wireboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- zipUtil@contentboxserializable
- trueMethod Detail |
---|
Adds an exporter that will define how a particular resource is exported
exporter
- The exporter that is added to the final array of exportersCreates descriptor structure
Processes export!
Retrieves correct config defintion based on key arguments
key
- The key of the definition to find.Gets the descriptor def for the export, it builds it first.
On DI Complete
authorService
categoryService
contentStoreService
dataServiceMappings
descriptor
entryService
exporters
filePathMappings
HTMLHelper
log
menuService
moduleService
moduleSettings
pageService
permissionService
roleService
securityRuleService
securityService
settingService
siteService
templateService
themeService
widgetService
wirebox
zipUtil
Setup method to configure service
targets
- The struct of targets to prepare for export