ContentBoxExporter

contentbox.models.exporters

Class ContentBoxExporter

lucee.Component
    contentbox.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

Class Attributes:

synchronized : false

accessors : true

persistent : false

Property Summary
type	property	default	serializable	required
`any`	authorService access = public returntype = any inject = id:authorService@cb		`true`	`false`
`any`	categoryService access = public returntype = any inject = id:categoryService@cb		`true`	`false`
`any`	contentStoreService access = public returntype = any inject = id:contentStoreService@cb		`true`	`false`
`any`	dataExporter access = public returntype = any inject = id:dataExporter@cb		`true`	`false`
`struct`	dataServiceMappings The location of the data services used for exporting. access = public returntype = any		`true`	`false`
`struct`	descriptor Describes what will be exported. access = public returntype = any		`true`	`false`
`any`	entryService access = public returntype = any inject = id:entryService@cb		`true`	`false`
`array`	exporters The exporters to use. access = public returntype = any		`true`	`false`
`any`	fileExporter access = public returntype = any inject = id:fileExporter@cb		`true`	`false`
`struct`	filePathMappings The location of the file mappings used for exporting. access = public returntype = any		`true`	`false`
`any`	HTMLHelper access = public returntype = any inject = HTMLHelper@coldbox		`true`	`false`
`any`	log access = public returntype = any inject = logbox:logger:{this}		`true`	`false`
`any`	menuService access = public returntype = any inject = id:menuService@cb		`true`	`false`
`any`	moduleService access = public returntype = any inject = id:moduleService@cb		`true`	`false`
`any`	moduleSettings access = public returntype = any inject = coldbox:setting:modules		`true`	`false`
`any`	pageService access = public returntype = any inject = id:pageService@cb		`true`	`false`
`any`	permissionService access = public returntype = any inject = id:permissionService@cb		`true`	`false`
`any`	roleService access = public returntype = any inject = id:roleService@cb		`true`	`false`
`any`	securityRuleService access = public returntype = any inject = id:securityRuleService@cb		`true`	`false`
`any`	securityService access = public returntype = any inject = id:securityService@cb		`true`	`false`
`any`	settingService access = public returntype = any inject = id:settingService@cb		`true`	`false`
`any`	templateService access = public returntype = any inject = id:emailtemplateService@cb		`true`	`false`
`any`	themeService access = public returntype = any inject = id:themeService@cb		`true`	`false`
`any`	widgetService access = public returntype = any inject = id:widgetService@cb		`true`	`false`
`any`	wirebox access = public returntype = any inject = wirebox		`true`	`false`
`any`	zipUtil access = public returntype = any inject = zipUtil@cb		`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 void`	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`	getDataExporter()
`string`	getDataServiceMappings()
`struct`	getDescriptor() Gets the descriptor def for the export.
`string`	getEntryService()
`string`	getExporters()
`string`	getFileExporter()
`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`	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`	setDataExporter(any dataExporter)
`any`	setDataServiceMappings(struct dataServiceMappings)
`any`	setDescriptor(struct descriptor)
`any`	setEntryService(any entryService)
`any`	setExporters(array exporters)
`any`	setFileExporter(any fileExporter)
`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`	setTemplateService(any templateService)
`any`	setThemeService(any themeService)
`ContentBoxExporter`	setup(struct targets) Setup method to configure service.
`any`	setWidgetService(any widgetService)
`any`	setWirebox(any wirebox)
`any`	setZipUtil(any zipUtil)

Methods inherited from class `lucee.Component`
None

Constructor Detail

init

public init()

Constructor

Property Detail

authorService

property any authorService

Attributes:: access - public; required - false; returntype - any; inject - id:authorService@cb; serializable - true

categoryService

property any categoryService

Attributes:: access - public; required - false; returntype - any; inject - id:categoryService@cb; serializable - true

contentStoreService

property any contentStoreService

Attributes:: access - public; required - false; returntype - any; inject - id:contentStoreService@cb; serializable - true

dataExporter

property any dataExporter

Attributes:: access - public; required - false; returntype - any; inject - id:dataExporter@cb; serializable - true

dataServiceMappings

property struct dataServiceMappings

The location of the data services used for exporting

Attributes:: access - public; required - false; returntype - any; serializable - true

descriptor

property struct descriptor

Describes what will be exported

Attributes:: access - public; required - false; returntype - any; serializable - true

entryService

property any entryService

Attributes:: access - public; required - false; returntype - any; inject - id:entryService@cb; serializable - true

exporters

property array exporters

The exporters to use

Attributes:: access - public; required - false; returntype - any; serializable - true

fileExporter

property any fileExporter

Attributes:: access - public; required - false; returntype - any; inject - id:fileExporter@cb; serializable - true

filePathMappings

property struct filePathMappings

The location of the file mappings used for exporting

Attributes:: access - public; required - false; returntype - any; serializable - true

HTMLHelper

property any HTMLHelper

Attributes:: access - public; required - false; returntype - any; inject - HTMLHelper@coldbox; serializable - true

log

property any log

Attributes:: access - public; required - false; returntype - any; inject - logbox:logger:{this}; serializable - true

menuService

property any menuService

Attributes:: access - public; required - false; returntype - any; inject - id:menuService@cb; serializable - true

moduleService

property any moduleService

Attributes:: access - public; required - false; returntype - any; inject - id:moduleService@cb; serializable - true

moduleSettings

property any moduleSettings

Attributes:: access - public; required - false; returntype - any; inject - coldbox:setting:modules; serializable - true

pageService

property any pageService

Attributes:: access - public; required - false; returntype - any; inject - id:pageService@cb; serializable - true

permissionService

property any permissionService

Attributes:: access - public; required - false; returntype - any; inject - id:permissionService@cb; serializable - true

roleService

property any roleService

Attributes:: access - public; required - false; returntype - any; inject - id:roleService@cb; serializable - true

securityRuleService

property any securityRuleService

Attributes:: access - public; required - false; returntype - any; inject - id:securityRuleService@cb; serializable - true

securityService

property any securityService

Attributes:: access - public; required - false; returntype - any; inject - id:securityService@cb; serializable - true

settingService

property any settingService

Attributes:: access - public; required - false; returntype - any; inject - id:settingService@cb; serializable - true

templateService

property any templateService

Attributes:: access - public; required - false; returntype - any; inject - id:emailtemplateService@cb; serializable - true

themeService

property any themeService

Attributes:: access - public; required - false; returntype - any; inject - id:themeService@cb; serializable - true

widgetService

property any widgetService

Attributes:: access - public; required - false; returntype - any; inject - id:widgetService@cb; serializable - true

wirebox

property any wirebox

Attributes:: access - public; required - false; returntype - any; inject - wirebox; serializable - true

zipUtil

property any zipUtil

Attributes:: access - public; required - false; returntype - any; inject - zipUtil@cb; serializable - true

Method Detail

addExporter

public ContentBoxExporter addExporter(any exporter)

Adds an exporter that will define how a particular resource is exported return SiteExporterService

Parameters:: exporter - The exporter that is added

buildDescriptor

private void buildDescriptor()

Creates descriptor structure

export

public struct export()

Processes export!

findConfig

private struct findConfig(string key)

Retrieves correct config defintion based on key arguments

Parameters:: key - The key of the definition to find.

getAuthorService

public string getAuthorService()

getCategoryService

public string getCategoryService()

getContentStoreService

public string getContentStoreService()

getDataExporter

public string getDataExporter()

getDataServiceMappings

public string getDataServiceMappings()

getDescriptor

public struct getDescriptor()

Gets the descriptor def for the export

getEntryService

public string getEntryService()

getExporters

public string getExporters()

getFileExporter

public string getFileExporter()

getFilePathMappings

public string getFilePathMappings()

getHTMLHelper

public string getHTMLHelper()

getLog

public string getLog()

getMenuService

public string getMenuService()

getModuleService

public string getModuleService()

getModuleSettings

public string getModuleSettings()

getPageService

public string getPageService()

getPermissionService

public string getPermissionService()

getRoleService

public string getRoleService()

getSecurityRuleService

public string getSecurityRuleService()

getSecurityService

public string getSecurityService()

getSettingService

public string getSettingService()

getTemplateService

public string getTemplateService()

getThemeService

public string getThemeService()

getWidgetService

public string getWidgetService()

getWirebox

public string getWirebox()

getZipUtil

public string getZipUtil()

onDIComplete

public any onDIComplete()

On DI Complete

setAuthorService

public any setAuthorService(any authorService)

Parameters:: authorService

setCategoryService

public any setCategoryService(any categoryService)

Parameters:: categoryService

setContentStoreService

public any setContentStoreService(any contentStoreService)

Parameters:: contentStoreService

setDataExporter

public any setDataExporter(any dataExporter)

Parameters:: dataExporter

setDataServiceMappings

public any setDataServiceMappings(struct dataServiceMappings)

Parameters:: dataServiceMappings

setDescriptor

public any setDescriptor(struct descriptor)

Parameters:: descriptor

setEntryService

public any setEntryService(any entryService)

Parameters:: entryService

setExporters

public any setExporters(array exporters)

Parameters:: exporters

setFileExporter

public any setFileExporter(any fileExporter)

Parameters:: fileExporter

setFilePathMappings

public any setFilePathMappings(struct filePathMappings)

Parameters:: filePathMappings

setHTMLHelper

public any setHTMLHelper(any HTMLHelper)

Parameters:: HTMLHelper

setLog

public any setLog(any log)

Parameters:: log

setMenuService

public any setMenuService(any menuService)

Parameters:: menuService

setModuleService

public any setModuleService(any moduleService)

Parameters:: moduleService

setModuleSettings

public any setModuleSettings(any moduleSettings)

Parameters:: moduleSettings

setPageService

public any setPageService(any pageService)

Parameters:: pageService

setPermissionService

public any setPermissionService(any permissionService)

Parameters:: permissionService

setRoleService

public any setRoleService(any roleService)

Parameters:: roleService

setSecurityRuleService

public any setSecurityRuleService(any securityRuleService)

Parameters:: securityRuleService

setSecurityService

public any setSecurityService(any securityService)

Parameters:: securityService

setSettingService

public any setSettingService(any settingService)

Parameters:: settingService

setTemplateService

public any setTemplateService(any templateService)

Parameters:: templateService

setThemeService

public any setThemeService(any themeService)

Parameters:: themeService

setup

public ContentBoxExporter setup(struct targets)

Setup method to configure service

Parameters:: targets - Targets for the upload

setWidgetService

public any setWidgetService(any widgetService)

Parameters:: widgetService

setWirebox

public any setWirebox(any wirebox)

Parameters:: wirebox

setZipUtil

public any setZipUtil(any zipUtil)

Parameters:: zipUtil