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 OptionElement

OptionElement - Abstract base class for form elements with options (i.e. Select)

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

Direct known subclasses

Xoops\Form\Checkbox, Xoops\Form\Radio, Xoops\Form\Select

Indirect known subclasses

Xoops\Form\GroupCheckbox, Xoops\Form\RadioYesNo, XoopsFormRadio, XoopsFormRadioYN, XoopsFormSelect, XoopsFormSelectCheckGroup, XoopsFormSelectCountry, XoopsFormSelectGroup, XoopsFormSelectLang, XoopsFormSelectMatchOption, XoopsFormSelectTheme, XoopsFormSelectTimezone, Xoops\Form\SelectCountry, Xoops\Form\SelectGroup, Xoops\Form\SelectLanguage, Xoops\Form\SelectLocale, Xoops\Form\SelectMatchOption, Xoops\Form\SelectTheme, Xoops\Form\SelectTimeZone, XoopsFormCheckBox
Abstract
Namespace: Xoops\Form
Package: Xoops\Form
Category: Xoops\Form\OptionElement
Copyright: 2011-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: trabis lusopoemas@gmail.com
Author: Richard Griffith richard@geekwright.com
Link: http://xoops.org
Located at oops_lib/Xoops/Form/OptionElement.php
Methods summary
public
# addOption( string $value, string $name = null )

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 = 0 )

Get an array with all the options

Get an array with all the options

Parameters

$encode

encode special characters, potential values: 0 - skip 1 - only for value 2 - for both value and name

Returns

array
Associative array of value->name pairs
Methods inherited from Xoops\Form\Element
__construct(), addCustomValidationCode(), getAccessKey(), getAccessString(), getCaption(), getClass(), getDescription(), getExtra(), getName(), getPattern(), getPatternDescription(), getTitle(), getValue(), hasClassLike(), isDatalist(), isHidden(), isRequired(), render(), renderAttributeString(), renderDatalist(), renderValidationJS(), 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 inherited from Xoops\Form\Element
$customValidationCode, $extra, $suppressList
Properties inherited from Xoops\Html\Attributes
$suppressRenderAttributes
API documentation generated by ApiGen