XoopsFormRadio Class Reference

Inheritance diagram for XoopsFormRadio:

Public Member Functions
	addOption ($value, $name= '')
	addOptionArray ($options)
	getDelimeter ($encode=false)
	getOptions ($encode=false)
	getValue ($encode=false)
	render ()
	setValue ($value)
	XoopsFormRadio ($caption, $name, $value=null, $delimeter= ' ')
Public Member Functions inherited from XoopsFormElement
	getAccessKey ()
	getAccessString ($str)
	getCaption ($encode=false)
	getClass ()
	getDescription ($encode=false)
	getExtra ($encode=false)
	getFormType ()
	getName ($encode=true)
	getNocolspan ()
	getTitle ($encode=true)
	isContainer ()
	isHidden ()
	isRequired ()
	render ()
	renderValidationJS ()
	setAccessKey ($key)
	setCaption ($caption)
	setClass ($class)
	setDescription ($description)
	setExtra ($extra, $replace=false)
	setFormType ($value= '')
	setHidden ()
	setName ($name)
	setNocolspan ($nocolspan=true)
	XoopsFormElement ()

Public Attributes
	$_delimeter
	$_options = array()
	$_value = null
	$columns
Public Attributes inherited from XoopsFormElement
	$_accesskey = ''
	$_caption
	$_class = array()
	$_description = ''
	$_extra = array()
	$_formtype = ''
	$_hidden = false
	$_name
	$_nocolspan = false
	$_required = false
	$customValidationCode = array()

Detailed Description

Definition at line 23 of file formradio.php.

Member Function Documentation

XoopsFormRadio::addOption	(		$value,
			$name = ''
	)

Add an option

Parameters

string	$value	"value" attribute - This gets submitted as form-data.
string	$name	"name" attribute - This is displayed. If empty, we use the "value" instead.

Definition at line 101 of file formradio.php.

Referenced by addOptionArray(), and profile_getUserForm().

Here is the caller graph for this function:

XoopsFormRadio::addOptionArray

(

$options

)

Adds multiple options

Parameters

array

$options

Associative array of value->name pairs.

Definition at line 115 of file formradio.php.

References $options, and addOption().

Here is the call graph for this function:

XoopsFormRadio::getDelimeter

(

$encode = false

)

Get the delimiter of this group

Parameters

bool

$encode

To sanitizer the text?

Returns

string The delimiter

Definition at line 148 of file formradio.php.

References $_delimeter.

Referenced by render().

Here is the caller graph for this function:

XoopsFormRadio::getOptions

(

$encode = false

)

Get an array with all the options

Parameters

int

$encode

To sanitizer the text? potential values: 0 - skip; 1 - only for value; 2 - for both value and name

Returns

array Associative array of value->name pairs

Definition at line 130 of file formradio.php.

References $_options.

Referenced by render().

Here is the caller graph for this function:

XoopsFormRadio::getValue

(

$encode = false

)

Get the "value" attribute

Parameters

bool

$encode

To sanitizer the text?

Returns

string

Definition at line 80 of file formradio.php.

References $_value.

Referenced by render().

Here is the caller graph for this function:

XoopsFormRadio::render

(

)

Prepare HTML for output

Returns

string HTML

Definition at line 158 of file formradio.php.

References $i, $ret, getDelimeter(), XoopsFormElement\getExtra(), XoopsFormElement\getName(), getOptions(), XoopsFormElement\getTitle(), and getValue().

Here is the call graph for this function:

XoopsFormRadio::setValue

(

$value

)

Set the pre-selected value

Parameters

$value

string

Definition at line 90 of file formradio.php.

Referenced by XoopsFormRadio().

Here is the caller graph for this function:

XoopsFormRadio::XoopsFormRadio	(		$caption,
			$name,
			$value = null,
			$delimeter = ' '
	)

Constructor

Parameters

string	$caption	Caption
string	$name	"name" attribute
string	$value	Pre-selected value

Definition at line 64 of file formradio.php.

References XoopsFormElement\setCaption(), XoopsFormElement\setName(), and setValue().

Here is the call graph for this function:

Member Data Documentation

XoopsFormRadio::$_delimeter

Definition at line 47 of file formradio.php.

Referenced by getDelimeter().

XoopsFormRadio::$_options = array()

Definition at line 31 of file formradio.php.

Referenced by getOptions().

XoopsFormRadio::$_value = null

Definition at line 39 of file formradio.php.

Referenced by getValue().

XoopsFormRadio::$columns

Definition at line 55 of file formradio.php.

---

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

• L:/0xoops/xoops-2.5.6/htdocs/class/xoopsform/formradio.php