contentbox.models.importers

Class ContentBoxImporter

lucee.Component
    extended by contentbox.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

Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any authorService


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


    • access = public
    • returntype = any
    • inject = id:categoryService@cb
    true false
    any ContentBoxPackagePath
          The location of the import file (zip|box).

    • access = public
    • returntype = any
    true false
    any contentStoreService


    • access = public
    • returntype = any
    • inject = id:contentStoreService@cb
    true false
    struct dataServiceMappings
          The location of the data services used for exporting.

    • access = public
    • returntype = any
    true false
    any entryService


    • access = public
    • returntype = any
    • inject = id:entryService@cb
    true false
    array fileNames
          The import file names found.

    • access = public
    • returntype = any
    true false
    struct filePathMappings
          The location of the file mappings used for exporting.

    • access = public
    • returntype = any
    true false
    any log


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


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


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


    • access = public
    • returntype = any
    • inject = coldbox:setting:modules
    true false
    any pageService


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


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


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


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


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


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


    • access = public
    • returntype = any
    • inject = id:emailtemplateService@cb
    true false
    any themeService


    • access = public
    • returntype = any
    • inject = id:themeService@cb
    true false
    any widgetService


    • access = public
    • returntype = any
    • inject = id:widgetService@cb
    true false
    any zipUtil


    • access = public
    • returntype = any
    • inject = zipUtil@cb
    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)
    void setup(any importFile)
         Setup method to configure service.
    any setWidgetService(any widgetService)
    any setZipUtil(any zipUtil)
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    authorService

    property any authorService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:authorService@cb
    serializable - true

    categoryService

    property any categoryService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:categoryService@cb
    serializable - true

    ContentBoxPackagePath

    property any ContentBoxPackagePath

    The location of the import file (zip|box)

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    contentStoreService

    property any contentStoreService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:contentStoreService@cb
    serializable - true

    dataServiceMappings

    property struct dataServiceMappings

    The location of the data services used for exporting

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    entryService

    property any entryService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:entryService@cb
    serializable - true

    fileNames

    property array fileNames

    The import file names found

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    filePathMappings

    property struct filePathMappings

    The location of the file mappings used for exporting

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    log

    property any log

    Attributes:
    access - public
    required - false
    returntype - any
    inject - logbox:logger:{this}
    serializable - true

    menuService

    property any menuService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:menuService@cb
    serializable - true

    moduleService

    property any moduleService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:moduleService@cb
    serializable - true

    moduleSettings

    property any moduleSettings

    Attributes:
    access - public
    required - false
    returntype - any
    inject - coldbox:setting:modules
    serializable - true

    pageService

    property any pageService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:pageService@cb
    serializable - true

    permissionService

    property any permissionService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:permissionService@cb
    serializable - true

    roleService

    property any roleService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:roleService@cb
    serializable - true

    securityRuleService

    property any securityRuleService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:securityRuleService@cb
    serializable - true

    securityService

    property any securityService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:securityService@cb
    serializable - true

    settingService

    property any settingService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:settingService@cb
    serializable - true

    templateService

    property any templateService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:emailtemplateService@cb
    serializable - true

    themeService

    property any themeService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:themeService@cb
    serializable - true

    widgetService

    property any widgetService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - id:widgetService@cb
    serializable - true

    zipUtil

    property any zipUtil

    Attributes:
    access - public
    required - false
    returntype - any
    inject - zipUtil@cb
    serializable - true

    Method Detail

    execute

    public string execute(boolean overrideContent='false')

    Main method for processing import

    Parameters:
    overrideContent - Whether or not to override existing content with uploaded data (default=false)

    getAuthorService

    public string getAuthorService()


    getCategoryService

    public string getCategoryService()


    getContentBoxPackagePath

    public string getContentBoxPackagePath()


    getContentStoreService

    public string getContentStoreService()


    getDataServiceMappings

    public string getDataServiceMappings()


    getDescriptorContents

    public any getDescriptorContents(boolean asObject='false')

    Retrieves contents of descriptor file

    Parameters:
    asObject

    getEntryService

    public string getEntryService()


    getFileNames

    public string getFileNames()


    getFilePathMappings

    public string getFilePathMappings()


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


    getThemeService

    public string getThemeService()


    getWidgetService

    public string getWidgetService()


    getZipUtil

    public string getZipUtil()


    hasFile

    private boolean hasFile(string fileName)

    Determines if passed file name exists in zip collection

    Parameters:
    fileName - The file name to validate

    isValid

    public boolean isValid()

    Method which analyzes the uploaded package and determines whether or not the descriptor file documents what is being uploaded


    setAuthorService

    public any setAuthorService(any authorService)

    Parameters:
    authorService

    setCategoryService

    public any setCategoryService(any categoryService)

    Parameters:
    categoryService

    setContentBoxPackagePath

    public any setContentBoxPackagePath(any ContentBoxPackagePath)

    Parameters:
    ContentBoxPackagePath

    setContentStoreService

    public any setContentStoreService(any contentStoreService)

    Parameters:
    contentStoreService

    setDataServiceMappings

    public any setDataServiceMappings(struct dataServiceMappings)

    Parameters:
    dataServiceMappings

    setEntryService

    public any setEntryService(any entryService)

    Parameters:
    entryService

    setFileNames

    public any setFileNames(array fileNames)

    Parameters:
    fileNames

    setFilePathMappings

    public any setFilePathMappings(struct filePathMappings)

    Parameters:
    filePathMappings

    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

    setThemeService

    public any setThemeService(any themeService)

    Parameters:
    themeService

    setup

    public void setup(any importFile)

    Setup method to configure service

    Parameters:
    importFile - The uploaded .cbox package

    setWidgetService

    public any setWidgetService(any widgetService)

    Parameters:
    widgetService

    setZipUtil

    public any setZipUtil(any zipUtil)

    Parameters:
    zipUtil