Config Class Reference
[Core]

Contains Configuration parameters. More...


Static Public Member Functions
static	create_fingerprint ()
	Creates a hash from config values.
static	get_url ($feature)
	Returns given url.
static	get_value ($feature, $require=false, $default=false)
	Returns given value.
static	has_feature ($feature)
	Returns TRUE, if given feature is enabled.
static	set_feature ($feature, $enabled)
	Enable or disable a feature.
static	set_feature_from_constant ($feature, $constant, $default)
	Set a feature by reading given constant.
static	set_value ($feature, $value)
	Set a value.
static	set_value_from_constant ($feature, $constant, $default)
	Set a value by reading given constant.
Public Attributes
const	CACHEHEADER_CLASS_CACHED = 'CACHEHEADER_CLASS_CACHED'
	CacheHeaderManager policy for cached stuff.
const	CACHEHEADER_CLASS_UNCACHED = 'CACHEHEADER_CLASS_UNCACHED'
	CacheHeaderManager policy for uncached stuff.
const	DB_SLOW_QUERY_THRESHOLD = 'DB_SLOW_QUERY_THRESHOLD'
const	DEBUG_QUERIES = 'DEBUG_QUERIES'
const	DEFAULT_TEMPLATE_ENGINE = 'DEFAULT_TEMPLATE_ENGINE'
	Template engine.
const	DISABLE_CACHE = 'DISABLE_CACHE'
const	ENABLE_HTTPS = 'ENABLE_HTTPS'
const	FORCE_FULL_DOMAINNAME = 'FORCE_FULL_DOMAINNAME'
const	FORMVALIDATION_EXPIRATION_TIME = 'FORMVALIDATION_EXPIRATION_TIME'
const	FORMVALIDATION_FIELD_NAME = 'FORMVALIDATION_FIELD_NAME'
const	FORMVALIDATION_HANDLER_NAME = 'FORMVALIDATION_HANDLER_NAME'
const	GZIP_SUPPORT = 'GZIP'
const	ITEMS_PER_PAGE = 'ITEMS_PER_PAGE'
const	LOG_FAILED_QUERIES = 'LOG_FAILED_QUERIES'
const	LOG_HTML_ERROR_STATUS = 'LOG_HTML_ERROR_STATUS'
const	LOG_HTTPREQUESTS = 'LOG_HTTPREQUESTS'
const	LOG_QUERIES = 'LOG_QUERIES'
	LOGGING.
const	LOG_SLOW_QUERIES = 'LOG_SLOW_QUERIES'
const	LOG_TRANSLATIONS = 'LOG_TRANSLATIONS'
const	MAIL_ADMIN = 'MAIL_ADMIN'
	Address to receive system notifications.
const	MAIL_SENDER = 'MAIL_SENDER'
	Default FROM address.
const	MAIL_SUBJECT = 'MAIL_SUBJECT'
	Added to each email subject line.
const	MAIL_SUPPORT = 'MAIL_SUPPORT'
	Address to receive user mails (e.g.
const	MAILER_SMTP_HOST = 'MAILER_SMTP_HOST'
	SMTP Host.
const	MAILER_SMTP_PASSWORD = 'MAILER_SMTP_PASSWORD'
	SMTP Password.
const	MAILER_SMTP_USER = 'MAILER_SMTP_USER'
	SMTP User.
const	MAILER_TYPE = 'MAILER_TYPE'
	Mailer type.
const	OUT_DIR = 'OUT_DIR'
	Files output directory.
const	PAGE_TEMPLATE = 'PAGE_TEMPLATE'
const	PAGER_NUM_LINKS = 'PAGER_NUM_LINKS'
const	PRINT_DURATION = 'PRINT_DURATION'
const	QUERY_PARAM_PATH_INVOKED = 'QUERY_PARAM_PATH_INVOKED'
	The query parameter that contains the path orignally invoked.
const	SESSION_HANDLER = 'SESSION_HANDLER'
	Name of Session Handling Class (class must be included manually).
const	START_SESSION = 'START_SESSION'
const	TEMP_DIR = 'TEMP_DIR'
	Temporary directory.
const	TESTMODE = 'TESTMODE'
const	THIRDPARTY_DIR = '3RDPARTY_DIR'
	Include 3rd party dir.
const	THROW_ON_DB_ERROR = 'THROW_ON_DB_ERROR'
const	THROW_ON_WARNING = 'THROW_ON_WARNING'
const	TITLE = 'TITLE'
const	URL_ABSPATH = 'URL_ABSPATH'
const	URL_BASEDIR = 'URL_BASEDIR'
const	URL_BASEURL = 'URL_BASEURL'
const	URL_BASEURL_SAFE = 'URL_BASEURL_SAFE'
const	URL_DEFAULT_PAGE = 'URL_DEFAULT_PAGE'
	The default URL for users not logged in.
const	URL_DOMAIN = 'URL_DOMAIN'
	Some URLs.
const	URL_IMAGES = 'URL_IMAGES'
const	URL_IMAGES_DIR = 'URL_IMAGES_DIR'
	URL of Images.
const	URL_SERVER = 'URL_SERVER'
const	URL_SERVER_SAFE = 'URL_SERVER_SAFE'
const	VALIDATE_URL = 'VALIDATE_URL'
	True to validate url on start.
const	VERSION = 'VERSION'
	Version of Gyro.
const	VERSION_MAX = 'VERSION_MAX'
	Max Gyro version the application supports.

Detailed Description

Contains Configuration parameters.

Author:: Gerd Riesselmann

Definition at line 8 of file config.cls.php.

Member Function Documentation

static Config::create_fingerprint ( ) [static]

Creates a hash from config values.

Returns:: string 40 character long hexstring (sha1)

Definition at line 240 of file config.cls.php.

00240                                                     {
00241                 $ret = '';
00242                 foreach(self::$data as $key => $value) {
00243                         $ret .= $value;
00244                 }
00245                 return sha1($ret);
00246         }

static Config::get_url ( $ feature ) [static]

Returns given url.

Urls are values with placeholders, namely

domain%: Replaced with domain
basedir%: Replaced with base dir

Parameters:

string

$feature

Returns:: string

Definition at line 228 of file config.cls.php.

00228                                                  {
00229                 $url = self::get_value($feature, true);
00230                 $url = str_replace('%domain%', self::get_value(self::URL_DOMAIN), $url);
00231                 $url = str_replace('%basedir%', self::get_value(self::URL_BASEDIR), $url);
00232                 return $url;
00233         }

static Config::get_value	(	$	feature,
		$	require = `false`,
		$	default = `false`
	)			`[static]`

Returns given value.

Parameters:

	string	$feature
	bool	$require If set, an exception is raised if value not set

Returns:: mixed

Definition at line 187 of file config.cls.php.

00187                                                                                        {
00188                 if (isset(self::$data[$feature])) {
00189                         return self::$data[$feature]; 
00190                 }
00191                 else if ($require) {
00192                         throw new Exception(tr('Required Config-Value %feature not set', 'core', array('%feature' => $feature)));
00193                 }
00194                 return $default;        
00195         }

static Config::has_feature ( $ feature ) [static]

Returns TRUE, if given feature is enabled.

Parameters:

string

$feature

Returns:: bool

Definition at line 150 of file config.cls.php.

00150                                                      {
00151                 return isset(self::$data[$feature]);    
00152         }

static Config::set_feature	(	$	feature,
		$	enabled
	)			`[static]`

Enable or disable a feature.

Parameters:

	string	$feature
	bool	$enabled

Definition at line 160 of file config.cls.php.

00160                                                                {
00161                 if ($enabled) {
00162                         self::$data[$feature] = true;
00163                 }
00164                 else {
00165                         unset(self::$data[$feature]);
00166                 }
00167         }

static Config::set_feature_from_constant	(	$	feature,
		$	constant,
		$	default
	)			`[static]`

Set a feature by reading given constant.

Parameters:

	string	$feature
	string	$constant
	bool	$default

Definition at line 176 of file config.cls.php.

00176                                                                                         {
00177                 self::set_feature($feature, defined($constant) ? constant($constant) : $default); 
00178         }

static Config::set_value	(	$	feature,
		$	value
	)			`[static]`

Set a value.

Parameters:

	string	$feature
	mixed	$value

Definition at line 203 of file config.cls.php.

00203                                                            {
00204                 self::$data[$feature] = $value;
00205         }

static Config::set_value_from_constant	(	$	feature,
		$	constant,
		$	default
	)			`[static]`

Set a value by reading given constant.

Parameters:

	string	$feature
	string	$constant
	mixed	$default

Definition at line 214 of file config.cls.php.

00214                                                                                       {
00215                 self::set_value($feature, defined($constant) ? constant($constant) : $default); 
00216         }