XoopsGroupFormCheckBox Class Reference

Inheritance diagram for XoopsGroupFormCheckBox:

Public Member Functions
	__construct ($caption, $name, $groupId, $values=null)
	setValue ($value)
	setOptionTree (&$optionTree)
	render ()
	_renderOptionTree (&$tree, $option, $prefix, $parentIds=[])
	_hasChildren ()
Public Member Functions inherited from XoopsFormElement
	__construct ()
	XoopsFormElement ()
	isContainer ()
	setName ($name)
	getName ($encode=true)
	setId ($id)
	getId ()
	setAccessKey ($key)
	getAccessKey ()
	getAccessString ($str)
	setClass ($class)
	getClass ()
	setCaption ($caption)
	getCaption ()
	setDescription ($description)
	getDescription ()
	setHidden ()
	isHidden ()
	isBreak ()
	setExtra ($extra, $replace=false)
	getExtra ()
	getMessageForJS ()

Data Fields
	$_value = []
	$_groupId
	$_optionTree = []
Data Fields inherited from XoopsFormElement
	$_name
	$_caption
	$_accesskey = ''
	$_class = ''
	$_hidden = false
	$_extra = ''
	$_required = false
	$_description = ''
	$_id = null

Detailed Description

Renders checkbox options for a group permission form

Definition at line 155 of file grouppermform.php.

Constructor & Destructor Documentation

__construct()

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

Constructor

Parameters

	$caption
	$name
	$groupId
null	$values

Definition at line 183 of file grouppermform.php.

Member Function Documentation

_hasChildren()

_hasChildren

(

)

Gets a value indicating whether this object has children.

Returns

bool

Definition at line 320 of file grouppermform.php.

_renderOptionTree()

_renderOptionTree	(	&	$tree,
			$option,
			$prefix,
			$parentIds = [] )

Renders checkbox options for an item tree

Parameters

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

Definition at line 273 of file grouppermform.php.

render()

render

(

)

Renders checkbox options for this group

Returns

string @access public

Reimplemented from XoopsFormElement.

Definition at line 227 of file grouppermform.php.

setOptionTree()

setOptionTree

(

&

$optionTree

)

Sets the tree structure of items

Parameters

array

$optionTree

@access public

Definition at line 216 of file grouppermform.php.

setValue()

setValue

(

$value

)

Sets pre-selected values

Parameters

mixed

$value

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

Definition at line 199 of file grouppermform.php.

Field Documentation

$_groupId

$_groupId

Definition at line 168 of file grouppermform.php.

$_optionTree

$_optionTree = []

Definition at line 174 of file grouppermform.php.

$_value

$_value = []

Definition at line 162 of file grouppermform.php.

---

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

• html/class/xoopsform/grouppermform.php