Class XoopsFormSelect

A select field

XoopsFormSelect

Direct known subclasses

XoopsFormSelectCountry, XoopsFormSelectGroup, XoopsFormSelectLang, XoopsFormSelectMatchOption, XoopsFormSelectTheme, XoopsFormSelectTimezone

Package: kernel\form
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Author: Taiwen Jiang phppp@users.sourceforge.net
Author: John Neill catzwolf@xoops.org
Located at lass/xoopsform/formselect.php

Methods summary
`public`	# `__construct( string $caption, string $name, mixed $value = null, integer $size = 1, boolean $multiple = false )` Constructor Constructor Parameters `$caption` Caption `$name` "name" attribute `$value` Pre-selected value (or array of them). `$size` Number or rows. "1" makes a drop-down-list `$multiple` Allow multiple selections? Overrides `XoopsFormElement::__construct()`
`public boolean`	# `isMultiple( )` Are multiple selections allowed? Are multiple selections allowed? Returns boolean
`public integer`	# `getSize( )` Get the size Get the size Returns integer
`public array`	# `getValue( boolean $encode = false )` Get an array of pre-selected values Get an array of pre-selected values Parameters `$encode` To sanitizer the text? Returns array
`public`	# `setValue( $value )` Set pre-selected values Set pre-selected values Parameters `$value` mixed
`public`	# `addOption( string $value, string $name = '' )` Add an option Add an option Parameters `$value` "value" attribute `$name` "name" attribute
`public`	# `addOptionArray( array $options )` Add multiple options Add multiple options Parameters `$options` Associative array of value->name pairs
`public array`	# `getOptions( boolean\|integer $encode = false )` Get an array with all the options Get an array with all the options Note: both name and value should be sanitized. However for backward compatibility, only value is sanitized for now. Parameters `$encode` To sanitizer the text? potential values: 0 - skip; 1 - only for value; 2 - for both value and name Returns array Associative array of value->name pairs
`public string`	# `render( )` Prepare HTML for output Prepare HTML for output Returns string HTML Overrides `XoopsFormElement::render()`
`public`	# `renderValidationJS( )` Render custom javascript validation code Render custom javascript validation code Seealso XoopsForm::renderValidationJS Overrides `XoopsFormElement::renderValidationJS()`

Methods inherited from XoopsFormElement
`getAccessKey(), getAccessString(), getCaption(), getClass(), getDescription(), getExtra(), getFormType(), getName(), getNocolspan(), getTitle(), isContainer(), isHidden(), isRequired(), setAccessKey(), setCaption(), setClass(), setDescription(), setExtra(), setFormType(), setHidden(), setName(), setNocolspan()`

Properties summary
`public array`	`$_options` Options Options	# `array()`
`public boolean`	`$_multiple` Allow multiple selections? Allow multiple selections?	# `false`
`public integer`	`$_size` Number of rows. "1" makes a dropdown list. Number of rows. "1" makes a dropdown list.	#
`public array`	`$_value` Pre-selcted values Pre-selcted values	# `array()`

Properties inherited from XoopsFormElement
`$_accesskey, $_caption, $_class, $_description, $_extra, $_formtype, $_hidden, $_name, $_nocolspan, $_required, $customValidationCode`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsFormSelect

Direct known subclasses

Parameters

Overrides

Returns

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Returns

Overrides

Seealso

Overrides