Class Trees Index phpDocumentor Project Page

Class XoopsFormCheckBox

(line 46)

XoopsFormElement
   |
   --XoopsFormCheckBox

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

One or more Checkbox(es)

Class Variable Summary

Inherited Class Variable Summary

Method Summary

void

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

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

addOptionArray ( $options )
Add multiple Options at once
array

getOptions ( )
Get an array with all the options
string

getValue ( )
Get the "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 XoopsFormCheckBox (line 69)

void

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

Constructor
Function Parameters:
- string $caption:
- string $name:
- mixed $value: Either one value as a string or an array of them.
Function Info:

[ Top ]

addOption (line 98)

void

addOption( string $value, string $name)

Add an option
Function Parameters:
- string $value:
- string $name:
Function Info:

[ Top ]

addOptionArray (line 111)

void

addOptionArray( array $options)

Add multiple Options at once
Function Parameters:
- array $options: Associative array of value->name pairs
Function Info:

[ Top ]

getOptions (line 124)

array

getOptions( )

Get an array with all the options
Function Info:
return - Associative array of value->name pairs

[ Top ]

getValue (line 88)

string

getValue( )

Get the "value"
Function Info:

[ Top ]

render (line 133)

string

render( )

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

prepare HTML for output
Function Info:

[ Top ]

Variable Detail

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