Group

Base class for an HTML element with children.

---

• Full name: \Qubus\Form\FormBuilder\Group
• Parent class: \Qubus\Form\FormBuilder\Element

Constants

Constant	Visibility	Type	Value
TAGNAME	public	string	null

Properties

children

Child nodes of the group.

protected array $children

---

Methods

addDecorator

Add a decorator to the element.

public addDecorator(string|\Qubus\Form\FormBuilder\Decorator $decorator): $this

Parameters:

Parameter	Type	Description
$decorator	string|\Qubus\Form\FormBuilder\Decorator	Decorator object or name

---

applyDeepDecorators

Apply decorators from parent.

protected applyDeepDecorators(\Qubus\Form\FormBuilder\Group $parent): void

Parameters:

Parameter	Type	Description
$parent	\Qubus\Form\FormBuilder\Group

---

add

Add a child to the group.

public add(string|\Qubus\Form\FormBuilder\Element $child, array $options = [], array $attr = []): \Qubus\Form\FormBuilder\Group

Parameters:

Parameter	Type	Description
$child	string|\Qubus\Form\FormBuilder\Element
$options	array	Element options
$attr	array	HTML attributes

Return Value:

$this

Throws:

• Exception

---

begin

Add a child and return it.

public begin(string|\Qubus\Form\FormBuilder\Element $child, array $options = [], array $attr = []): \Qubus\Form\FormBuilder\Element

Parameters:

Parameter	Type	Description
$child	string|\Qubus\Form\FormBuilder\Element
$options	array	Element options
$attr	array	HTML attributes

Return Value:

$child

Throws:

• \Qubus\Exception\Data\TypeException|\Qubus\Exception\Exception

---

getChildren

Get the children of the group.

public getChildren(): array

---

deepSearch

Find a specific child through deep search.

protected deepSearch(\Qubus\Form\FormBuilder\Element|string $element, bool $unlink = false): \Qubus\Form\FormBuilder\Element|null

Parameters:

Parameter	Type	Description
$element	\Qubus\Form\FormBuilder\Element|string	Element name or #id
$unlink	bool	Unlink the found element

---

get

Get a specific child (deep search).

public get(string $name): \Qubus\Form\FormBuilder\Element|null

Parameters:

Parameter	Type	Description
$name	string	Element name or #id

---

has

Checks if a specific child exists.

public has(string $name): bool

Parameters:

Parameter	Type	Description
$name	string	Element name or id.

---

getControls

Get all the form elements in the group (deep search).

public getControls(): \Qubus\Form\FormBuilder\Control[]

---

remove

Remove a specific child (deep search)

public remove(\Qubus\Form\FormBuilder\Element|string $element): \Qubus\Form\FormBuilder\Group

Parameters:

Parameter	Type	Description
$element	\Qubus\Form\FormBuilder\Element|string	Element, element name or #id.

Return Value:

$this

---

setContent

Set the element content.

public setContent(\Closure|string|null $content = null): $this

Parameters:

Parameter	Type	Description
$content	\Closure|string|null

---

setValues

Set the values of the elements.

public setValues(array $values): \Qubus\Form\FormBuilder\Group

Parameters:

Parameter	Type	Description
$values	array

Return Value:

$this

---

getValues

Get the values of the elements.

public getValues(): array

---

validate

Validate the elements in the group.

protected validate(): bool

---

open

Render the opening tag

public open(): string|null

---

close

Render the closing tag

public close(): string|null

---

renderContent

Render the content of the HTML element.

protected renderContent(): string|null

---

render

Render the child to HTML.

protected render(): string

---

Inherited methods

__construct

public __construct(array $options = [], array $attr = []): mixed

Parameters:

Parameter	Type	Description
$options	array	Element options
$attr	array	HTML attributes

---

addDecorator

Add a decorator to the element.

public addDecorator(string|\Qubus\Form\FormBuilder\Decorator $decorator): \Qubus\Form\FormBuilder\Element

Parameters:

Parameter	Type	Description
$decorator	string|\Qubus\Form\FormBuilder\Decorator	Decorator object or name

Return Value:

$this

---

applyDeepDecorators

Apply decorators from parent

protected applyDeepDecorators(\Qubus\Form\FormBuilder\Group $parent): void

Parameters:

Parameter	Type	Description
$parent	\Qubus\Form\FormBuilder\Group

---

getDecorators

Get all decorators

public getDecorators(): \Qubus\Form\FormBuilder\Decorator[]

---

convertCustomType

Convert custom (form specific) type to general factory type.

protected convertCustomType(string& $type, array& $options, array& $attr = []): void

Parameters:

Parameter	Type	Description
$type	string	(in/out) Element type
$options	array	(in/out) Element options
$attr	array	(in/out) HTML attributes

---

build

Factory method

public build(string $type, array $options = [], array $attr = []): \Qubus\Form\FormBuilder\Element

Parameters:

Parameter	Type	Description
$type	string	Element type
$options	array	Element options
$attr	array	HTML attributes

Throws:

• TypeException
• Exception

---

getForm

Get the form to which this element is added.

public getForm(): \Qubus\Form\FormBuilder\Group|\Qubus\Form\FormBuilder\Element|\Qubus\Form\Form|null

---

asComponentOf

Set element of which this a component of

protected asComponentOf(\Qubus\Form\FormBuilder\Element $element): \Qubus\Form\FormBuilder\Element

Parameters:

Parameter	Type	Description
$element	\Qubus\Form\FormBuilder\Element

Return Value:

$this

---

isComponent

Check if element is used as a component

public isComponent(): bool

---

setParent

Set parent element

protected setParent(\Qubus\Form\FormBuilder\Element $parent): \Qubus\Form\FormBuilder\Element

Parameters:

Parameter	Type	Description
$parent	\Qubus\Form\FormBuilder\Element

Return Value:

$this

Throws:

• Exception

---

getParent

Return parent element

public getParent(): \Qubus\Form\FormBuilder\Group|null

---

end

Get parent or element of which this is an component.

public end(): \Qubus\Form\FormBuilder\Element|\Qubus\Form\FormBuilder\Group|null

---

getId

Get element id.

public getId(): string

---

getName

Return the name of the control.

public getName(): bool|string|null

---

setAttr

Set HTML attribute(s).

final public setAttr(array|string $attr, mixed|null $value = null): \Qubus\Form\FormBuilder\Element

• This method is final. Parameters:

Parameter	Type	Description
$attr	array|string	Attribute name or assoc array with attributes
$value	mixed|null

Return Value:

$this

---

getAttr

Get an HTML attribute(s).

final public getAttr(string|null $attr = null): mixed

All attributes will be cased to their string representation.

• This method is final. Parameters:

Parameter	Type	Description
$attr	string|null	Attribute name, omit to get all attributes

---

hasClass

Check if class is present

final public hasClass(string $class): bool

• This method is final. Parameters:

Parameter	Type	Description
$class	string

---

addClass

Add a class

final public addClass(array|string $class): \Qubus\Form\FormBuilder\Element

• This method is final. Parameters:

Parameter	Type	Description
$class	array|string	Multiple classes may be specified as array or using a space

Return Value:

$this

---

removeClass

Remove a class

public removeClass(array|string $class): \Qubus\Form\FormBuilder\Element

Parameters:

Parameter	Type	Description
$class	array|string	Multiple classes may be specified as array or using a space

Return Value:

$this

---

setOption

Set an option or array with options

public setOption(array|string $option, mixed|null $value = null): \Qubus\Form\FormBuilder\Element

Parameters:

Parameter	Type	Description
$option	array|string	Option name or array with options
$value	mixed|null

Return Value:

$this

---

getOption

Get an option.

public getOption(string $option): mixed

Parameters:

Parameter	Type	Description
$option	string

---

getOptions

Get all options.

public getOptions(): array

Bubbles to combine options of parent/ancestors.

---

isValid

Validate the element.

final public isValid(): bool

• This method is final.

---

validate

Standard validation for the element

protected validate(): bool

---

setContent

Set element content

public setContent(\Closure|string $content): $this

Parameters:

Parameter	Type	Description
$content	\Closure|string	Content as HTML

---

getContent

Get the element content

final public getContent(): string|null

• This method is final.

---

renderContent

Render the element content

protected renderContent(): string|null

---

render

Render the element

protected render(): string

---

toHTML

Render the element to HTML.

final public toHTML(): string

• This method is final.

---

__toString

Render the element to HTML.

final public __toString(): string

• This method is final.

---

parse

Parse a message, inserting values for placeholders.

public parse(string $message): string

Parameters:

Parameter	Type	Description
$message	string

---

resolvePlaceholder

Get a value for a placeholder

protected resolvePlaceholder(string|array $var): string

Parameters:

Parameter	Type	Description
$var	string|array

---

convertTo

Convert an element to another type.

public convertTo(string $type): \Qubus\Form\FormBuilder\Element

Simply returns $this if element is already of correct type.

Parameters:

Parameter	Type	Description
$type	string

---

__clone

Magic method called after cloning element

public __clone(): mixed

---

onClone

Method called after cloning on copying element

protected onClone(): void

---

2026-02-072026-02-07