contentbox.model.exporters

Class ContentBoxExporter

railo-context.Component
        extended by contentbox.model.exporters.ContentBoxExporter
Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  

    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.

    Property Summary
    type property default serializable required
    any authorService


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


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


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


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


    true false
    any entryService


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


    true false
    any fileExporter


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


    • inject = coldbox:plugin:FileUtils
    true false
    any HTMLHelper


    • inject = coldbox:plugin:HTMLHelper
    true false
    any layoutService


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


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


    • inject = id:menuService@cb
    true false
    any moduleService


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


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


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


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


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


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


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


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


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


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


    • inject = wirebox
    true false
    any zipUtil


    • 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()
    struct getDescriptor()
         Gets the descriptor def for the export.
    string getEntryService()
    string getExporters()
    string getFileExporter()
    string getFileUtils()
    string getHTMLHelper()
    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 getWirebox()
    string getZipUtil()
    any onDIComplete()
    any setAuthorService(any authorService)
    any setCategoryService(any categoryService)
    any setContentStoreService(any contentStoreService)
    any setDataExporter(any dataExporter)
    any setDescriptor(struct descriptor)
    any setEntryService(any entryService)
    any setExporters(array exporters)
    any setFileExporter(any fileExporter)
    any setFileUtils(any fileUtils)
    any setHTMLHelper(any HTMLHelper)
    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)
    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 railo-context.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    authorService

    property any authorService

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

    categoryService

    property any categoryService

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

    contentStoreService

    property any contentStoreService

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

    dataExporter

    property any dataExporter

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

    descriptor

    property struct descriptor

    Attributes:
    required - false
    serializable - true

    entryService

    property any entryService

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

    exporters

    property array exporters

    Attributes:
    required - false
    serializable - true

    fileExporter

    property any fileExporter

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

    fileUtils

    property any fileUtils

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

    HTMLHelper

    property any HTMLHelper

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

    layoutService

    property any layoutService

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

    log

    property any log

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

    menuService

    property any menuService

    Attributes:
    required - false
    inject - id:menuService@cb
    serializable - true

    moduleService

    property any moduleService

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

    moduleSettings

    property any moduleSettings

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

    pageService

    property any pageService

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

    permissionService

    property any permissionService

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

    roleService

    property any roleService

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

    securityRuleService

    property any securityRuleService

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

    securityService

    property any securityService

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

    settingService

    property any settingService

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

    templateService

    property any templateService

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

    widgetService

    property any widgetService

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

    wirebox

    property any wirebox

    Attributes:
    required - false
    inject - wirebox
    serializable - true

    zipUtil

    property any zipUtil

    Attributes:
    required - false
    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()


    getDescriptor

    public struct getDescriptor()

    Gets the descriptor def for the export


    getEntryService

    public string getEntryService()


    getExporters

    public string getExporters()


    getFileExporter

    public string getFileExporter()


    getFileUtils

    public string getFileUtils()


    getHTMLHelper

    public string getHTMLHelper()


    getLayoutService

    public string getLayoutService()


    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()


    getWidgetService

    public string getWidgetService()


    getWirebox

    public string getWirebox()


    getZipUtil

    public string getZipUtil()


    onDIComplete

    public any onDIComplete()


    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

    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

    setFileUtils

    public any setFileUtils(any fileUtils)

    Parameters:
    fileUtils

    setHTMLHelper

    public any setHTMLHelper(any HTMLHelper)

    Parameters:
    HTMLHelper

    setLayoutService

    public any setLayoutService(any layoutService)

    Parameters:
    layoutService

    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

    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