icms_form_elements_Groupperm

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_form_elements_Groupperm

Renders checkbox options for a group permission form

• Class name: icms_form_elements_Groupperm
• Namespace:
• Parent class: icms_form_Element

Properties

$_value

public mixed $_value = array()

Pre-selected value(s)

• Visibility: public

$_groupId

public int $_groupId

Group ID

• Visibility: public

$_optionTree

public array $_optionTree

Option tree

• Visibility: public

Methods

__construct

mixed icms_form_elements_Groupperm::__construct(mixed caption, mixed name, mixed groupId, mixed values)

Constructor

• Visibility: public

Arguments

• caption mixed
• name mixed
• groupId mixed
• values mixed

setValue

mixed icms_form_elements_Groupperm::setValue(mixed value)

Sets pre-selected values

• Visibility: public

Arguments

• value mixed - <p>A group ID or an array of group IDs</p>

setOptionTree

mixed icms_form_elements_Groupperm::setOptionTree(array optionTree)

Sets the tree structure of items

• Visibility: public

Arguments

• optionTree array

render

string icms_form_elements_Groupperm::render()

Renders checkbox options for this group

• Visibility: public

_renderOptionTree

mixed icms_form_elements_Groupperm::_renderOptionTree(string tree, array option, string prefix, array parentIds)

Renders checkbox options for an item tree

• Visibility: public

Arguments

• tree string
• option array
• prefix string
• parentIds array