railo-context.Componentcontentbox.model.importers.ContentBoxImporter
ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Import a .cbox package into contentbox
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
authorService
|
true
|
false
|
|
any
|
categoryService
|
true
|
false
|
|
any
|
ContentBoxPackagePath
|
true
|
false
|
|
any
|
contentStoreService
|
true
|
false
|
|
any
|
entryService
|
true
|
false
|
|
array
|
fileNames
|
true
|
false
|
|
any
|
fileUtils
|
true
|
false
|
|
any
|
layoutService
|
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
|
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()
|
any
|
getDescriptorContents(boolean asObject='false')
Retrieves contents of descriptor file. |
string
|
getEntryService()
|
string
|
getFileNames()
|
string
|
getFileUtils()
|
string
|
getLayoutService()
|
string
|
getLog()
|
string
|
getMenuService()
|
string
|
getModuleService()
|
string
|
getModuleSettings()
|
string
|
getPageService()
|
string
|
getPermissionService()
|
string
|
getRoleService()
|
string
|
getSecurityRuleService()
|
string
|
getSecurityService()
|
string
|
getSettingService()
|
string
|
getTemplateService()
|
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
|
setEntryService(any entryService)
|
any
|
setFileNames(array fileNames)
|
any
|
setFileUtils(any fileUtils)
|
any
|
setLayoutService(any layoutService)
|
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)
|
void
|
setup(any importFile)
Setup method to configure service. |
any
|
setWidgetService(any widgetService)
|
any
|
setZipUtil(any zipUtil)
|
Methods inherited from class railo-context.Component |
---|
None |
Constructor Detail |
---|
Constructor
Property Detail |
---|
required
- falseinject
- id:authorService@cbserializable
- truerequired
- falseinject
- id:categoryService@cbserializable
- truerequired
- falseserializable
- truerequired
- falseinject
- id:contentStoreService@cbserializable
- truerequired
- falseinject
- id:entryService@cbserializable
- truerequired
- falseserializable
- truerequired
- falseinject
- coldbox:plugin:FileUtilsserializable
- truerequired
- falseinject
- id:layoutService@cbserializable
- truerequired
- falseinject
- logbox:logger:{this}serializable
- truerequired
- falseinject
- id:menuService@cbserializable
- truerequired
- falseinject
- id:moduleService@cbserializable
- truerequired
- falseinject
- coldbox:setting:modulesserializable
- truerequired
- falseinject
- id:pageService@cbserializable
- truerequired
- falseinject
- id:permissionService@cbserializable
- truerequired
- falseinject
- id:roleService@cbserializable
- truerequired
- falseinject
- id:securityRuleService@cbserializable
- truerequired
- falseinject
- id:securityService@cbserializable
- truerequired
- falseinject
- id:settingService@cbserializable
- truerequired
- falseinject
- id:emailtemplateService@cbserializable
- truerequired
- falseinject
- id:widgetService@cbserializable
- truerequired
- falseinject
- zipUtil@cbserializable
- 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
entryService
fileNames
fileUtils
layoutService
log
menuService
moduleService
moduleSettings
pageService
permissionService
roleService
securityRuleService
securityService
settingService
templateService
Setup method to configure service
importFile
- The uploaded .cbox packagewidgetService
zipUtil