API - XOOPS 2.5.11 Beta 2
By monxoops.fr
XoopsFormRadio Class Reference
Inheritance diagram for XoopsFormRadio:
Collaboration diagram for XoopsFormRadio:

Public Member Functions

 __construct ($caption, $name, $value=null, $delimeter=' ')
 
 getValue ($encode=false)
 
 setValue ($value)
 
 addOption ($value, $name='')
 
 addOptionArray ($options)
 
 getOptions ($encode=false)
 
 getDelimeter ($encode=false)
 
 render ()
 
- Public Member Functions inherited from XoopsFormElement
 __construct ()
 
 isContainer ()
 
 setName ($name)
 
 getName ($encode=true)
 
 setAccessKey ($key)
 
 getAccessKey ()
 
 getAccessString ($str)
 
 setClass ($class)
 
 getClass ()
 
 setCaption ($caption)
 
 getCaption ($encode=false)
 
 getTitle ($encode=true)
 
 setDescription ($description)
 
 getDescription ($encode=false)
 
 setHidden ()
 
 isHidden ()
 
 isRequired ()
 
 setExtra ($extra, $replace=false)
 
 getExtra ($encode=false)
 
 setNocolspan ($nocolspan=true)
 
 getNocolspan ()
 
 getFormType ()
 
 setFormType ($value='')
 
 renderValidationJS ()
 
 render ()
 

Data Fields

 $_options = array()
 
 $_value
 
 $columns
 
 $_delimeter
 
- Data Fields inherited from XoopsFormElement
 $customValidationCode = array()
 
 $_name
 
 $_caption
 
 $_accesskey = ''
 
 $_class = array()
 
 $_hidden = false
 
 $_extra = array()
 
 $_required = false
 
 $_description = ''
 
 $_nocolspan = false
 
 $_formtype = ''
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $caption,
  $name,
  $value = null,
  $delimeter = ' ' 
)

Constructor

Parameters
string$captionCaption
string$name"name" attribute
string$valuePre-selected value
string$delimeter
Here is the call graph for this function:

Member Function Documentation

◆ addOption()

addOption (   $value,
  $name = '' 
)

Add an option

Parameters
string$value"value" attribute - This gets submitted as form-data.
string$name"name" attribute - This is displayed. If empty, we use the "value" instead.
Here is the caller graph for this function:

◆ addOptionArray()

addOptionArray (   $options)

Adds multiple options

Parameters
array$optionsAssociative array of value->name pairs.
Here is the call graph for this function:

◆ getDelimeter()

getDelimeter (   $encode = false)

Get the delimiter of this group

Parameters
bool$encodeTo sanitizer the text?
Returns
string The delimiter
Here is the caller graph for this function:

◆ getOptions()

getOptions (   $encode = false)

Get an array with all the options

Parameters
bool | int$encodeTo 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
Here is the caller graph for this function:

◆ getValue()

getValue (   $encode = false)

Get the "value" attribute

Parameters
bool$encodeTo sanitizer the text?
Returns
string
Here is the caller graph for this function:

◆ render()

render ( )

Prepare HTML for output

Returns
string HTML

Reimplemented from XoopsFormElement.

Here is the call graph for this function:

◆ setValue()

setValue (   $value)

Set the pre-selected value

Parameters
string$value
Here is the caller graph for this function:

Field Documentation

◆ $_delimeter

$_delimeter

◆ $_options

$_options = array()

◆ $_value

$_value

◆ $columns

$columns

The documentation for this class was generated from the following file: