Class Trees Index phpDocumentor Project Page

Class XoopsFormRadio

(line 48)

XoopsFormElement
   |
   --XoopsFormRadio
Classes extended from XoopsFormRadio:
XoopsFormRadioYN
Yes/No radio buttons.

Located in File: Program_Root/class/xoopsform/formradio.php

A Group of radiobuttons

Class Variable Summary

Inherited Class Variable Summary

Method Summary

void

constructor XoopsFormRadio ( $caption, $name, [$value = null] )
Constructor
void

addOption ( $value, $name )
Add an option
void

addOptionArray ( $options )
Adds multiple options
array

getOptions ( )
Gets the options
string

getValue ( )
Get the pre-selected value
string

render ( )
Prepare HTML for output

Inherited Method Summary

Inherited From Class XoopsFormElement

Function Description
XoopsFormElement::XoopsFormElement() constructor
XoopsFormElement::getCaption() get the caption for the element
XoopsFormElement::getDescription() get the element's description
XoopsFormElement::getExtra() Get the extra attributes for the element
XoopsFormElement::getName() get the "name" attribute for the element
XoopsFormElement::isHidden() Find out if an element is "hidden".
XoopsFormElement::render() Generate output for the form element.
XoopsFormElement::setCaption() set the caption for the element
XoopsFormElement::setDescription() set the element's description
XoopsFormElement::setExtra() Add extra attributes to the element.
XoopsFormElement::setHidden() flag the element as "hidden"
XoopsFormElement::setName() set the "name" attribute for the element

Method Detail

Constructor XoopsFormRadio (line 71)

void

XoopsFormRadio( string $caption, string $name, [string $value = null])

Constructor
Function Parameters:
- string $caption: Caption
- string $name: "name" attribute
- string $value: Pre-selected value
Function Info:

[ Top ]

addOption (line 94)

void

addOption( string $value, string $name)

Add an option
Function 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.
Function Info:

[ Top ]

addOptionArray (line 107)

void

addOptionArray( array $options)

Adds multiple options
Function Parameters:
- array $options: Associative array of value->name pairs.
Function Info:

[ Top ]

getOptions (line 120)

array

getOptions( )

Gets the options
Function Info:
return - Associative array of value->name pairs.

[ Top ]

getValue (line 84)

string

getValue( )

Get the pre-selected value
Function Info:

[ Top ]

render (line 129)

string

render( )

Overrides XoopsFormElement::render() (Generate output for the form element.)

Prepare HTML for output
Function Info:
return - HTML

[ Top ]

Variable Detail

Documention generated on Fri, 21 Feb 2003 02:07:27 +0100 by phpDocumentor 1.2.0rc1
proudly hosted at
SourceForge.net Logo