XoopsFormCheckBox Class Reference

Inheritance diagram for XoopsFormCheckBox:

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

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

Detailed Description

Definition at line 25 of file formcheckbox.php.

Member Function Documentation

XoopsFormCheckBox::addOption	(		$value,
			$name = ''
	)

Add an option

Parameters

string	$value
string	$name

Definition at line 118 of file formcheckbox.php.

XoopsFormCheckBox::addOptionArray

(

$options

)

Add multiple Options at once

Parameters

array

$options

Associative array of value->name pairs

Definition at line 132 of file formcheckbox.php.

References $options.

XoopsFormCheckBox::getDelimeter

(

$encode = false

)

Get the delimiter of this group

Parameters

bool

$encode

To sanitizer the text?

Returns

string The delimiter

Definition at line 165 of file formcheckbox.php.

XoopsFormCheckBox::getOptions

(

$encode = false

)

Get an array with all the options

Parameters

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

Definition at line 147 of file formcheckbox.php.

XoopsFormCheckBox::getValue

(

$encode = false

)

Get the "value"

Parameters

bool

$encode

To sanitizer the text?

Returns

array

Definition at line 83 of file formcheckbox.php.

XoopsFormCheckBox::render

(

)

prepare HTML for output

Returns

string

Definition at line 175 of file formcheckbox.php.

References $i, and $ret.

XoopsFormCheckBox::renderValidationJS

(

)

Render custom javascript validation code

XoopsForm::renderValidationJS

Definition at line 230 of file formcheckbox.php.

References _FORM_ENTER.

XoopsFormCheckBox::setValue

(

$value

)

Set the "value"

Parameters

array

$

Definition at line 100 of file formcheckbox.php.

XoopsFormCheckBox::XoopsFormCheckBox	(		$caption,
			$name,
			$value = null,
			$delimeter = ' '
	)

Constructor

Parameters

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

Definition at line 66 of file formcheckbox.php.

Member Data Documentation

XoopsFormCheckBox::$_delimeter

Definition at line 49 of file formcheckbox.php.

XoopsFormCheckBox::$_options = array()

Definition at line 33 of file formcheckbox.php.

XoopsFormCheckBox::$_value = array()

Definition at line 41 of file formcheckbox.php.

XoopsFormCheckBox::$columns

Definition at line 57 of file formcheckbox.php.

---

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

• L:/0xoops/xoops-2.5.6/htdocs/class/xoopsform/formcheckbox.php