Class Trees Index phpDocumentor Project Page

Class XoopsFormSelectGroup

(line 52)

XoopsFormElement
   |
   --XoopsFormSelect
      |
      --XoopsFormSelectGroup

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

A select field with a choice of available groups

Class Variable Summary

Inherited Class Variable Summary

Method Summary

void

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

Inherited Method Summary

Inherited From Class XoopsFormSelect

Function Description
XoopsFormSelect::XoopsFormSelect() Constructor
XoopsFormSelect::addOption() Add an option
XoopsFormSelect::addOptionArray() Add multiple options
XoopsFormSelect::getOptions() Get all options
XoopsFormSelect::getSize() Get the size
XoopsFormSelect::getValue() Get an array of pre-selected values
XoopsFormSelect::isMultiple() Are multiple selections allowed?
XoopsFormSelect::render() Prepare HTML for output

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 XoopsFormSelectGroup (line 64)

void

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

Constructor
Function Parameters:
- string $caption:
- string $name:
- bool $include_anon: Include group "anonymous"?
- 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 ]

Variable Detail

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