Class: XoopsGroupFormCheckBox

Source Location: /class/xoopsform/grouppermform.php

Class XoopsGroupFormCheckBox

Class Overview

Renders checkbox options for a group permission form

Located in /class/xoopsform/grouppermform.php [line 188]

XoopsFormElement
   |
   --XoopsGroupFormCheckBox
Author(s): Information Tags:
Copyright:  copyright (c) 2000-2003 XOOPS.org

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From XoopsFormElement

XoopsFormElement::$customValidationCode

Inherited From XoopsFormElement

XoopsFormElement::XoopsFormElement()
constructor
XoopsFormElement::getAccessKey()
get the "accesskey" attribute for the element
XoopsFormElement::getAccessString()
If the accesskey is found in the specified string, underlines it
XoopsFormElement::getCaption()
get the caption for the element
XoopsFormElement::getClass()
get the "class" attribute for the element
XoopsFormElement::getDescription()
get the element's description
XoopsFormElement::getExtra()
Get the extra attributes for the element
XoopsFormElement::getName()
get the "name" attribute for the element
XoopsFormElement::isContainer()
Is this element a container of other elements?
XoopsFormElement::isHidden()
Find out if an element is "hidden".
XoopsFormElement::isRequired()
Find out if an element is required.
XoopsFormElement::render()
Generates output for the element.
XoopsFormElement::renderValidationJS()
Render custom javascript validation code
XoopsFormElement::setAccessKey()
set the "accesskey" attribute for the element
XoopsFormElement::setCaption()
set the caption for the element
XoopsFormElement::setClass()
set the "class" attribute for the element
XoopsFormElement::setDescription()
set the element's description
XoopsFormElement::setExtra()
Add extra attributes to the element.
XoopsFormElement::setHidden()
flag the element as "hidden"
XoopsFormElement::setName()
set the "name" attribute for the element

[ Top ]
Property Summary
int   $_groupId   Group ID
array   $_optionTree   Option tree
array;   $_value   Pre-selected value(s)

[ Top ]
Method Summary
XoopsGroupFormCheckBox   XoopsGroupFormCheckBox()   Constructor
string   render()   Renders checkbox options for this group
void   setOptionTree()   Sets the tree structure of items
void   setValue()   Sets pre-selected values

[ Top ]
Properties
int   $_groupId [line 201]

Group ID


[ Top ]
array   $_optionTree [line 207]

Option tree


[ Top ]
array;   $_value = array() [line 195]

Pre-selected value(s)


[ Top ]
Methods
Constructor XoopsGroupFormCheckBox  [line 212]

  XoopsGroupFormCheckBox XoopsGroupFormCheckBox( $caption, $name, $groupId, [ $values = null]  )

Constructor

Parameters:
   $caption: 
   $name: 
   $groupId: 
   $values: 


[ Top ]
render  [line 256]

  string render( )

Renders checkbox options for this group


API Tags:
Access:  public


Redefinition of:
XoopsFormElement::render()
Generates output for the element.

[ Top ]
setOptionTree  [line 245]

  void setOptionTree( &$optionTree, array $optionTree  )

Sets the tree structure of items

Parameters:
array   $optionTree: 
   &$optionTree: 

API Tags:
Access:  public


[ Top ]
setValue  [line 228]

  void setValue( mixed $value  )

Sets pre-selected values

Parameters:
mixed   $value:  A group ID or an array of group IDs

API Tags:
Access:  public


[ Top ]

Documentation generated on Sat, 12 Dec 2009 21:20:08 -0600 by phpDocumentor 1.4.1