Xoops\Form\ElementTray Class Reference

Inheritance diagram for Xoops\Form\ElementTray:

Public Member Functions
	__construct ($caption, $delimiter=" ", $name="")
	addElement (Element $formElement, $required=false)
	getDelimiter ($encode=false)
	getElements ($recursively=false)
	getRequired ()
	isRequired ()
	render ()
Public Member Functions inherited from Xoops\Form\Element
	getAccessKey ()
	getAccessString ($str)
	getCaption ()
	getClass ()
	getDatalist ()
	getDescription ($encode=false)
	getExtra ($encode=false)
	getMaxcols ()
	getName ()
	getPattern ()
	getPatternDescription ()
	getTitle ()
	getValue ($encode=false)
	isDatalist ()
	isHidden ()
	isRequired ()
	render ()
	renderAttributeString ()
	renderValidationJS ()
	setAccessKey ($key)
	setCaption ($caption)
	setClass ($class)
	setDatalist ($datalist)
	setDescription ($description)
	setExtra ($extra, $replace=false)
	setHidden ()
	setName ($name)
	setPattern ($pattern, $pattern_description= '')
	setRequired ($bool=true)
	setTitle ($title)
	setValue ($value)
Public Member Functions inherited from Xoops\Html\Attributes
	addAttribute ($name, $value)
	getAttribute ($name)
	hasAttribute ($name)
	renderAttributeString ()
	setAttribute ($name, $value=null)
	setAttributes ($values)
	unsetAttribute ($name)

Protected Attributes
	$delimiter
	$elements = array()
	$required = array()
Protected Attributes inherited from Xoops\Form\Element
	$value = ''
Protected Attributes inherited from Xoops\Html\Attributes
	$attributes = array()

Additional Inherited Members
Public Attributes inherited from Xoops\Form\Element
	$customValidationCode = array()

Detailed Description

Definition at line 25 of file ElementTray.php.

Constructor & Destructor Documentation

Xoops\Form\ElementTray::__construct	(		$caption,
			$delimiter = " ",
			$name = ""
	)

__construct

Parameters

string	$caption	caption
string	$delimiter	delimiter
string	$name	name

Definition at line 55 of file ElementTray.php.

References Xoops\Form\Element\$caption, Xoops\Form\ElementTray\$delimiter, $name, Xoops\Form\Element\setCaption(), and Xoops\Form\Element\setName().

Here is the call graph for this function:

Member Function Documentation

Xoops\Form\ElementTray::addElement	(	Element	$formElement,
			$required = false
	)

Add an element to the group

Parameters

Element	$formElement	Element to add
boolean	$required	true = entry required

Returns

void

Definition at line 80 of file ElementTray.php.

References $count, $i, Xoops\Form\ElementTray\$required, and Xoops\Form\Element\setRequired().

Referenced by Xoops\Form\DateTime\__construct(), Xoops\Form\SelectUser\__construct(), and Xoops\Form\SelectEditor\render().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Form\ElementTray::getDelimiter

(

$encode = false

)

Get the delimiter of this group

Parameters

boolean

$encode

True to encode special characters

Returns

string The delimiter

Definition at line 146 of file ElementTray.php.

References Xoops\Form\ElementTray\$delimiter.

Referenced by Xoops\Form\TabTray\render(), and Xoops\Form\ElementTray\render().

Here is the caller graph for this function:

Xoops\Form\ElementTray::getElements

(

$recursively = false

)

Get an array of the elements in this group

Parameters

bool

$recursively

get elements recursively?

Returns

array Array of Element objects.

Implements Xoops\Form\ContainerInterface.

Definition at line 115 of file ElementTray.php.

References Xoops\Form\ElementTray\$elements.

Referenced by Xoops\Form\Tab\render(), Xoops\Form\TabTray\render(), and Xoops\Form\ElementTray\render().

Here is the caller graph for this function:

Xoops\Form\ElementTray::getRequired

(

)

get an array of "required" form elements

Returns

array array of Element objects

Implements Xoops\Form\ContainerInterface.

Definition at line 103 of file ElementTray.php.

References Xoops\Form\ElementTray\$required.

Xoops\Form\ElementTray::isRequired

(

)

Find out if there are required elements.

Returns

bool

Definition at line 67 of file ElementTray.php.

Xoops\Form\ElementTray::render

(

)

prepare HTML to output this group

Returns

string HTML output

Definition at line 156 of file ElementTray.php.

References $count, Xoops\Form\ElementTray\getDelimiter(), and Xoops\Form\ElementTray\getElements().

Here is the call graph for this function:

Member Data Documentation

Xoops\Form\ElementTray::$delimiter

protected

Definition at line 46 of file ElementTray.php.

Referenced by Xoops\Form\TabTray\__construct(), Xoops\Form\ElementTray\__construct(), and Xoops\Form\ElementTray\getDelimiter().

Xoops\Form\ElementTray::$elements = array()

protected

Definition at line 32 of file ElementTray.php.

Referenced by Xoops\Form\ElementTray\getElements().

Xoops\Form\ElementTray::$required = array()

protected

Definition at line 39 of file ElementTray.php.

Referenced by Xoops\Form\ElementTray\addElement(), Xoops\Form\ElementTray\getRequired(), and Xoops\Form\Tab\render().

---

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

• C:/usr64/htdocs/xoops_lib/Xoops/Form/ElementTray.php