contentbox.modules.contentbox-admin.models.exporters

Class StaticExporter

lucee.Component
    extended by contentbox.modules.contentbox-admin.models.exporters.StaticExporter

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Static content exporter service

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


    • access = public
    • returntype = any
    • inject = CategoryService@cb
    		 true false
    any entryService


    • access = public
    • returntype = any
    • inject = entryService@cb
    		 true false
    any interceptorService


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


    • access = public
    • returntype = any
    • inject = PageService@cb
    		 true false
    any Renderer


    • access = public
    • returntype = any
    • inject = Provider:Renderer@coldbox
    		 true false
    any settingService


    • access = public
    • returntype = any
    • inject = SettingService@cb
    		 true false
    any themeService


    • access = public
    • returntype = any
    • inject = ThemeService@cb
    		 true false
    any uiConfig


    • access = public
    • returntype = any
    • inject = coldbox:moduleconfig:contentbox-ui
    		 true false
    any zipUtil


    • access = public
    • returntype = any
    • inject = zipUtil@cb
    		 true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    struct export([any exportDirectory='[runtime expression]'], [boolean includeBlog='true'], [any modifiedDate], any event, any rc, any prc)
         Export static site with several exporting options.
    string getCategoryService()
    string getEntryService()
    string getInterceptorService()
    string getPageService()
    string getRenderer()
    string getSettingService()
    string getThemeService()
    string getUiConfig()
    string getZipUtil()
    private any processStaticEntry(any content, any event, any rc, any prc, any exportDir, any settings)
         Process a static entry export.
    private any processStaticPage(any content, [boolean isHome='false'], any event, any rc, any prc, any exportDir, any settings)
         Process a static page export.
    any setCategoryService(any categoryService)
    any setEntryService(any entryService)
    any setInterceptorService(any interceptorService)
    any setPageService(any pageService)
    any setRenderer(any Renderer)
    any setSettingService(any settingService)
    any setThemeService(any themeService)
    any setUiConfig(any uiConfig)
    any setZipUtil(any zipUtil)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init()

    Constructor

    Property Detail

    categoryService

    property any categoryService

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

    entryService

    property any entryService

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

    interceptorService

    property any interceptorService

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

    pageService

    property any pageService

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

    Renderer

    property any Renderer

    Attributes:
    access - public
    required - false
    returntype - any
    inject - Provider:Renderer@coldbox
    serializable - true

    settingService

    property any settingService

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

    themeService

    property any themeService

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

    uiConfig

    property any uiConfig

    Attributes:
    access - public
    required - false
    returntype - any
    inject - coldbox:moduleconfig:contentbox-ui
    serializable - true

    zipUtil

    property any zipUtil

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

    export

    public struct export([any exportDirectory='[runtime expression]'], [boolean includeBlog='true'], [any modifiedDate], any event, any rc, any prc)

    Export static site with several exporting options. The end result is the location of the generated site

    Parameters:
    exportDirectory - The directory to export to, defaults to the temp site creation
    includeBlog - Flag to include the blog or not in the static site export
    modifiedDate - From when to export content, defaults to ALL
    event - Request Context
    rc - RC
    prc - PRC
    Returns:
    struct with keys: { exportLog:builder, exportDirectory, exportArchive }

    getCategoryService

    public string getCategoryService()

    getEntryService

    public string getEntryService()

    getInterceptorService

    public string getInterceptorService()

    getPageService

    public string getPageService()

    getRenderer

    public string getRenderer()

    getSettingService

    public string getSettingService()

    getThemeService

    public string getThemeService()

    getUiConfig

    public string getUiConfig()

    getZipUtil

    public string getZipUtil()

    processStaticEntry

    private any processStaticEntry(any content, any event, any rc, any prc, any exportDir, any settings)

    Process a static entry export

    Parameters:
    content - The content object
    event - Request Context
    rc - RC
    prc - PRC
    exportDir - The location of export
    settings - All of the ContentBox Settings

    processStaticPage

    private any processStaticPage(any content, [boolean isHome='false'], any event, any rc, any prc, any exportDir, any settings)

    Process a static page export

    Parameters:
    content - The content object
    isHome - Is this the home page
    event - Request Context
    rc - RC
    prc - PRC
    exportDir - The location of export
    settings - All of the ContentBox Settings

    setCategoryService

    public any setCategoryService(any categoryService)

    Parameters:
    categoryService

    setEntryService

    public any setEntryService(any entryService)

    Parameters:
    entryService

    setInterceptorService

    public any setInterceptorService(any interceptorService)

    Parameters:
    interceptorService

    setPageService

    public any setPageService(any pageService)

    Parameters:
    pageService

    setRenderer

    public any setRenderer(any Renderer)

    Parameters:
    Renderer

    setSettingService

    public any setSettingService(any settingService)

    Parameters:
    settingService

    setThemeService

    public any setThemeService(any themeService)

    Parameters:
    themeService

    setUiConfig

    public any setUiConfig(any uiConfig)

    Parameters:
    uiConfig

    setZipUtil

    public any setZipUtil(any zipUtil)

    Parameters:
    zipUtil