FileManager Class Reference

extras beyond what Node.js FileSystem provides More...

Public Member Functions
	findClose (object inFindData)
	stop and cleanup after a file/directory search More...
string[]	findDirs (string name)
	return a list of directories that match the given name More...
string[]	findFiles (string name)
	return a list of files that match the given name More...
object	findFirst (string inFindName)
	get the first matching file or directory More...
object	findNext (object inFindData)
	return the next matching file or directory More...
string	getApplicationDataDirectory ()
	return the path to the location the application should store its user data More...
string	getApplicationDirectory ()
	return the path to the location the application is installed More...
string	getApplicationResourceDirectory ()
	return the path to the location where the application's internal resources are stored More...

Related Functions
(Note that these are not member functions.)
	fs
	the singleton instance of the FileManager More...
	getFileManager
	get the singleton instance of the FileManager used by the pdg framework More...

Detailed Description

extras beyond what Node.js FileSystem provides

Note

API Stability: 2 - Unstable. The API is in the process of settling, but has not yet had sufficient real-world testing to be considered stable. Backwards-compatibility will be maintained if reasonable.

Most functions for file manipulation are provided by Node.js though the FileSystem class. The PDG FileManager just adds calls to get particular directory paths and to do file searchs.

See Also

http://nodejs.org/api/fs.html

Member Function Documentation

findClose

(

object

inFindData

)

stop and cleanup after a file/directory search

This takes the object returned from a findFirst() or findNext(), and cleans up after the search, releasing all resources used by the search.

Parameters

inFindData

the object returned from a prior call to findFirst() or findNext()

See Also

findFirst

findNext

findDirs

(

string

name

)

return a list of directories that match the given name

This uses the findFirst() and findNext() calls to search for any directories that match the name passed in. The name can contain wildcard characters (*.txt, or f1?.dat). If the name includes a path, it must use Unix format (forward slash "/" as path separators). Colon and backslash are both illegal characters.

Parameters

name	the directory name to find

Returns

an array of directories that match the name

See Also

findFirst

findNext

findFiles

(

string

name

)

return a list of files that match the given name

This uses the findFirst() and findNext() calls to search for any files that match the name passed in. The name can contain wildcard characters (*.txt, or f1?.dat). If the name includes a path, it must use Unix format (forward slash "/" as path separators). Colon and backslash are both illegal characters.

Parameters

name	the filename to find

Returns

an array of files that match the name

See Also

findFirst

findNext

findFirst

(

string

inFindName

)

get the first matching file or directory

This searches for any files or directories that match the name passed in, and returns the first one it finds. The name can contain wildcard characters (*.txt, or f1?.dat). If the name includes a path, it must use Unix format (forward slash "/" as path separators). Colon and backslash are both illegal characters.

Parameters

inFindName

the directory or file name to find

Returns

an object with nodeName, isDirectory, and found fields: nodeName is the full path of the found item; isDirectory is true if the node is a directory, false for files; found is false if no matching item was found.

See Also

findNext

findClose

findNext

(

object

inFindData

)

return the next matching file or directory

This uses the object returned from a findFirst() call to continue the search and find additional matching files or directories.

Parameters

inFindData

the object returned from a prior call to findFirst() or findNext()

Returns

an object with nodeName, isDirectory, and found fields: nodeName is the full path of the next found item; isDirectory is true if the node is a directory, false for files; found is false if no additional matching item was found.

See Also

findFirst

findClose

getApplicationDataDirectory

(

)

return the path to the location the application should store its user data

Returns

a full path to the application's user data directory

getApplicationDirectory

(

)

return the path to the location the application is installed

Returns

a full path to the application's directory

Note

For Mac OS X this is the location of the application bundle

getApplicationResourceDirectory

(

)

return the path to the location where the application's internal resources are stored

Returns

a full path to the application's resource directory

Note

on Mac OS X the is the Contents/Resources directory within the application bundle

Friends And Related Function Documentation

getFileManager

related

get the singleton instance of the FileManager used by the pdg framework

Returns

FileManager singleton object