|
ContentBox Core API 1.6.0 | ||||
FRAMES |
WEB-INF.cftags.componentcontentbox.model.importers.ContentBoxImporter
public class ContentBoxImporter
******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | 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 & Description | Default | Serializable | Required |
any
|
ContentBoxPackagePath
Attributes: |
|
true
|
false
|
any
|
authorService
Attributes:
|
|
true
|
false
|
any
|
categoryService
Attributes:
|
|
true
|
false
|
any
|
contentStoreService
Attributes:
|
|
true
|
false
|
any
|
entryService
Attributes:
|
|
true
|
false
|
array
|
fileNames
Attributes: |
|
true
|
false
|
any
|
fileUtils
Attributes:
|
|
true
|
false
|
any
|
layoutService
Attributes:
|
|
true
|
false
|
any
|
log
Attributes:
|
|
true
|
false
|
any
|
moduleService
Attributes:
|
|
true
|
false
|
any
|
moduleSettings
Attributes:
|
|
true
|
false
|
any
|
pageService
Attributes:
|
|
true
|
false
|
any
|
permissionService
Attributes:
|
|
true
|
false
|
any
|
roleService
Attributes:
|
|
true
|
false
|
any
|
securityRuleService
Attributes:
|
|
true
|
false
|
any
|
securityService
Attributes:
|
|
true
|
false
|
any
|
settingService
Attributes:
|
|
true
|
false
|
any
|
templateService
Attributes:
|
|
true
|
false
|
any
|
widgetService
Attributes:
|
|
true
|
false
|
any
|
zipUtil
Attributes:
|
|
true
|
false
|
Constructor Summary | |
---|---|
init()
Constructor |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init()
Property Detail |
---|
any ContentBoxPackagePath
default
- serializable
- truerequired
- falseany authorService
inject
- id:authorService@cbrequired
- falseserializable
- truedefault
- any categoryService
inject
- id:categoryService@cbrequired
- falseserializable
- truedefault
- any contentStoreService
inject
- id:contentStoreService@cbrequired
- falseserializable
- truedefault
- any entryService
inject
- id:entryService@cbrequired
- falseserializable
- truedefault
- array fileNames
default
- serializable
- truerequired
- falseany fileUtils
inject
- coldbox:plugin:FileUtilsrequired
- falseserializable
- truedefault
- any layoutService
inject
- id:layoutService@cbrequired
- falseserializable
- truedefault
- any log
inject
- logbox:logger:{this}required
- falseserializable
- truedefault
- any moduleService
inject
- id:moduleService@cbrequired
- falseserializable
- truedefault
- any moduleSettings
inject
- coldbox:setting:modulesrequired
- falseserializable
- truedefault
- any pageService
inject
- id:pageService@cbrequired
- falseserializable
- truedefault
- any permissionService
inject
- id:permissionService@cbrequired
- falseserializable
- truedefault
- any roleService
inject
- id:roleService@cbrequired
- falseserializable
- truedefault
- any securityRuleService
inject
- id:securityRuleService@cbrequired
- falseserializable
- truedefault
- any securityService
inject
- id:securityService@cbrequired
- falseserializable
- truedefault
- any settingService
inject
- id:settingService@cbrequired
- falseserializable
- truedefault
- any templateService
inject
- id:emailtemplateService@cbrequired
- falseserializable
- truedefault
- any widgetService
inject
- id:widgetService@cbrequired
- falseserializable
- truedefault
- any zipUtil
inject
- zipUtil@cbrequired
- falseserializable
- truedefault
- Method Detail |
---|
public any GETAUTHORSERVICE()
public any GETCATEGORYSERVICE()
public any GETCONTENTBOXPACKAGEPATH()
public any GETCONTENTSTORESERVICE()
public any GETENTRYSERVICE()
public array GETFILENAMES()
public any GETFILEUTILS()
public any GETLAYOUTSERVICE()
public any GETLOG()
public any GETMODULESERVICE()
public any GETMODULESETTINGS()
public any GETPAGESERVICE()
public any GETPERMISSIONSERVICE()
public any GETROLESERVICE()
public any GETSECURITYRULESERVICE()
public any GETSECURITYSERVICE()
public any GETSETTINGSERVICE()
public any GETTEMPLATESERVICE()
public any GETWIDGETSERVICE()
public any GETZIPUTIL()
public ContentBoxImporter SETAUTHORSERVICE(any authorService)
authorService
public ContentBoxImporter SETCATEGORYSERVICE(any categoryService)
categoryService
public ContentBoxImporter SETCONTENTBOXPACKAGEPATH(any ContentBoxPackagePath)
ContentBoxPackagePath
public ContentBoxImporter SETCONTENTSTORESERVICE(any contentStoreService)
contentStoreService
public ContentBoxImporter SETENTRYSERVICE(any entryService)
entryService
public ContentBoxImporter SETFILENAMES(array fileNames)
fileNames
public ContentBoxImporter SETFILEUTILS(any fileUtils)
fileUtils
public ContentBoxImporter SETLAYOUTSERVICE(any layoutService)
layoutService
public ContentBoxImporter SETLOG(any log)
log
public ContentBoxImporter SETMODULESERVICE(any moduleService)
moduleService
public ContentBoxImporter SETMODULESETTINGS(any moduleSettings)
moduleSettings
public ContentBoxImporter SETPAGESERVICE(any pageService)
pageService
public ContentBoxImporter SETPERMISSIONSERVICE(any permissionService)
permissionService
public ContentBoxImporter SETROLESERVICE(any roleService)
roleService
public ContentBoxImporter SETSECURITYRULESERVICE(any securityRuleService)
securityRuleService
public ContentBoxImporter SETSECURITYSERVICE(any securityService)
securityService
public ContentBoxImporter SETSETTINGSERVICE(any settingService)
settingService
public ContentBoxImporter SETTEMPLATESERVICE(any templateService)
templateService
public ContentBoxImporter SETWIDGETSERVICE(any widgetService)
widgetService
public ContentBoxImporter SETZIPUTIL(any zipUtil)
zipUtil
public string execute(boolean overrideContent='false')
overrideContent
- Whether or not to override existing content with uploaded data (default=false)public any getDescriptorContents(boolean asObject='false')
asObject
private boolean hasFile(string fileName)
fileName
- The file name to validatepublic boolean isValid()
public void setup(any importFile)
importFile
- The uploaded .cbox package
|
ContentBox Core API 1.6.0 | ||||
FRAMES |