Docs For Class System_Folders

System_Folders_Cached (Constructor) [line 75]

System_Folders_Cached System_Folders_Cached(
)

Create a new instance

[ Top ]

getAllUsers [line 239]

string getAllUsers(
)

Cached version of getAllUsers().

Return: The all users directory
See: System_Folders::getAllUsers()
Access: public

Overrides System_Folders::getAllUsers() (Returns the All Users directory.)

[ Top ]

getAppData [line 255]

string getAppData(
)

Cached version of getAppData().

Return: The application data directory
See: System_Folders::getAppData()
Access: public

Overrides System_Folders::getAppData() (Returns the path to the application data directory.)

[ Top ]

getCachedValue [line 189]

string getCachedValue(
string
$strKey)

Returns a cached value.

If the cache doesn't exist, the cached value is empty or null, the System_Folders method for the key is called to get the value.

Return: The directory
Access: protected

Parameters:

string $strKey — The id of the value to get

[ Top ]

getDefaultConfigFile [line 171]

string getDefaultConfigFile(
)

Returns the path to the default config file.

It the one that's used if no filename is passed to the saveToFile/loadFromFile methods.

Return: The filename
Access: public

[ Top ]

getDesktop [line 271]

string getDesktop(
)

Cached version of getDesktop().

Return: The desktop directory
See: System_Folders::getDesktop()
Access: public

Overrides System_Folders::getDesktop() (Returns the path to the user's desktop.)

[ Top ]

getDocuments [line 287]

string getDocuments(
)

Cached version of getDocuments().

Return: The documents directory
See: System_Folders::getDocuments()
Access: public

Overrides System_Folders::getDocuments() (Returns the path to the user's documents directory.)

[ Top ]

getHome [line 303]

string getHome(
)

Cached version of getHome().

Return: The home directory
See: System_Folders::getHome()
Access: public

Overrides System_Folders::getHome() (Returns the path to the user's home directory.)

[ Top ]

getPrograms [line 319]

string getPrograms(
)

Cached version of getPrograms().

Return: The programs directory
See: System_Folders::getPrograms()
Access: public

Overrides System_Folders::getPrograms() (Returns the path to the programs directory.)

[ Top ]

getSharedDocuments [line 351]

string getSharedDocuments(
)

Cached version of getSharedDocuments().

Return: The shared documents directory
See: System_Folders::getSharedDocuments()
Access: public

Overrides System_Folders::getSharedDocuments() (Returns the path to the shared documents directory.)

[ Top ]

getTemp [line 335]

string getTemp(
)

Cached version of getTemp().

Return: The temporary directory
See: System_Folders::getTemp()
Access: public

Overrides System_Folders::getTemp() (Returns the path to the directory for temporary files.)

[ Top ]

getWindows [line 367]

string getWindows(
)

Cached version of getWindows().

Return: The windows directory
See: System_Folders::getWindows()
Access: public

Overrides System_Folders::getWindows() (Returns the windows directory (if any).)

[ Top ]

loadFromFile [line 93]

mixed loadFromFile(
[string
$strFile = null])

Loads the directories from an ini file.

If you don't specify the config file, it will be determined automatically.

Return: True on success, PEAR_Error on failure
Access: public

Parameters:

string $strFile — The file to load the data from (ini file)

[ Top ]

saveToFile [line 139]

mixed saveToFile(
[string
$strFile = null], [boolean
$bSaveAllSettings = true])

Saves the folders into a config file that can be edited by hand.

If you don't specify the config file, it will be determined automatically. Values that are NULL won't be saved.

Return: True on success, PEAR_Error on failure
Access: public

Parameters:

string	`$strFile`	—	The file to save the data into (ini file)
boolean	`$bSaveAllSettings`	—	If all settings shall be saved that can be loaded, or only that settings, that have been retrieved by the user

[ Top ]

setAllUsers [line 392]

void setAllUsers(
string
$value)

Sets an own all users directory.

Set it to NULL to deactivate saving and remove the value from the cache.

See: System_Folders_Cached::getAllUsers()
Access: public

Parameters:

string $value — The new all users directory

[ Top ]

setAppData [line 411]

void setAppData(
string
$value)

Sets an own application data directory.

Set it to NULL to deactivate saving and remove the value from the cache.

See: System_Folders_Cached::getAppData()
Access: public

Parameters:

string $value — The new app data directory

[ Top ]

setCachedValue [line 213]

void setCachedValue(
string
$strKey, string
$strValue)

Sets the cache of the given key to the given value.

Passing NULL removes the cache entry.

Access: protected

Parameters:

string	`$strKey`	—	Id of the value to get
string	`$strValue`	—	Value to set.

[ Top ]

setDesktop [line 430]

void setDesktop(
string
$value)

Sets an own desktop directory.

Set it to NULL to deactivate saving and remove the value from the cache.

See: System_Folders_Cached::getDesktop()
Access: public

Parameters:

string $value — The new desktop directory

[ Top ]

setDocuments [line 449]

void setDocuments(
string
$value)

Sets an own documents directory.

Set it to NULL to deactivate saving and remove the value from the cache.

See: System_Folders_Cached::getDocuments()
Access: public

Parameters:

string $value — The new documents directory

[ Top ]

setHome [line 468]

void setHome(
string
$value)

Sets an own home directory.

Set it to NULL to deactivate saving and remove the value from the cache.

See: System_Folders_Cached::getHome()
Access: public

Parameters:

string $value — The new home directory

[ Top ]

setPrograms [line 487]

void setPrograms(
string
$value)

Sets an own programs directory.

Set it to NULL to deactivate saving and remove the value from the cache.

See: System_Folders_Cached::getPrograms()
Access: public

Parameters:

string $value — The new programs directory

[ Top ]

setSharedDocuments [line 525]

void setSharedDocuments(
string
$value)

Sets an own shared documents directory.

Set it to NULL to deactivate saving and remove the value from the cache.

See: System_Folders_Cached::getSharedDocuments()
Access: public

Parameters:

string $value — The new shared documents directory

[ Top ]

setTemp [line 506]

void setTemp(
string
$value)

Sets an own temp directory.

Set it to NULL to deactivate saving and remove the value from the cache.

See: System_Folders_Cached::getTemp()
Access: public

Parameters:

string $value — The new temp directory

[ Top ]

setWindows [line 544]

void setWindows(
string
$value)

Sets an own windows directory.

Set it to NULL to deactivate saving and remove the value from the cache.

See: System_Folders_Cached::getWindows()
Access: public

Parameters:

string $value — The new windows directory

[ Top ]

Class: System_Folders_Cached

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Class: System_Folders

Inherited Methods

Class: System_Folders

Class Details

Class Variables

$arCache = array()

$arSettings = array( 'AllUsers', 'AppData', 'Desktop', 'Documents', 'Home', 'Programs', 'Temp', 'SharedDocuments', 'Windows' )

Method Detail

System_Folders_Cached (Constructor) [line 75]

getAllUsers [line 239]

getAppData [line 255]

getCachedValue [line 189]

Parameters:

getDefaultConfigFile [line 171]

getDesktop [line 271]

getDocuments [line 287]

getHome [line 303]

getPrograms [line 319]

getSharedDocuments [line 351]

getTemp [line 335]

getWindows [line 367]

loadFromFile [line 93]

Parameters:

saveToFile [line 139]

Parameters:

setAllUsers [line 392]

Parameters:

setAppData [line 411]

Parameters:

setCachedValue [line 213]

Parameters:

setDesktop [line 430]

Parameters:

setDocuments [line 449]

Parameters:

setHome [line 468]

Parameters:

setPrograms [line 487]

Parameters:

setSharedDocuments [line 525]

Parameters:

setTemp [line 506]

Parameters:

setWindows [line 544]

Parameters:

$arSettings = array(
'AllUsers', 'AppData', 'Desktop', 'Documents', 'Home',
'Programs', 'Temp', 'SharedDocuments', 'Windows'
)