XoopsFormElementTray Class Reference

Inheritance diagram for XoopsFormElementTray:

Public Member Functions
	__construct ($caption, $delimeter=' ', $name='')
	XoopsFormElementTray ($caption, $delimeter=' ', $name='')
	isContainer ()
	addElement (&$formElement, $required=false)
&	getRequired ()
&	getElements ($recurse=false)
	getDelimeter ()
	render ()
Public Member Functions inherited from XoopsFormElement
	__construct ()
	XoopsFormElement ()
	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
	$_elements = []
	$_required = []
	$_delimeter
Data Fields inherited from XoopsFormElement
	$_name
	$_caption
	$_accesskey = ''
	$_class = ''
	$_hidden = false
	$_extra = ''
	$_required = false
	$_description = ''
	$_id = null

Detailed Description

Definition at line 18 of file formelementtray.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$caption,
			$delimeter = ' ',
			$name = '' )

constructor

Parameters

string	$caption	Caption for the group.
string	$delimeter
string	$name

Definition at line 48 of file formelementtray.php.

Member Function Documentation

addElement()

addElement	(	&	$formElement,
			$required = false )

Add an element to the group

Parameters

	$formElement
bool	$required

Definition at line 75 of file formelementtray.php.

getDelimeter()

getDelimeter

(

)

Get the delimiter of this group

Returns

string The delimiter

Definition at line 132 of file formelementtray.php.

getElements()

& 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 106 of file formelementtray.php.

getRequired()

& getRequired

(

)

get an array of "required" form elements

Returns

array array of XoopsFormElements

Definition at line 95 of file formelementtray.php.

isContainer()

isContainer

(

)

Is this element a container of other elements?

Returns

bool true

Reimplemented from XoopsFormElement.

Definition at line 64 of file formelementtray.php.

render()

render

(

)

prepare HTML to output this group

Returns

string HTML output

Reimplemented from XoopsFormElement.

Definition at line 142 of file formelementtray.php.

XoopsFormElementTray()

XoopsFormElementTray	(		$caption,
			$delimeter = ' ',
			$name = '' )

Definition at line 54 of file formelementtray.php.

Field Documentation

$_delimeter

$_delimeter

Definition at line 39 of file formelementtray.php.

$_elements

$_elements = []

Definition at line 26 of file formelementtray.php.

$_required

$_required = []

Definition at line 32 of file formelementtray.php.

---

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

• html/class/xoopsform/formelementtray.php