extends |
XoopsFormElement |
|---|
A group of form elements
| Methods | ||||||
|---|---|---|---|---|---|---|
public
|
__construct(string $caption, string $delimeter = ' ', string $name = '')
constructor
constructor Parameters
OverridesOverriden by |
# | ||||
public
|
isContainer(): bool
Is this element a container of other elements?
Is this element a container of other elements? Returnstrue Overrides |
# | ||||
public
|
isRequired(): bool
Find out if there are required elements.
|
# | ||||
public
|
addElement(XoopsFormElement $formElement, bool $required = false)
Add an element to the group
Add an element to the group Parameters
|
# | ||||
public
&
|
getRequired(): array
get an array of "required" form elements
get an array of "required" form elements Returnsarray of {@link XoopsFormElement}s |
# | ||||
public
&
|
getElements(bool $recurse = false): XoopsFormElement[]
Get an array of the elements in this group
Get an array of the elements in this group Parameters
ReturnsArray of {@link XoopsFormElement} objects. |
# | ||||
public
|
getDelimeter(bool $encode = false): string
Get the delimiter of this group
Get the delimiter of this group Parameters
ReturnsThe delimiter |
# | ||||
public
|
setOrientation(string $direction)
setOrientation() communicate to renderer the expected tray orientation
\XoopsFormElementTray::ORIENTATION_HORIZONTAL…
setOrientation() communicate to renderer the expected tray orientation \XoopsFormElementTray::ORIENTATION_HORIZONTAL for across \XoopsFormElementTray::ORIENTATION_VERTICAL for up and down If not set explicitly, a default value will be assigned on getOrientation() Parameters
|
# | ||||
public
|
getOrientation(): string
getOrientation() return the expected tray orientation
getOrientation() return the expected tray orientation The value will be assigned a default value if not previously set. The default logic considers the presence of an HTML br tag in _delimeter as implying ORIENTATION_VERTICAL for bc Returnseither \XoopsFormElementTray::ORIENTATION_HORIZONTAL or \XoopsFormElementTray::ORIENTATION_VERTICAL\ |
# | ||||
public
|
render(): string
prepare HTML to output this group
prepare HTML to output this group ReturnsHTML output OverridesOverriden by |
# | ||||
| Constants | ||
|---|---|---|
public
|
ORIENTATION_HORIZONTAL = 'horizontal'
|
# |
public
|
ORIENTATION_VERTICAL = 'vertical'
|
# |
| Properties | |||
|---|---|---|---|
public
|
array
|
$_required = []
|
# |
protected
|
|
$orientation
|
# |
| Properties inherited from XoopsFormElement |
|---|
$customValidationCode, $_name, $_caption, $_accesskey, $_class, $_hidden, $_extra, $_description, $_nocolspan, $_formtype |