Class Trees Index phpDocumentor Project Page

Class XoopsFormSelect

(line 47)

XoopsFormElement
   |
   --XoopsFormSelect
Classes extended from XoopsFormSelect:
XoopsFormSelectCountry
A select field with countries
XoopsFormSelectGroup
A select field with a choice of available groups
XoopsFormSelectLang
A select field with available languages
XoopsFormSelectMatchOption
A selection box with options for matching search terms.
XoopsFormSelectTheme
A select box with available themes
XoopsFormSelectTimezone
A select box with timezones

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

A select field

Class Variable Summary

Inherited Class Variable Summary

Method Summary

void

constructor XoopsFormSelect ( $caption, $name, [$value = null], [$size = 1], [$multiple = false] )
Constructor
void

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

addOptionArray ( $options )
Add multiple options
array

getOptions ( )
Get all options
int

getSize ( )
Get the size
array

getValue ( )
Get an array of pre-selected values
bool

isMultiple ( )
Are multiple selections allowed?
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 XoopsFormSelect (line 86)

void

XoopsFormSelect( string $caption, string $name, [mixed $value = null], [int $size = 1], [bool $multiple = false])

Constructor
Function Parameters:
- string $caption: Caption
- string $name: "name" attribute
- mixed $value: Pre-selected value (or array of them).
- int $size: Number or rows. "1" makes a drop-down-list
- bool $multiple: Allow multiple selections?
Function Info:

[ Top ]

addOption (line 135)

void

addOption( string $value, string $name)

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

[ Top ]

addOptionArray (line 148)

void

addOptionArray( array $options)

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

[ Top ]

getOptions (line 161)

array

getOptions( )

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

[ Top ]

getSize (line 116)

int

getSize( )

Get the size
Function Info:

[ Top ]

getValue (line 125)

array

getValue( )

Get an array of pre-selected values
Function Info:

[ Top ]

isMultiple (line 107)

bool

isMultiple( )

Are multiple selections allowed?
Function Info:

[ Top ]

render (line 170)

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:29 +0100 by phpDocumentor 1.2.0rc1
proudly hosted at
SourceForge.net Logo