ContentBox Core API 1.6.0

contentbox.model.exporters
Class ContentBoxExporter

WEB-INF.cftags.component
        extended by contentbox.model.exporters.ContentBoxExporter

public class ContentBoxExporter
extends WEB-INF.cftags.component

******************************************************************************* 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. *******************************************************************************

Property Summary
Type Property & Description Default Serializable Required
 any HTMLHelper


Attributes:
  • inject = coldbox:plugin:HTMLHelper
true false
 any authorService


Attributes:
  • inject = id:authorService@cb
true false
 any categoryService


Attributes:
  • inject = id:categoryService@cb
true false
 any contentStoreService


Attributes:
  • inject = id:contentStoreService@cb
true false
 any dataExporter


Attributes:
  • inject = id:dataExporter@cb
true false
 struct descriptor


Attributes:
true false
 any entryService


Attributes:
  • inject = id:entryService@cb
true false
 array exporters


Attributes:
true false
 any fileExporter


Attributes:
  • inject = id:fileExporter@cb
true false
 any fileUtils


Attributes:
  • inject = coldbox:plugin:FileUtils
true false
 any layoutService


Attributes:
  • inject = id:layoutService@cb
true false
 any log


Attributes:
  • inject = logbox:logger:{this}
true false
 any moduleService


Attributes:
  • inject = id:moduleService@cb
true false
 any moduleSettings


Attributes:
  • inject = coldbox:setting:modules
true false
 any pageService


Attributes:
  • inject = id:pageService@cb
true false
 any permissionService


Attributes:
  • inject = id:permissionService@cb
true false
 any roleService


Attributes:
  • inject = id:roleService@cb
true false
 any securityRuleService


Attributes:
  • inject = id:securityRuleService@cb
true false
 any securityService


Attributes:
  • inject = id:securityService@cb
true false
 any settingService


Attributes:
  • inject = id:settingService@cb
true false
 any templateService


Attributes:
  • inject = id:emailtemplateService@cb
true false
 any widgetService


Attributes:
  • inject = id:widgetService@cb
true false
 any wirebox


Attributes:
  • inject = wirebox
true false
 any zipUtil


Attributes:
  • inject = zipUtil@cb
true false
 
Constructor Summary
init()
          Constructor
 
Method Summary
 any GETAUTHORSERVICE()
 any GETCATEGORYSERVICE()
 any GETCONTENTSTORESERVICE()
 any GETDATAEXPORTER()
 any GETENTRYSERVICE()
 array GETEXPORTERS()
 any GETFILEEXPORTER()
 any GETFILEUTILS()
 any GETHTMLHELPER()
 any GETLAYOUTSERVICE()
 any GETLOG()
 any GETMODULESERVICE()
 any GETMODULESETTINGS()
 any GETPAGESERVICE()
 any GETPERMISSIONSERVICE()
 any GETROLESERVICE()
 any GETSECURITYRULESERVICE()
 any GETSECURITYSERVICE()
 any GETSETTINGSERVICE()
 any GETTEMPLATESERVICE()
 any GETWIDGETSERVICE()
 any GETWIREBOX()
 any GETZIPUTIL()
 ContentBoxExporter SETAUTHORSERVICE(any authorService)
 ContentBoxExporter SETCATEGORYSERVICE(any categoryService)
 ContentBoxExporter SETCONTENTSTORESERVICE(any contentStoreService)
 ContentBoxExporter SETDATAEXPORTER(any dataExporter)
 ContentBoxExporter SETDESCRIPTOR(struct descriptor)
 ContentBoxExporter SETENTRYSERVICE(any entryService)
 ContentBoxExporter SETEXPORTERS(array exporters)
 ContentBoxExporter SETFILEEXPORTER(any fileExporter)
 ContentBoxExporter SETFILEUTILS(any fileUtils)
 ContentBoxExporter SETHTMLHELPER(any HTMLHelper)
 ContentBoxExporter SETLAYOUTSERVICE(any layoutService)
 ContentBoxExporter SETLOG(any log)
 ContentBoxExporter SETMODULESERVICE(any moduleService)
 ContentBoxExporter SETMODULESETTINGS(any moduleSettings)
 ContentBoxExporter SETPAGESERVICE(any pageService)
 ContentBoxExporter SETPERMISSIONSERVICE(any permissionService)
 ContentBoxExporter SETROLESERVICE(any roleService)
 ContentBoxExporter SETSECURITYRULESERVICE(any securityRuleService)
 ContentBoxExporter SETSECURITYSERVICE(any securityService)
 ContentBoxExporter SETSETTINGSERVICE(any settingService)
 ContentBoxExporter SETTEMPLATESERVICE(any templateService)
 ContentBoxExporter SETWIDGETSERVICE(any widgetService)
 ContentBoxExporter SETWIREBOX(any wirebox)
 ContentBoxExporter SETZIPUTIL(any zipUtil)
 ContentBoxExporter addExporter(any exporter)
          Adds an exporter that will define how a particular resource is exported return SiteExporterService
private void buildDescriptor()
          Creates descriptor structure
 struct export()
          Processes export!
private struct findConfig(string key)
          Retrieves correct config defintion based on key arguments
 struct getDescriptor()
          Gets the descriptor def for the export
 any onDIComplete()
 ContentBoxExporter setup(struct targets)
          Setup method to configure service
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init()
Constructor

Property Detail

HTMLHelper

any HTMLHelper

Attributes:
inject - coldbox:plugin:HTMLHelper
required - false
serializable - true
default -

authorService

any authorService

Attributes:
inject - id:authorService@cb
required - false
serializable - true
default -

categoryService

any categoryService

Attributes:
inject - id:categoryService@cb
required - false
serializable - true
default -

contentStoreService

any contentStoreService

Attributes:
inject - id:contentStoreService@cb
required - false
serializable - true
default -

dataExporter

any dataExporter

Attributes:
inject - id:dataExporter@cb
required - false
serializable - true
default -

descriptor

struct descriptor

Attributes:
default -
serializable - true
required - false

entryService

any entryService

Attributes:
inject - id:entryService@cb
required - false
serializable - true
default -

exporters

array exporters

Attributes:
default -
serializable - true
required - false

fileExporter

any fileExporter

Attributes:
inject - id:fileExporter@cb
required - false
serializable - true
default -

fileUtils

any fileUtils

Attributes:
inject - coldbox:plugin:FileUtils
required - false
serializable - true
default -

layoutService

any layoutService

Attributes:
inject - id:layoutService@cb
required - false
serializable - true
default -

log

any log

Attributes:
inject - logbox:logger:{this}
required - false
serializable - true
default -

moduleService

any moduleService

Attributes:
inject - id:moduleService@cb
required - false
serializable - true
default -

moduleSettings

any moduleSettings

Attributes:
inject - coldbox:setting:modules
required - false
serializable - true
default -

pageService

any pageService

Attributes:
inject - id:pageService@cb
required - false
serializable - true
default -

permissionService

any permissionService

Attributes:
inject - id:permissionService@cb
required - false
serializable - true
default -

roleService

any roleService

Attributes:
inject - id:roleService@cb
required - false
serializable - true
default -

securityRuleService

any securityRuleService

Attributes:
inject - id:securityRuleService@cb
required - false
serializable - true
default -

securityService

any securityService

Attributes:
inject - id:securityService@cb
required - false
serializable - true
default -

settingService

any settingService

Attributes:
inject - id:settingService@cb
required - false
serializable - true
default -

templateService

any templateService

Attributes:
inject - id:emailtemplateService@cb
required - false
serializable - true
default -

widgetService

any widgetService

Attributes:
inject - id:widgetService@cb
required - false
serializable - true
default -

wirebox

any wirebox

Attributes:
inject - wirebox
required - false
serializable - true
default -

zipUtil

any zipUtil

Attributes:
inject - zipUtil@cb
required - false
serializable - true
default -

Method Detail

GETAUTHORSERVICE

public any GETAUTHORSERVICE()


GETCATEGORYSERVICE

public any GETCATEGORYSERVICE()


GETCONTENTSTORESERVICE

public any GETCONTENTSTORESERVICE()


GETDATAEXPORTER

public any GETDATAEXPORTER()


GETENTRYSERVICE

public any GETENTRYSERVICE()


GETEXPORTERS

public array GETEXPORTERS()


GETFILEEXPORTER

public any GETFILEEXPORTER()


GETFILEUTILS

public any GETFILEUTILS()


GETHTMLHELPER

public any GETHTMLHELPER()


GETLAYOUTSERVICE

public any GETLAYOUTSERVICE()


GETLOG

public any GETLOG()


GETMODULESERVICE

public any GETMODULESERVICE()


GETMODULESETTINGS

public any GETMODULESETTINGS()


GETPAGESERVICE

public any GETPAGESERVICE()


GETPERMISSIONSERVICE

public any GETPERMISSIONSERVICE()


GETROLESERVICE

public any GETROLESERVICE()


GETSECURITYRULESERVICE

public any GETSECURITYRULESERVICE()


GETSECURITYSERVICE

public any GETSECURITYSERVICE()


GETSETTINGSERVICE

public any GETSETTINGSERVICE()


GETTEMPLATESERVICE

public any GETTEMPLATESERVICE()


GETWIDGETSERVICE

public any GETWIDGETSERVICE()


GETWIREBOX

public any GETWIREBOX()


GETZIPUTIL

public any GETZIPUTIL()


SETAUTHORSERVICE

public ContentBoxExporter SETAUTHORSERVICE(any authorService)

Parameters:
authorService

SETCATEGORYSERVICE

public ContentBoxExporter SETCATEGORYSERVICE(any categoryService)

Parameters:
categoryService

SETCONTENTSTORESERVICE

public ContentBoxExporter SETCONTENTSTORESERVICE(any contentStoreService)

Parameters:
contentStoreService

SETDATAEXPORTER

public ContentBoxExporter SETDATAEXPORTER(any dataExporter)

Parameters:
dataExporter

SETDESCRIPTOR

public ContentBoxExporter SETDESCRIPTOR(struct descriptor)

Parameters:
descriptor

SETENTRYSERVICE

public ContentBoxExporter SETENTRYSERVICE(any entryService)

Parameters:
entryService

SETEXPORTERS

public ContentBoxExporter SETEXPORTERS(array exporters)

Parameters:
exporters

SETFILEEXPORTER

public ContentBoxExporter SETFILEEXPORTER(any fileExporter)

Parameters:
fileExporter

SETFILEUTILS

public ContentBoxExporter SETFILEUTILS(any fileUtils)

Parameters:
fileUtils

SETHTMLHELPER

public ContentBoxExporter SETHTMLHELPER(any HTMLHelper)

Parameters:
HTMLHelper

SETLAYOUTSERVICE

public ContentBoxExporter SETLAYOUTSERVICE(any layoutService)

Parameters:
layoutService

SETLOG

public ContentBoxExporter SETLOG(any log)

Parameters:
log

SETMODULESERVICE

public ContentBoxExporter SETMODULESERVICE(any moduleService)

Parameters:
moduleService

SETMODULESETTINGS

public ContentBoxExporter SETMODULESETTINGS(any moduleSettings)

Parameters:
moduleSettings

SETPAGESERVICE

public ContentBoxExporter SETPAGESERVICE(any pageService)

Parameters:
pageService

SETPERMISSIONSERVICE

public ContentBoxExporter SETPERMISSIONSERVICE(any permissionService)

Parameters:
permissionService

SETROLESERVICE

public ContentBoxExporter SETROLESERVICE(any roleService)

Parameters:
roleService

SETSECURITYRULESERVICE

public ContentBoxExporter SETSECURITYRULESERVICE(any securityRuleService)

Parameters:
securityRuleService

SETSECURITYSERVICE

public ContentBoxExporter SETSECURITYSERVICE(any securityService)

Parameters:
securityService

SETSETTINGSERVICE

public ContentBoxExporter SETSETTINGSERVICE(any settingService)

Parameters:
settingService

SETTEMPLATESERVICE

public ContentBoxExporter SETTEMPLATESERVICE(any templateService)

Parameters:
templateService

SETWIDGETSERVICE

public ContentBoxExporter SETWIDGETSERVICE(any widgetService)

Parameters:
widgetService

SETWIREBOX

public ContentBoxExporter SETWIREBOX(any wirebox)

Parameters:
wirebox

SETZIPUTIL

public ContentBoxExporter SETZIPUTIL(any zipUtil)

Parameters:
zipUtil

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.

getDescriptor

public struct getDescriptor()
Gets the descriptor def for the export


onDIComplete

public any onDIComplete()


setup

public ContentBoxExporter setup(struct targets)
Setup method to configure service

Parameters:
targets - Targets for the upload

ContentBox Core API 1.6.0