Xoops\Form\GroupFormCheckbox Class Reference

Inheritance diagram for Xoops\Form\GroupFormCheckbox:

Public Member Functions
	__construct ($caption, $name, $groupId, $values=null)
	render ()
	setOptionTree (&$optionTree)
Public Member Functions inherited from Xoops\Form\Element
	getAccessKey ()
	getAccessString ($str)
	getCaption ()
	getClass ()
	getDatalist ()
	getDescription ($encode=false)
	getExtra ($encode=false)
	getMaxcols ()
	getName ()
	getPattern ()
	getPatternDescription ()
	getTitle ()
	getValue ($encode=false)
	isDatalist ()
	isHidden ()
	isRequired ()
	render ()
	renderAttributeString ()
	renderValidationJS ()
	setAccessKey ($key)
	setCaption ($caption)
	setClass ($class)
	setDatalist ($datalist)
	setDescription ($description)
	setExtra ($extra, $replace=false)
	setHidden ()
	setName ($name)
	setPattern ($pattern, $pattern_description= '')
	setRequired ($bool=true)
	setTitle ($title)
	setValue ($value)
Public Member Functions inherited from Xoops\Html\Attributes
	addAttribute ($name, $value)
	getAttribute ($name)
	hasAttribute ($name)
	renderAttributeString ()
	setAttribute ($name, $value=null)
	setAttributes ($values)
	unsetAttribute ($name)

Protected Attributes
	$value = array()
Protected Attributes inherited from Xoops\Form\Element
	$value = ''
Protected Attributes inherited from Xoops\Html\Attributes
	$attributes = array()

Private Member Functions
	renderOptionTree (&$tree, $option, $prefix, $parentIds=array())

Private Attributes
	$groupId
	$optionTree = array()

Additional Inherited Members
Public Attributes inherited from Xoops\Form\Element
	$customValidationCode = array()

Detailed Description

Definition at line 25 of file GroupFormCheckbox.php.

Constructor & Destructor Documentation

Xoops\Form\GroupFormCheckbox::__construct	(		$caption,
			$name,
			$groupId,
			$values = null
	)

__construct

Parameters

string	$caption	caption
string	$name	element name
integer	$groupId	group id
mixed	$values	values

Definition at line 56 of file GroupFormCheckbox.php.

References Xoops\Form\Element\$caption, Xoops\Form\GroupFormCheckbox\$groupId, $name, Xoops\Form\Element\setCaption(), Xoops\Form\Element\setName(), and Xoops\Form\Element\setValue().

Here is the call graph for this function:

Member Function Documentation

Xoops\Form\GroupFormCheckbox::render

(

)

Renders checkbox options for this group

Returns

string

Definition at line 83 of file GroupFormCheckbox.php.

References $id, XoopsLocaleEn_US\ALL, Xoops\Form\Element\getName(), and Xoops\Form\GroupFormCheckbox\renderOptionTree().

Here is the call graph for this function:

Xoops\Form\GroupFormCheckbox::renderOptionTree ( &  $tree,   $option,   $prefix,   $parentIds = array()  )

private

Renders checkbox options for an item tree

Parameters

string	$tree	tree
array	$option	option
string	$prefix	prefix
array	$parentIds	parent ids

Definition at line 122 of file GroupFormCheckbox.php.

References Xoops\$option, $pid, and Xoops\Form\Element\getName().

Referenced by Xoops\Form\GroupFormCheckbox\render().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Form\GroupFormCheckbox::setOptionTree

(

&

$optionTree

)

Sets the tree structure of items

Parameters

array

$optionTree

options

Returns

void

Definition at line 73 of file GroupFormCheckbox.php.

References Xoops\Form\GroupFormCheckbox\$optionTree.

Member Data Documentation

Xoops\Form\GroupFormCheckbox::$groupId

private

Definition at line 39 of file GroupFormCheckbox.php.

Referenced by Xoops\Form\GroupFormCheckbox\__construct().

Xoops\Form\GroupFormCheckbox::$optionTree = array()

private

Definition at line 46 of file GroupFormCheckbox.php.

Referenced by Xoops\Form\GroupFormCheckbox\setOptionTree().

Xoops\Form\GroupFormCheckbox::$value = array()

protected

Definition at line 32 of file GroupFormCheckbox.php.

---

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

• C:/usr64/htdocs/xoops_lib/Xoops/Form/GroupFormCheckbox.php