Overview

Namespaces

  • None
  • Xmf
    • Database
    • Module
      • Helper
    • Template
  • Xoops
    • Auth
    • Core
      • Cache
      • Database
        • Logging
        • Schema
      • Exception
      • Handler
        • Scheme
      • Kernel
        • Dtype
        • Handlers
        • Model
      • Lists
      • Locale
        • Punic
      • Service
        • Contract
      • Session
      • Text
        • Sanitizer
          • Extensions
      • Theme
        • Plugins
    • Form
    • Html
    • Locale
    • Module
      • Helper
      • Plugin

Classes

  • BlockForm
  • Button
  • ButtonTray
  • Captcha
  • Checkbox
  • ColorPicker
  • DateSelect
  • DateTime
  • DhtmlTextArea
  • Editor
  • Element
  • ElementFactory
  • ElementTray
  • File
  • Form
  • GroupCheckbox
  • GroupFormCheckbox
  • GroupPermissionForm
  • Hidden
  • Label
  • Mail
  • OptionElement
  • Password
  • Radio
  • RadioYesNo
  • Raw
  • Select
  • SelectCountry
  • SelectEditor
  • SelectGroup
  • SelectLanguage
  • SelectLocale
  • SelectMatchOption
  • SelectTheme
  • SelectTimeZone
  • SelectUser
  • SimpleForm
  • Tab
  • TableForm
  • TabTray
  • Text
  • TextArea
  • ThemeForm
  • Token
  • Url

Interfaces

  • ContainerInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class Select

Select - a select element

ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable
Extended by Xoops\Html\Attributes implements Xoops\Core\AttributeInterface
Extended by Xoops\Form\Element
Extended by Xoops\Form\OptionElement
Extended by Xoops\Form\Select

Direct known subclasses

Xoops\Form\SelectCountry, Xoops\Form\SelectGroup, Xoops\Form\SelectLanguage, Xoops\Form\SelectLocale, Xoops\Form\SelectMatchOption, Xoops\Form\SelectTheme, Xoops\Form\SelectTimeZone, XoopsFormSelect

Indirect known subclasses

XoopsFormSelectCountry, XoopsFormSelectGroup, XoopsFormSelectLang, XoopsFormSelectMatchOption, XoopsFormSelectTheme, XoopsFormSelectTimezone
Namespace: Xoops\Form
Package: Xoops\Form
Category: Xoops\Form\Select
Copyright: 2001-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Author: Taiwen Jiang phppp@users.sourceforge.net
Link: http://xoops.org
Located at oops_lib/Xoops/Form/Select.php
Methods summary
public
# __construct( string|array $caption, string $name = null, mixed $value = null, integer $size = 1, boolean $multiple = false )

Constructor

Constructor

Parameters

$caption
Caption or array of all attributes
$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

Xoops\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
# addOptionGroup( string $name, array $optgroup )

Add multiple optgroup

Add multiple optgroup

Parameters

$name
name attribute
$optgroup
Associative array of value->name pairs
protected string
# renderOption( string $optionValue, string $optionDisplay, string[] $selected )

render a single option

render a single option

Parameters

$optionValue
option element value
$optionDisplay
displayed text
$selected
selected option values

Returns

string
public string
# render( )

Prepare HTML for output

Prepare HTML for output

Returns

string
HTML
public string
# renderValidationJS( )

Render custom javascript validation code

Render custom javascript validation code

Returns

string

Overrides

Xoops\Form\Element::renderValidationJS()
Methods inherited from Xoops\Form\OptionElement
addOption(), addOptionArray(), getOptions()
Methods inherited from Xoops\Form\Element
addCustomValidationCode(), getAccessKey(), getAccessString(), getCaption(), getClass(), getDescription(), getExtra(), getName(), getPattern(), getPatternDescription(), getTitle(), getValue(), hasClassLike(), isDatalist(), isHidden(), isRequired(), renderAttributeString(), renderDatalist(), setAccessKey(), setCaption(), setClass(), setDatalist(), setDescription(), setExtra(), setHidden(), setIfNotEmpty(), setIfNotSet(), setName(), setPattern(), setRequired(), setTitle(), setValue(), setWithDefaults(), themeDecorateElement()
Methods inherited from Xoops\Html\Attributes
add(), clear(), doRender(), get(), getAll(), getAllLike(), getNames(), has(), remove(), set(), setAll(), setArrayItem(), setMerge(), suppressRender()
Methods inherited from ArrayObject
append(), asort(), count(), exchangeArray(), getArrayCopy(), getFlags(), getIterator(), getIteratorClass(), ksort(), natcasesort(), natsort(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), serialize(), setFlags(), setIteratorClass(), uasort(), uksort(), unserialize()
Constants inherited from ArrayObject
ARRAY_AS_PROPS, STD_PROP_LIST
Properties summary
protected array $value

Pre-selected values

Pre-selected values

# array()
Properties inherited from Xoops\Form\Element
$customValidationCode, $extra, $suppressList
Properties inherited from Xoops\Html\Attributes
$suppressRenderAttributes
API documentation generated by ApiGen