XoopsGroupFormCheckBox Class Reference

Inheritance diagram for XoopsGroupFormCheckBox:

Collaboration diagram for XoopsGroupFormCheckBox:

Public Member Functions
	__construct ($caption, $name, $groupId, $values=null)
	setValue ($value)
	setOptionTree (&$optionTree)
	render ()
	_renderOptionTree (&$tree, $option, $prefix, $parentIds=array())
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
	$_value = array()
	$_groupId
	$_optionTree = array()
Data Fields inherited from XoopsFormElement
	$customValidationCode = array()
	$_name
	$_caption
	$_accesskey = ''
	$_class = array()
	$_hidden = false
	$_extra = array()
	$_required = false
	$_description = ''
	$_nocolspan = false
	$_formtype = ''

Detailed Description

Renders checkbox options for a group permission form

Constructor & Destructor Documentation

__construct()

__construct	(		$caption,
			$name,
			$groupId,
			$values = null
	)

Constructor

Parameters

	$caption
	$name
	$groupId
null	$values

Here is the call graph for this function:

Member Function Documentation

_renderOptionTree()

_renderOptionTree	(	&	$tree,
			$option,
			$prefix,
			$parentIds = array()
	)

Renders checkbox options for an item tree

Parameters

string	$tree
array	$option
string	$prefix
array	$parentIds	@access private

Here is the call graph for this function:

Here is the caller graph for this function:

render()

render

(

)

Renders checkbox options for this group

Returns

string @access public

Reimplemented from XoopsFormElement.

Here is the call graph for this function:

setOptionTree()

setOptionTree

(

&

$optionTree

)

Sets the tree structure of items

Parameters

array

$optionTree

@access public

setValue()

setValue

(

$value

)

Sets pre-selected values

Parameters

mixed

$value

A group ID or an array of group IDs @access public

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$_groupId

$_groupId

$_optionTree

$_optionTree = array()

$_value

$_value = array()

---

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

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