XoopsFormElementTray Class Reference

Inheritance diagram for XoopsFormElementTray:

Public Member Functions
	addElement (&$formElement, $required=false)
	getDelimeter ($encode=false)
&	getElements ($recurse=false)
&	getRequired ()
	isContainer ()
	isRequired ()
	render ()
	XoopsFormElementTray ($caption, $delimeter=" ", $name="")
Public Member Functions inherited from XoopsFormElement
	getAccessKey ()
	getAccessString ($str)
	getCaption ($encode=false)
	getClass ()
	getDescription ($encode=false)
	getExtra ($encode=false)
	getFormType ()
	getName ($encode=true)
	getNocolspan ()
	getTitle ($encode=true)
	isContainer ()
	isHidden ()
	isRequired ()
	render ()
	renderValidationJS ()
	setAccessKey ($key)
	setCaption ($caption)
	setClass ($class)
	setDescription ($description)
	setExtra ($extra, $replace=false)
	setFormType ($value= '')
	setHidden ()
	setName ($name)
	setNocolspan ($nocolspan=true)
	XoopsFormElement ()

Public Attributes
	$_delimeter
	$_elements = array()
	$_required = array()
Public Attributes inherited from XoopsFormElement
	$_accesskey = ''
	$_caption
	$_class = array()
	$_description = ''
	$_extra = array()
	$_formtype = ''
	$_hidden = false
	$_name
	$_nocolspan = false
	$_required = false
	$customValidationCode = array()

Detailed Description

A group of form elements

Definition at line 26 of file formelementtray.php.

Member Function Documentation

XoopsFormElementTray::addElement	(	&	$formElement,
			$required = false
	)

Add an element to the group

Parameters

object

$ &$element XoopsFormElement to add

Definition at line 85 of file formelementtray.php.

References $i.

XoopsFormElementTray::getDelimeter

(

$encode = false

)

Get the delimiter of this group

Parameters

bool

$encode

To sanitizer the text?

Returns

string The delimiter

Definition at line 144 of file formelementtray.php.

& XoopsFormElementTray::getElements

(

$recurse = false

)

Get an array of the elements in this group

Parameters

bool

$recurse

get elements recursively?

Returns

array Array of XoopsFormElement objects.

Definition at line 116 of file formelementtray.php.

References $i, $j, and $ret.

& XoopsFormElementTray::getRequired

(

)

get an array of "required" form elements

Returns

array array of XoopsFormElements

Definition at line 106 of file formelementtray.php.

XoopsFormElementTray::isContainer

(

)

Is this element a container of other elements?

Returns

bool true

Definition at line 67 of file formelementtray.php.

XoopsFormElementTray::isRequired

(

)

Find out if there are required elements.

Returns

bool

Definition at line 76 of file formelementtray.php.

XoopsFormElementTray::render

(

)

prepare HTML to output this group

Returns

string HTML output

Definition at line 153 of file formelementtray.php.

References $ret.

XoopsFormElementTray::XoopsFormElementTray	(		$caption,
			$delimeter = " ",
			$name = ""
	)

constructor

Parameters

string	$caption	Caption for the group.
string	$delimiter	HTML to separate the elements

Definition at line 56 of file formelementtray.php.

Member Data Documentation

XoopsFormElementTray::$_delimeter

Definition at line 48 of file formelementtray.php.

XoopsFormElementTray::$_elements = array()

Definition at line 33 of file formelementtray.php.

XoopsFormElementTray::$_required = array()

Definition at line 40 of file formelementtray.php.

---

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

• L:/0xoops/xoops-2.5.6/htdocs/class/xoopsform/formelementtray.php