SConfig Class Reference

List of all members.

Static Public Member Functions
static	getDefault ($key)
	INSERT BRIEF DESCRIPTION HERE.
static	getNotFound ()
	INSERT BRIEF DESCRIPTION HERE.
static	getOption ($key)
	INSERT BRIEF DESCRIPTION HERE.
static	initialize ()
	INSERT BRIEF DESCRIPTION HERE.
static	isDefaultSet ($key)
	INSERT BRIEF DESCRIPTION HERE.
static	isOptionSet ($key)
	INSERT BRIEF DESCRIPTION HERE.
static	setDefault ($key, $value)
	Set the default value for an option.
static	setOption ($key, $value)
	INSERT BRIEF DESCRIPTION HERE.

---

Detailed Description

SConfig

A static class for storing all the defaults and options for use with a Shodor Web App (in lieu of storing them all in the global scope)

Defaults are (in most cases) what the server or framework specifies as the "normal" value of an option. Option values can be set to mask/override those defaults. If an option value is not found, the default value is returned. When a value is not found, the miss is logged in the notFound array for reporting.

Created: 11/27/07 -- jwsm@shodor.org

---

Member Function Documentation

static SConfig::getDefault

(

$

key

)

[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$key

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

static SConfig::getNotFound

(

)

[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

static SConfig::getOption

(

$

key

)

[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$key

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

static SConfig::initialize

(

)

[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

static SConfig::isDefaultSet

(

$

key

)

[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$key

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

static SConfig::isOptionSet

(

$

key

)

[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$key

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

static SConfig::setDefault	(	$	key,
		$	value
	)			[static]

Set the default value for an option.

Parameters:

	$key	[string]: The name of the option
	$value	[mixed]: The value

static SConfig::setOption	(	$	key,
		$	value
	)			[static]

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$key	[TYPE]: DESCRIPTION
	$value	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

---

The documentation for this class was generated from the following file:

• SConfig.php5