Class XoopsFormCheckBox

XoopsFormCheckBox

Direct known subclasses

Package: kernel
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: Skalpa Keo skalpa@xoops.org
Author: Taiwen Jiang phppp@users.sourceforge.net
Located at lass/xoopsform/formcheckbox.php

Methods summary
`public`	# `__construct( string $caption, string $name, mixed $value = null, string $delimeter = ' ' )` Constructor Constructor Parameters `$caption` `$name` `$value` Either one value as a string or an array of them. `$delimeter` Overrides `XoopsFormElement::__construct()`
`public array`	# `getValue( boolean $encode = false )` Get the "value" Get the "value" Parameters `$encode` To sanitizer the text? Returns array
`public`	# `setValue( array $value )` Set the "value" Set the "value" Parameters `$value`
`public`	# `addOption( string $value, string $name = '' )` Add an option Add an option Parameters `$value` `$name`
`public`	# `addOptionArray( array $options )` Add multiple Options at once Add multiple Options at once 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 Overrides `XoopsFormElement::render()`
`public`	# `renderValidationJS( )` Render custom javascript validation code Render custom javascript validation code Seealso XoopsForm::renderValidationJS Overrides `XoopsFormElement::renderValidationJS()`

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

Properties summary
`public array`	`$_options` Availlable options Availlable options	# `array()`
`public array`	`$_value` pre-selected values in array pre-selected values in array	# `array()`
`public string`	`$_delimeter` HTML to seperate the elements HTML to seperate the elements	#
`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	#

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

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsFormCheckBox

Direct known subclasses

Parameters

Overrides

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Returns

Overrides

Seealso

Overrides