optionsPanel Class Reference

Settings editor class. More...

List of all members.

Public Attributes
	$saveTitle
	The string to put in the Save options button.
	$revertTitle
	The string to put in the Revert to saved button.
	$showHeader = true
	Wether or not to show the headers on the panel.
	$alternateTipPosition = false
	Wether to put the options' descriptions below the option or the title (default).
	$submitted = false
	This becomes true, if the options panel was submitted.
Private Member Functions
	optionsPanel ($mainVarName, $alternateTipPosition=false)
	addOption ($title, $tip, $current, $name, $type, $options="")
	addHeader ($title, $name)
	addCommand ($title, $name)
	getValue ($optionName)
	render ()
Private Attributes
	$mainVarName
	$options
	An array of optionRow items.
	$submits
	An array of submit buttons in addition to the standard one.

---

Detailed Description

Settings editor class.

Definition at line 505 of file shared-setup.php.

---

Member Function Documentation

optionsPanel::optionsPanel	(	$	mainVarName,
		$	alternateTipPosition = false
	)			[private]

Definition at line 519 of file shared-setup.php.

References $alternateTipPosition, $mainVarName, i18n(), revertTitle, and saveTitle.

Here is the call graph for this function:

optionsPanel::addOption	(	$	title,
		$	tip,
		$	current,
		$	name,
		$	type,
		$	options = ""
	)			[private]

Definition at line 530 of file shared-setup.php.

References $options.

optionsPanel::addHeader	(	$	title,
		$	name
	)			[private]

Definition at line 601 of file shared-setup.php.

optionsPanel::addCommand	(	$	title,
		$	name
	)			[private]

Definition at line 609 of file shared-setup.php.

optionsPanel::getValue

(

$

optionName

)

[private]

Definition at line 614 of file shared-setup.php.

optionsPanel::render

(

)

[private]

Definition at line 619 of file shared-setup.php.

References $submits, i18n(), renderOptionsRow(), revertTitle, saveTitle, and showHeader.

Here is the call graph for this function:

---

Member Data Documentation

optionsPanel::$saveTitle

The string to put in the Save options button.

Definition at line 507 of file shared-setup.php.

optionsPanel::$revertTitle

The string to put in the Revert to saved button.

Definition at line 508 of file shared-setup.php.

optionsPanel::$showHeader = true

Wether or not to show the headers on the panel.

Definition at line 509 of file shared-setup.php.

optionsPanel::$alternateTipPosition = false

Wether to put the options' descriptions below the option or the title (default).

Definition at line 510 of file shared-setup.php.

Referenced by optionsPanel().

optionsPanel::$submitted = false

This becomes true, if the options panel was submitted.

Definition at line 512 of file shared-setup.php.

optionsPanel::$mainVarName [private]

String containing the name of the option panel's main name, first level of the array returned as POST data

Definition at line 515 of file shared-setup.php.

Referenced by optionsPanel().

optionsPanel::$options [private]

An array of optionRow items.

Definition at line 516 of file shared-setup.php.

Referenced by addOption().

optionsPanel::$submits [private]

An array of submit buttons in addition to the standard one.

Definition at line 517 of file shared-setup.php.

Referenced by render().

---

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

• shared-setup.php