Class XoopsFormElementTray

A group of form elements

XoopsFormElementTray

Direct known subclasses

XoopsFormDateTime, XoopsFormSelectEditor, XoopsFormSelectUser

Package: kernel\form
Copyright: (c) 2000-2017 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/
Located at lass/xoopsform/formelementtray.php

Methods summary
`public`	# `__construct( string $caption, string $delimeter = ' ', string $name = '' )` constructor constructor Parameters `$caption` Caption for the group. `$delimeter` HTML to separate the elements `$name` Overrides `XoopsFormElement::__construct()`
`public boolean`	# `isContainer( )` Is this element a container of other elements? Is this element a container of other elements? Returns boolean true Overrides `XoopsFormElement::isContainer()`
`public boolean`	# `isRequired( )` Find out if there are required elements. Find out if there are required elements. Returns boolean Overrides `XoopsFormElement::isRequired()`
`public`	# `addElement( XoopsFormElement $formElement, boolean $required = false )` Add an element to the group Add an element to the group Parameters `$formElement` `XoopsFormElement` to add `$required`
`public array &`	# `getRequired( )` get an array of "required" form elements get an array of "required" form elements Returns array array of `XoopsFormElement`s
`public XoopsFormElement[] &`	# `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 `XoopsFormElement[]` Array of `XoopsFormElement` objects.
`public string`	# `getDelimeter( boolean $encode = false )` Get the delimiter of this group Get the delimiter of this group Parameters `$encode` To sanitizer the text? Returns string The delimiter
`public string`	# `render( )` prepare HTML to output this group prepare HTML to output this group Returns string HTML output Overrides `XoopsFormElement::render()`

Methods inherited from XoopsFormElement
`getAccessKey(), getAccessString(), getCaption(), getClass(), getDescription(), getExtra(), getFormType(), getName(), getNocolspan(), getTitle(), isHidden(), renderValidationJS(), setAccessKey(), setCaption(), setClass(), setDescription(), setExtra(), setFormType(), setHidden(), setName(), setNocolspan()`

Properties summary
`public array`	`$_required` required elements required elements	# `array()`

Properties inherited from XoopsFormElement
`$_accesskey, $_caption, $_class, $_description, $_extra, $_formtype, $_hidden, $_name, $_nocolspan, $customValidationCode`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsFormElementTray

Direct known subclasses

Parameters

Overrides

Returns

Overrides

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Overrides