contentbox.models.exporters

Class FileExporter

lucee.Component
    extended by contentbox.models.exporters.BaseExporter
      extended by contentbox.models.exporters.FileExporter
All Implemented Interfaces:
ICBExporter

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Exporter for file-based content

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


    • access = public
    • returntype = any
    true false
    string extension


    • access = public
    • returntype = any
    true false
    string includeFiles


    • access = public
    • returntype = any
    true false
    string type


    • access = public
    • returntype = any
    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    string getDirectory()
    string getExtension()
    string getFileList()
         Gets list of files (absolute paths) when not "all" options are chosen for export.
    string getIncludeFiles()
    numeric getTotal()
         Gets "total" based on content type.
    string getType()
    any setDirectory(string directory)
    any setExtension(string extension)
    any setIncludeFiles(string includeFiles)
    any setType(string type)
    array validate()
         Custom validator for this exporter.
     
    Methods inherited from class contentbox.models.exporters.BaseExporter
    getAllowedFormats, getDisplayName, getFileName, getFormat, getLog, getName, getPriority, isValid, setAllowedFormats, setDisplayName, setFileName, setFormat, setLog, setName, setPriority
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    directory

    property string directory

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

    extension

    property string extension

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

    includeFiles

    property string includeFiles

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

    type

    property string type

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

    Method Detail

    getDirectory

    public string getDirectory()


    getExtension

    public string getExtension()


    getFileList

    public string getFileList()

    Gets list of files (absolute paths) when not "all" options are chosen for export


    getIncludeFiles

    public string getIncludeFiles()


    getTotal

    public numeric getTotal()

    Gets "total" based on content type

    Specified by:
    getTotal in interface ICBExporter

    getType

    public string getType()


    setDirectory

    public any setDirectory(string directory)

    Parameters:
    directory

    setExtension

    public any setExtension(string extension)

    Parameters:
    extension

    setIncludeFiles

    public any setIncludeFiles(string includeFiles)

    Parameters:
    includeFiles

    setType

    public any setType(string type)

    Parameters:
    type

    validate

    public array validate()

    Custom validator for this exporter...any rules can be applied

    Specified by:
    validate in interface ICBExporter