Class icms_form_elements_Select

A select field

icms_form_elements_Select

Direct known subclasses

icms_form_elements_select_Country, icms_form_elements_select_Group, icms_ipf_form_elements_User, icms_form_elements_select_Image, icms_form_elements_select_Lang, icms_form_elements_select_Matchoption, icms_form_elements_select_Theme, icms_form_elements_select_Timezone, icms_ipf_form_elements_Parentcategory, icms_ipf_form_elements_Select, icms_ipf_form_elements_Time

Indirect known subclasses

icms_ipf_form_elements_Language, icms_ipf_form_elements_Selectmulti

Package: Form\Elements
Category: ICMS
Copyright: copyright (c) 2000-2003 XOOPS.org
License: GNU General Public License (GPL)
Author: Kazumi Ono onokazu@xoops.org
Located at form/elements/Select.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 `icms_form_Element::__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( 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

Methods inherited from icms_form_Element
`getAccessKey(), getAccessString(), getCaption(), getClass(), getDescription(), getExtra(), getName(), isContainer(), isHidden(), isRequired(), renderValidationJS(), setAccessKey(), setCaption(), setClass(), setDescription(), setExtra(), setHidden(), setName(), setRequired()`

Properties inherited from icms_form_Element
`$_caption, $_name, $customValidationCode`

Packages

Classes

Class icms_form_elements_Select

Direct known subclasses

Indirect known subclasses

Parameters

Overrides

Returns

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Returns