Class ElementTray

ElementTray - a group of form elements

ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable

Xoops\Html\Attributes implements Xoops\Core\AttributeInterface

Xoops\Form\Element

Xoops\Form\ElementTray implements Xoops\Form\ContainerInterface

Direct known subclasses

PublisherFormDateTime, Xoops\Form\DateTime, Xoops\Form\SelectEditor, Xoops\Form\SelectUser, Xoops\Form\Tab, Xoops\Form\TabTray, XoopsFormElementTray

Indirect known subclasses

XoopsFormDateTime, XoopsFormSelectEditor, XoopsFormSelectUser

Namespace: Xoops\Form
Package: Xoops\Form
Category: Xoops\Form\ElementTray
Copyright: 2001-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Link: http://xoops.org
Located at oops_lib/Xoops/Form/ElementTray.php

Methods summary
`public`	# `__construct( string\|array $caption, string $joiner = ' ', string $name = '' )` __construct __construct Parameters `$caption` caption or array of all attributes Control attributes: :joiner joiner for elements in tray `$joiner` joiner for elements in tray `$name` name Overrides `Xoops\Form\Element::__construct()`
`public boolean`	# `isRequired( )` Are there are required elements? Are there are required elements? Returns boolean Overrides `Xoops\Form\Element::isRequired()`
`public`	# `addElement( Xoops\Form\Element $formElement, boolean $required = false )` Add an element to the tray Add an element to the tray Parameters `$formElement` Element to add `$required` true = entry required Implementation of `Xoops\Form\ContainerInterface::addElement()`
`public array`	# `getRequired( )` get an array of "required" form elements get an array of "required" form elements Returns array array of Element objects Implementation of `Xoops\Form\ContainerInterface::getRequired()`
`public array`	# `getElements( boolean $recurse = false )` Get an array of the elements in this group Get an array of the elements in this group Parameters `$recurse` get elements recursively? Returns array Array of Element objects. Implementation of `Xoops\Form\ContainerInterface::getElements()`
`protected string`	# `getJoiner( boolean $encode = false )` Get the delimiter of this group Get the delimiter of this group Parameters `$encode` True to encode special characters Returns string The delimiter
`public string`	# `render( )` prepare HTML to output this group prepare HTML to output this group Returns string HTML output

Methods inherited from Xoops\Form\Element
addCustomValidationCode(), getAccessKey(), getAccessString(), getCaption(), getClass(), getDescription(), getExtra(), getName(), getPattern(), getPatternDescription(), getTitle(), getValue(), hasClassLike(), isDatalist(), isHidden(), renderAttributeString(), renderDatalist(), renderValidationJS(), setAccessKey(), setCaption(), setClass(), setDatalist(), setDescription(), setExtra(), setHidden(), setIfNotEmpty(), setIfNotSet(), setName(), setPattern(), setRequired(), setTitle(), setValue(), setWithDefaults(), themeDecorateElement()

Methods inherited from Xoops\Html\Attributes
`add(), clear(), doRender(), get(), getAll(), getAllLike(), getNames(), has(), remove(), set(), setAll(), setArrayItem(), setMerge(), suppressRender()`

Methods inherited from ArrayObject
`append(), asort(), count(), exchangeArray(), getArrayCopy(), getFlags(), getIterator(), getIteratorClass(), ksort(), natcasesort(), natsort(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), serialize(), setFlags(), setIteratorClass(), uasort(), uksort(), unserialize()`

Constants inherited from ArrayObject
`ARRAY_AS_PROPS, STD_PROP_LIST`

Properties summary
`protected Xoops\Form\Element[]`	`$elements` array of form element objects array of form element objects	# `array()`

Properties inherited from Xoops\Form\Element
`$customValidationCode, $extra, $suppressList`

Properties inherited from Xoops\Html\Attributes
`$suppressRenderAttributes`

Namespaces

Classes

Interfaces

Class ElementTray

Direct known subclasses

Indirect known subclasses

Parameters

Overrides

Returns

Overrides

Parameters

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Returns