Inheritance diagram for MOAIFileSystem:
Function Documentation
|
Creates a folder at 'path' if none exists.
function affirmPath ( string path )
- Parameters
-
string path
- Returns
- nil
|
Check for the existence of a file.
function checkFileExists ( string filename )
- Parameters
-
string filename
- Returns
- boolean exists
|
Check for the existence of a path.
function checkPathExists ( string path )
- Parameters
-
string path
- Returns
- boolean exists
|
Copy a file or directory to a new location.
function copy ( string srcPath, string destPath )
- Parameters
-
string srcPath string destPath
- Returns
- boolean result
|
Deletes a directory and all of its contents.
function deleteDirectory ( string path [, boolean recursive ] )
- Parameters
-
string path boolean recursive Optional. If true, the directory and all contents beneath it will be purged. Otherwise, the directory will only be removed if empty.
- Returns
- boolean success
|
Deletes a file.
function deleteFile ( string filename )
- Parameters
-
string filename
- Returns
- boolean success
|
Returns the absolute path given a relative path.
function getAbsoluteDirectoryPath ( string path )
- Parameters
-
string path
- Returns
- string absolute
|
Returns the absolute path to a file. Result includes the file name.
function getAbsoluteFilePath ( string filename )
- Parameters
-
string filename
- Returns
- string absolute
|
Given an absolute path returns the relative path in relation to the current working directory or a user supplied 'base' directory.
function getRelativePath ( string path [, string base ] )
- Parameters
-
string path string base Optional.
- Returns
- string path
|
Given a virtual path, return the path to the archive and, if the path is to a file, the offset to the file record within the archive.
function getVirtualPathInfo ( string path [, string offsetToHeader, number uncompressedSize, number compressedSize ] )
- Parameters
-
string path A virtual path. string offsetToHeader Optional. Offset to the file record header in the archive, or nil if not a file path. number uncompressedSize Optional. Uncompressed size of the file or nil if not a file path. number compressedSize Optional. Compressed size of the file or nil if not compressed or not a file path.
- Returns
- string pathToArchive, string localPath
|
Returns the path to current working directory.
function getWorkingDirectory ()
- Returns
- string path
|
Lists the sub-directories contained in a directory.
function listDirectories ( [ string path ] )
- Parameters
-
string path Optional. Path to search. Default is current directory.
- Returns
- table directories
|
Lists the files contained in a directory.
function listFiles ( [ string path ] )
- Parameters
-
string path Optional. Path to search. Default is current directory.
- Returns
- table files
|
Open and read the entirity of a file into a string.
function loadFile ( string filename )
- Parameters
-
string filename
- Returns
- string contents
|
Mount an archive as a virtual filesystem directory.
function mountVirtualDirectory ( string path [, string archive ] )
- Parameters
-
string path Virtual path. string archive Optional. Name of archive file to mount. Default value is nil.
- Returns
- boolean success
|
Renames a file or folder.
function rename ( string oldPath, string newPath )
- Parameters
-
string oldPath string newPath
- Returns
- boolean success
|
Create or overwrite a file to contain the contents of a given string.
function saveFile ( string filename [, string contents ] )
- Parameters
-
string filename string contents Optional.
- Returns
- nil
|
Sets the current working directory.
function setWorkingDirectory ( string path )
- Parameters
-
string path
- Returns
- boolean success
|
Strip the timestamp from a pkzip file. Useful in systems where periodically generated pkzip files are compared against each other using hashes. Once timestamps are stripeed, two pkzip files with the same contents should produce identical hashes.
function stripPKZipTimestamps ( string infilename, string outfilename )
- Parameters
-
string infilename string outfilename
- Returns
- boolean success
