mura

Class fileWriter

lucee.Component
    extended by mura.cfobject
      extended by mura.fileWriter

This provides a CRUD utility for the host file system

Class Attributes:
  • output : false
    •  
  • synchronized : false
    •  
  • accessors : false
    •  
  • persistent : false
    •  
    Constructor Summary
    init(any useMode='', any tempDir='[runtime expression]')
    Method Summary
    any appendFile([any file], [any output], any mode='[runtime expression]')
    any chmod([any path], any mode='[runtime expression]')
    any copyDir(any baseDir='', any destDir='', any excludeList='', any sinceDate='', any excludeHiddenFiles='true')
    any copyFile([any source], [any destination], any mode='[runtime expression]')
    any createDir([any directory], any mode='[runtime expression]')
    any deleteDir([any directory], any recurse='true')
    any fixQueryPaths([any rsDir], [any path='directory'])
    any getFreeSpace([any file], [any unit='gb'])
    any getTotalSpace([any file], [any unit='gb'])
    any getUsableSpace([any file], [any unit='gb'])
    any moveFile([any source], [any destination], any mode='[runtime expression]')
    private any PathFormat(string path)
         Convert path into Windows or Unix format.
    any renameDir([any directory], [any newDirectory], any mode='[runtime expression]')
    any renameFile([any source], [any destination], any mode='[runtime expression]')
    any touchDir([any directory], any mode='[runtime expression]')
    any uploadFile([any filefield], any destination='[runtime expression]', any nameConflict='makeunique', any attributes='normal', any mode='[runtime expression]', [any accept=''])
    any writeFile([any file], [any output], any addNewLine='true', any mode='[runtime expression]')
     
    Methods inherited from class mura.cfobject
    commitTracePoint, convertTimezone, deleteMethod, get, getAsJSON, getAsStruct, getBean, getConfigBean, getCurrentUser, getEventManager, getFeed, getHTTPAttrs, getHTTPService, getJavaTimezone, getPlugin, getPluginManager, getQueryAttrs, getQueryService, getServiceFactory, getSession, getValue, hasCustomDatasource, initTracePoint, inject, injectMethod, invokeMethod, mixin, parseDateArg, removeValue, set, setValue, valueExists
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any useMode='', any tempDir='[runtime expression]')

    Parameters:
    useMode
    tempDir
    Method Detail

    appendFile

    public any appendFile([any file], [any output], any mode='[runtime expression]')

    Parameters:
    file
    output
    mode

    chmod

    public any chmod([any path], any mode='[runtime expression]')

    Parameters:
    path
    mode

    copyDir

    public any copyDir(any baseDir='', any destDir='', any excludeList='', any sinceDate='', any excludeHiddenFiles='true')

    Parameters:
    baseDir
    destDir
    excludeList
    sinceDate
    excludeHiddenFiles

    copyFile

    public any copyFile([any source], [any destination], any mode='[runtime expression]')

    Parameters:
    source
    destination
    mode

    createDir

    public any createDir([any directory], any mode='[runtime expression]')

    Parameters:
    directory
    mode

    deleteDir

    public any deleteDir([any directory], any recurse='true')

    Parameters:
    directory
    recurse

    fixQueryPaths

    public any fixQueryPaths([any rsDir], [any path='directory'])

    Parameters:
    rsDir
    path

    getFreeSpace

    public any getFreeSpace([any file], [any unit='gb'])

    Parameters:
    file
    unit

    getTotalSpace

    public any getTotalSpace([any file], [any unit='gb'])

    Parameters:
    file
    unit

    getUsableSpace

    public any getUsableSpace([any file], [any unit='gb'])

    Parameters:
    file
    unit

    moveFile

    public any moveFile([any source], [any destination], any mode='[runtime expression]')

    Parameters:
    source
    destination
    mode

    PathFormat

    private any PathFormat(string path)

    Convert path into Windows or Unix format.

    Parameters:
    path - The path to convert.

    renameDir

    public any renameDir([any directory], [any newDirectory], any mode='[runtime expression]')

    Parameters:
    directory
    newDirectory
    mode

    renameFile

    public any renameFile([any source], [any destination], any mode='[runtime expression]')

    Parameters:
    source
    destination
    mode

    touchDir

    public any touchDir([any directory], any mode='[runtime expression]')

    Parameters:
    directory
    mode

    uploadFile

    public any uploadFile([any filefield], any destination='[runtime expression]', any nameConflict='makeunique', any attributes='normal', any mode='[runtime expression]', [any accept=''])

    Parameters:
    filefield
    destination
    nameConflict
    attributes
    mode
    accept

    writeFile

    public any writeFile([any file], [any output], any addNewLine='true', any mode='[runtime expression]')

    Parameters:
    file
    output
    addNewLine
    mode