lucee.Componentcontentbox.models.importers.ContentBoxImporter
ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Import a .cbox package into ContentBOx
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
ContentBoxPackagePath
The location of the import file (zip|box).
|
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
|
|
any
|
entryService
|
true
|
false
|
|
array
|
fileNames
The import file names found.
|
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
|
templateService
|
true
|
false
|
|
any
|
themeService
|
true
|
false
|
|
any
|
widgetService
|
true
|
false
|
|
any
|
zipUtil
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor. |
Method Summary | |
---|---|
string
|
execute(boolean overrideContent='false')
Main method for processing import. |
string
|
getAuthorService()
|
string
|
getCategoryService()
|
string
|
getContentBoxPackagePath()
|
string
|
getContentStoreService()
|
string
|
getDataServiceMappings()
|
any
|
getDescriptorContents(boolean asObject='false')
Retrieves contents of descriptor file. |
string
|
getEntryService()
|
string
|
getFileNames()
|
string
|
getFilePathMappings()
|
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
|
getZipUtil()
|
private boolean
|
hasFile(string fileName)
Determines if passed file name exists in zip collection. |
boolean
|
isValid()
Method which analyzes the uploaded package and determines whether or not the descriptor file documents what is being uploaded. |
any
|
setAuthorService(any authorService)
|
any
|
setCategoryService(any categoryService)
|
any
|
setContentBoxPackagePath(any ContentBoxPackagePath)
|
any
|
setContentStoreService(any contentStoreService)
|
any
|
setDataServiceMappings(struct dataServiceMappings)
|
any
|
setEntryService(any entryService)
|
any
|
setFileNames(array fileNames)
|
any
|
setFilePathMappings(struct filePathMappings)
|
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)
|
any
|
setWidgetService(any widgetService)
|
any
|
setZipUtil(any zipUtil)
|
void
|
setup(any importFile)
Setup method to configure service. |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
The location of the import file (zip|box)
access
- publicrequired
- falsereturntype
- anyserializable
- 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
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:entryService@contentboxserializable
- trueThe import file names found
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:emailtemplateService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:themeService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- id:widgetService@contentboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- zipUtil@contentboxserializable
- trueMethod Detail |
---|
Main method for processing import
overrideContent
- Whether or not to override existing content with uploaded data (default=false)Retrieves contents of descriptor file
asObject
Determines if passed file name exists in zip collection
fileName
- The file name to validateMethod which analyzes the uploaded package and determines whether or not the descriptor file documents what is being uploaded
authorService
categoryService
ContentBoxPackagePath
contentStoreService
dataServiceMappings
entryService
fileNames
filePathMappings
log
menuService
moduleService
moduleSettings
pageService
permissionService
roleService
securityRuleService
securityService
settingService
templateService
themeService
widgetService
zipUtil
Setup method to configure service
importFile
- The uploaded .cbox package to import