Class XoopsFormRadio

XOOPS form radio compo

You may not change or alter any portion of this comment or credits of supporting developers from this source code or any supporting source code which is considered copyrighted (c) material of the original comment or credit authors. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

XoopsFormElement

XoopsFormRadio

Direct known subclasses

XoopsFormRadioYN

Package: kernel\form
Copyright: (c) 2000-2017 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/
Author: Taiwen Jiang phppp@users.sourceforge.net
Since: 2.0
Located at lass/xoopsform/formradio.php

Methods summary
`public`	# `__construct( string $caption, string $name, string $value = null, string $delimeter = ' ' )` Constructor Constructor Parameters `$caption` Caption `$name` "name" attribute `$value` Pre-selected value `$delimeter` Overrides `XoopsFormElement::__construct()`
`public string`	# `getValue( boolean $encode = false )` Get the "value" attribute Get the "value" attribute Parameters `$encode` To sanitizer the text? Returns string
`public`	# `setValue( $value )` Set the pre-selected value Set the pre-selected value Parameters `$value` string
`public`	# `addOption( string $value, string $name = '' )` Add an option Add an option Parameters `$value` "value" attribute - This gets submitted as form-data. `$name` "name" attribute - This is displayed. If empty, we use the "value" instead.
`public`	# `addOptionArray( array $options )` Adds multiple options Adds 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 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`	# `getDelimeter( boolean $encode = false )` Get the delimiter of this group Get the delimiter of this group Parameters `$encode` To sanitizer the text? Returns string The delimiter
`public string`	# `render( )` Prepare HTML for output Prepare HTML for output Returns string HTML Overrides `XoopsFormElement::render()`

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

Properties summary
`public array`	`$_options` Array of Options Array of Options	# `array()`
`public string`	`$_value` Pre-selected value Pre-selected value	#
`public integer`	`$columns` Columns per line for rendering Leave unset (null) to put all options in one line Set to 1 to put each option on its own line Any other positive integer 'n' to put 'n' options on each line Columns per line for rendering Leave unset (null) to put all options in one line Set to 1 to put each option on its own line Any other positive integer 'n' to put 'n' options on each line	#
`public string`	`$_delimeter` HTML to seperate the elements HTML to seperate the elements	#

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

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsFormRadio

Direct known subclasses

Parameters

Overrides

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Returns

Overrides