Config Class Reference

Singleton Config holds configuration data. More...

List of all members.

Public Member Functions

 cacheDir ()
 Relative path to long-term cache directory.
 classDir ()
 Relative path to class definition files.
 documentRoot ()
 Base path for all files accessed at server's side.
 execPhpDir ()
 Relative path to directory used for FileBrowser's action=execPHP.
 filesDir ()
 Relative path to FileBrowser data root.
 geshiDir ()
 Relative path to GeSHi.
 htmlDir ()
 Relative path to directory used for FileBrowser's action=directAccess.
 imgDir ()
 Relative path to images.
 pageDir ()
 Relative path to XML and XSL templates containing visible web data.
 scriptDir ()
 Relative path to Javascript files.
 setCacheDir ($cacheDir)
 Set relative path to long-term cache directory.
 setClassDir ($classDir)
 Set relative path to class definition files.
 setDocumentRoot ($documentRoot)
 Set base path for all files accessed at server's side.
 setExecPhpDir ($execPhpDir)
 Set relative path to directory used for FileBrowser's action=execPHP.
 setFilesDir ($filesDir)
 Set relative path to FileBrowser data root.
 setGeshiDir ($geshiDir)
 Set relative path to GeSHi.
 setHtmlDir ($htmlDir)
 Set relative path to directory used for FileBrowser's action=directAccess.
 setImgDir ($imgDir)
 Set relative path to images.
 setPageDir ($pageDir)
 Set relative path to XML and XSL templates containing visible web data.
 setScriptDir ($scriptDir)
 Set relative path to Javascript files.
 setSmartyDir ($smartyDir)
 Set absolute path to Smarty.
 setStyleDir ($styleDir)
 Set relative path to CSS files.
 setTmpDir ($tmpDir)
 Set relative path to temp directory.
 setWebMasterMail ($webMasterMail)
 Set webmaster's email address.
 setWebName ($webName)
 Set visible name of the web.
 setWebRoot ($webRoot)
 Set URL base for all files accessed from web browser.
 smartyDir ()
 Absolute path to Smarty.
 styleDir ()
 Relative path to CSS files.
 tmpDir ()
 Relative path to temp directory.
 webMasterMail ()
 Webmaster's email address.
 webName ()
 Visible name of the web.
 webRoot ()
 URL base for all files accessed from web browser.

Static Public Member Functions

static instance ()
 Access point to singleton instance.

Public Attributes

 $smartyConf = Array()
 Smarty class default configuration (paths, etc. ).


Detailed Description

Singleton Config holds configuration data.

Definition at line 11 of file base.php.


Member Function Documentation

Config::cacheDir (  ) 

Relative path to long-term cache directory.

Returns:
Relative path to long-term cache directory.
Note:
Write privileges are required.

Definition at line 150 of file base.php.

Config::classDir (  ) 

Relative path to class definition files.

Returns:
Relative path to class definition files.

Definition at line 93 of file base.php.

Config::documentRoot (  ) 

Base path for all files accessed at server's side.

Default is $_SERVER['DOCUMENT_ROOT'].

Returns:
Base path for all files accessed at server's side.

Definition at line 28 of file base.php.

Config::execPhpDir (  ) 

Relative path to directory used for FileBrowser's action=execPHP.

Returns:
Relative path to directory used for FileBrowser's action=execPHP.

Definition at line 267 of file base.php.

Config::filesDir (  ) 

Relative path to FileBrowser data root.

Returns:
Relative path to FileBrowser data root.

Definition at line 235 of file base.php.

Config::geshiDir (  ) 

Relative path to GeSHi.

Returns:
Relative path to GeSHi.

Definition at line 219 of file base.php.

Config::htmlDir (  ) 

Relative path to directory used for FileBrowser's action=directAccess.

Returns:
Relative path to directory used for FileBrowser's action=directAccess.

Definition at line 251 of file base.php.

Config::imgDir (  ) 

Relative path to images.

Returns:
Relative path to images.
Note:
There should be only common usage images. Page-specific images can be in filesDir or htmlDir.

Definition at line 185 of file base.php.

Config::pageDir (  ) 

Relative path to XML and XSL templates containing visible web data.

Returns:
Relative path to XML and XSL templates containing visible web data.

Definition at line 203 of file base.php.

Config::scriptDir (  ) 

Relative path to Javascript files.

Returns:
Relative path to Javascript files.

Definition at line 133 of file base.php.

Config::setCacheDir ( cacheDir  ) 

Set relative path to long-term cache directory.

Parameters:
cacheDir Relative path to long-term cache directory.
Note:
Write privileges are required.

Definition at line 158 of file base.php.

Config::setClassDir ( classDir  ) 

Set relative path to class definition files.

Parameters:
classDir Relative path to class definition files.

Definition at line 100 of file base.php.

Config::setDocumentRoot ( documentRoot  ) 

Set base path for all files accessed at server's side.

Default is $_SERVER['DOCUMENT_ROOT'].

Parameters:
documentRoot Base path for all files accessed at server's side.

Definition at line 36 of file base.php.

Config::setExecPhpDir ( execPhpDir  ) 

Set relative path to directory used for FileBrowser's action=execPHP.

Parameters:
execPhpDir Relative path to directory used for FileBrowser's action=execPHP.

Definition at line 274 of file base.php.

Config::setFilesDir ( filesDir  ) 

Set relative path to FileBrowser data root.

Parameters:
filesDir Relative path to FileBrowser data root.

Definition at line 242 of file base.php.

Config::setGeshiDir ( geshiDir  ) 

Set relative path to GeSHi.

Parameters:
geshiDir Relative path to GeSHi.

Definition at line 226 of file base.php.

Config::setHtmlDir ( htmlDir  ) 

Set relative path to directory used for FileBrowser's action=directAccess.

Parameters:
htmlDir Relative path to directory used for FileBrowser's action=directAccess.

Definition at line 258 of file base.php.

Config::setImgDir ( imgDir  ) 

Set relative path to images.

Parameters:
imgDir Relative path to images.
Note:
There should be only common usage images. Page-specific images can be in filesDir or htmlDir.

Definition at line 194 of file base.php.

Config::setPageDir ( pageDir  ) 

Set relative path to XML and XSL templates containing visible web data.

Parameters:
pageDir Relative path to XML and XSL templates containing visible web data.

Definition at line 210 of file base.php.

Config::setScriptDir ( scriptDir  ) 

Set relative path to Javascript files.

Parameters:
scriptDir Relative path to Javascript files.

Definition at line 140 of file base.php.

Config::setSmartyDir ( smartyDir  ) 

Set absolute path to Smarty.

Parameters:
smartyDir Absolute path to Smarty.
Note:
This path is not relative due to historical reasons.

Definition at line 118 of file base.php.

Config::setStyleDir ( styleDir  ) 

Set relative path to CSS files.

Parameters:
styleDir Relative path to CSS files.

Definition at line 174 of file base.php.

Config::setTmpDir ( tmpDir  ) 

Set relative path to temp directory.

Parameters:
tmpDir Relative path to temp directory.
Note:
Write privileges are required.

Definition at line 292 of file base.php.

Config::setWebMasterMail ( webMasterMail  ) 

Set webmaster's email address.

Parameters:
webMasterMail Webmaster's email address.

Definition at line 68 of file base.php.

Config::setWebName ( webName  ) 

Set visible name of the web.

Parameters:
webName Visible name of the web.

Definition at line 52 of file base.php.

Config::setWebRoot ( webRoot  ) 

Set URL base for all files accessed from web browser.

Parameters:
webRoot URL base for all files accessed from web browser.

Definition at line 84 of file base.php.

Config::smartyDir (  ) 

Absolute path to Smarty.

Returns:
Absolute path to Smarty.
Note:
This path is not relative due to historical reasons.

Definition at line 110 of file base.php.

Config::styleDir (  ) 

Relative path to CSS files.

Returns:
Relative path to CSS files.

Definition at line 167 of file base.php.

Config::tmpDir (  ) 

Relative path to temp directory.

Returns:
Relative path to temp directory.
Note:
Write privileges are required.

Definition at line 284 of file base.php.

Config::webMasterMail (  ) 

Webmaster's email address.

Returns:
Webmaster's email address.

Definition at line 61 of file base.php.

Config::webName (  ) 

Visible name of the web.

Returns:
Visible name of the web.

Definition at line 45 of file base.php.

Config::webRoot (  ) 

URL base for all files accessed from web browser.

Returns:
URL base for all files accessed from web browser.

Definition at line 77 of file base.php.


Member Data Documentation

Config::$smartyConf = Array()

Smarty class default configuration (paths, etc. ).

Note:
See Smarty manual for more help.

Definition at line 126 of file base.php.


The documentation for this class was generated from the following file:
Generated on Sat Mar 8 10:26:43 2008 for Dudka.cz by  doxygen 1.5.4