kernel
[ class tree: kernel ] [ index: kernel ] [ all elements ]

Class: XoopsFormSelect

Source Location: /class/xoopsform/formselect.php

Class Overview

XoopsFormElement
   |
   --XoopsFormSelect

A select field


Author(s):

Copyright:

  • copyright (c) 2000-2003 XOOPS.org

Methods


Child classes:

CDMFormSelect
Extends XoopsFormSelect to provide CDM functionality
CDMFormSelectAll
Extends XoopsFormSelect to provide CDM functionality
CDMFormTreeSelect
Extends XoopsFormSelect to provide CDM functionality
CDMFormSelectSetLangs
Create a selection list of available languages for a code set
CDMFormSelectRstat
Create a Row Status selection list
CDMFormSelectFldType
Create a field type selection list
CDMFormSelectSetAll
Create a Code Set selector
CDMFormSelectSet
Create a Code Set selector
XoopsFormSelectTimezone
A select box with timezones
XoopsFormSelectTheme
A select box with available themes
XoopsFormSelectCountry
A select field with countries
XoopsFormSelectLang
A select field with available languages
XoopsFormSelectGroup
A select field with a choice of available groups
XoopsFormSelectUser
A select field with a choice of available users
XoopsFormSelectMatchOption
A selection box with options for matching search terms.

Inherited Methods

Class: XoopsFormElement

XoopsFormElement::XoopsFormElement()
constructor
XoopsFormElement::getAccessKey()
get the "accesskey" attribute for the element
XoopsFormElement::getAccessString()
If the accesskey is found in the specified string, underlines it
XoopsFormElement::getCaption()
get the caption for the element
XoopsFormElement::getClass()
get the "class" attribute 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::isContainer()
Is this element a container of other elements?
XoopsFormElement::isHidden()
Find out if an element is "hidden".
XoopsFormElement::render()
Generates output for the element.
XoopsFormElement::setAccessKey()
set the "accesskey" attribute for the element
XoopsFormElement::setCaption()
set the caption for the element
XoopsFormElement::setClass()
set the "class" attribute 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

Class Details

[line 48]
A select field



Tags:

copyright:  copyright (c) 2000-2003 XOOPS.org
author:  Kazumi Ono <onokazu@xoops.org>


[ Top ]


Class Methods


constructor XoopsFormSelect [line 87]

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

Constructor



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?

[ Top ]

method addOption [line 145]

void addOption( string $value, [string $name = ""])

Add an option



Parameters:

string   $value   "value" attribute
string   $name   "name" attribute

[ Top ]

method addOptionArray [line 158]

void addOptionArray( array $options)

Add multiple options



Parameters:

array   $options   Associative array of value->name pairs

[ Top ]

method getOptions [line 171]

array getOptions( )

Get all options



Tags:

return:  Associative array of value->name pairs


[ Top ]

method getSize [line 111]

int getSize( )

Get the size



[ Top ]

method getValue [line 120]

array getValue( )

Get an array of pre-selected values



[ Top ]

method isMultiple [line 102]

bool isMultiple( )

Are multiple selections allowed?



[ Top ]

method render [line 180]

string render( )

Prepare HTML for output



Tags:

return:  HTML


Overrides XoopsFormElement::render() (Generates output for the element.)

[ Top ]

method setValue [line 129]

void setValue( $value $value)

Set pre-selected values



Parameters:

$value   $value   mixed

[ Top ]


Documentation generated on Fri, 03 Mar 2006 08:56:01 +0000 by phpDocumentor 1.3.0RC3