ValidateThis API Documentation

ValidateThis.util
Class FileSystem

WEB-INF.cftags.component
        extended by ValidateThis.util.FileSystem

public class FileSystem
extends WEB-INF.cftags.component

I am responsible for all file system access.


Constructor Summary
init(any transientFactory)
          I build a new Filesystem Object
 
Method Summary
 any CheckDirectoryExists(string Destination)
 any CheckFileExists(any Destination, any FileName)
 any CreateFile(string Destination, any FileName, any Content)
 any delete(string Destination, string FileName)
private any fixDestination([string Destination=''], [boolean createDir='false'])
          I ensure that the destination ends with a slash, and I create the destination directory if it doesn't exist
 string getAbsolutePath(string path)
          Turn any system path, either relative or absolute, into a fully qualified one
 any getMappingPath([string Mapping=''])
          I convert a dot path notation to full system path
 any listDirs(string Destination, [string Filter=''])
          returns a list of directories
 any listFiles(string Destination, [string Filter=''], [boolean recurse='false'])
          returns a list of filenames
 any listRelativeFilePaths(string Destination, [string Filter=''], [boolean recurse='false'])
          returns a list of filenames with path info
 struct move(string Destination, string sourceFileName, string sourceFileExt, [string fileName='[runtime expression]'], [any Result='[runtime expression]'])
private any newResult()
 any read(string Destination, [string FileName=''])
private string uniquefilename()
 any upload(string Destination, string formFieldName, [string NewFileName])
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any transientFactory)
I build a new Filesystem Object

Parameters:
transientFactory
Method Detail

CheckDirectoryExists

public any CheckDirectoryExists(string Destination)

Parameters:
Destination - A comma delimited list of relative or absolute paths

CheckFileExists

public any CheckFileExists(any Destination, any FileName)

Parameters:
Destination
FileName

CreateFile

public any CreateFile(string Destination, any FileName, any Content)

Parameters:
Destination
FileName
Content

delete

public any delete(string Destination, string FileName)

Parameters:
Destination
FileName

fixDestination

private any fixDestination([string Destination=''], [boolean createDir='false'])
I ensure that the destination ends with a slash, and I create the destination directory if it doesn't exist

Parameters:
Destination
createDir

getAbsolutePath

public string getAbsolutePath(string path)
Turn any system path, either relative or absolute, into a fully qualified one

Parameters:
path - Abstract pathname

getMappingPath

public any getMappingPath([string Mapping=''])
I convert a dot path notation to full system path.

Parameters:
Mapping

listDirs

public any listDirs(string Destination, [string Filter=''])
returns a list of directories

Parameters:
Destination
Filter

listFiles

public any listFiles(string Destination, [string Filter=''], [boolean recurse='false'])
returns a list of filenames

Parameters:
Destination
Filter
recurse

listRelativeFilePaths

public any listRelativeFilePaths(string Destination, [string Filter=''], [boolean recurse='false'])
returns a list of filenames with path info

Parameters:
Destination
Filter
recurse

move

public struct move(string Destination, string sourceFileName, string sourceFileExt, [string fileName='[runtime expression]'], [any Result='[runtime expression]'])

Parameters:
Destination
sourceFileName
sourceFileExt
fileName
Result

newResult

private any newResult()


read

public any read(string Destination, [string FileName=''])

Parameters:
Destination
FileName

uniquefilename

private string uniquefilename()


upload

public any upload(string Destination, string formFieldName, [string NewFileName])

Parameters:
Destination
formFieldName
NewFileName

ValidateThis API Documentation