XoopsFormCheckBox Class Reference

Inheritance diagram for XoopsFormCheckBox:

Collaboration diagram for XoopsFormCheckBox:

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 ()
	renderValidationJS ()
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 = array()
	$_delimeter
	$columns
Data Fields inherited from XoopsFormElement
	$customValidationCode = array()
	$_name
	$_caption
	$_accesskey = ''
	$_class = array()
	$_hidden = false
	$_extra = array()
	$_required = false
	$_description = ''
	$_nocolspan = false
	$_formtype = ''

Detailed Description

Class XoopsFormCheckBox

Constructor & Destructor Documentation

__construct()

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

Constructor

Parameters

string	$caption
string	$name
mixed	$value	Either one value as a string or an array of them.
string	$delimeter

Here is the call graph for this function:

Member Function Documentation

addOption()

addOption	(		$value,
			$name = ''
	)

Add an option

Parameters

string	$value
string	$name

Here is the caller graph for this function:

addOptionArray()

addOptionArray

(

$options

)

Add multiple Options at once

Parameters

array

$options

Associative 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

$encode

To 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

$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

Here is the caller graph for this function:

getValue()

getValue

(

$encode = false

)

Get the "value"

Parameters

bool

$encode

To sanitizer the text?

Returns

array

Here is the caller graph for this function:

render()

render

(

)

prepare HTML for output

Returns

string

Reimplemented from XoopsFormElement.

Here is the call graph for this function:

renderValidationJS()

renderValidationJS

(

)

Render custom javascript validation code

@seealso XoopsForm::renderValidationJS

Reimplemented from XoopsFormElement.

Here is the call graph for this function:

setValue()

setValue

(

$value

)

Set the "value"

Parameters

array

$value

Here is the caller graph for this function:

Field Documentation

$_delimeter

$_delimeter

$_options

$_options = array()

$_value

$_value = array()

$columns

$columns

---

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

• C:/xoops2511b2/htdocs/class/xoopsform/formcheckbox.php