Container

setDefaults(array|object $values, bool $erase = false)

Fill-in with default values.

setValues(array|object $values, bool $erase = false, bool $onlyDisabled = false)

Fill-in with values.

getValues(string|object|bool|null $returnType = null, array|null $controls = null)

Returns the values submitted by the form.

getUntrustedValues(string|object|null $returnType = null, array|null $controls = null)

Returns the potentially unvalidated values submitted by the form.

getUnsafeValues($returnType, array|null $controls = null)

No description

setMappedType(string $type)

No description

isValid()

Is form valid?

validate(array|null $controls = null)

Performs the server side validation.

getErrors()

Returns all validation errors.

setCurrentGroup(ControlGroup|null $group = null)

No description

getCurrentGroup()

Returns current group.

addComponent(IComponent $component, string|null $name, string|null $insertBefore = null)

Adds the specified component to the IContainer.

getControls()

Retrieves the entire hierarchy of form controls including nested.

getForm(bool $throw = true)

Returns form.

addText(string $name, string|Stringable|null $label = null, int|null $cols = null, int|null $maxLength = null)

Adds single-line text input control to the form.

addPassword(string $name, string|Stringable|null $label = null, int|null $cols = null, int|null $maxLength = null)

Adds single-line text input control used for sensitive input such as passwords.

addTextArea(string $name, string|Stringable|null $label = null, int|null $cols = null, int|null $rows = null)

Adds multi-line text input control to the form.

addEmail(string $name, string|Stringable|null $label = null, int $maxLength = 255)

Adds input for email.

addInteger(string $name, string|Stringable|null $label = null)

Adds input for integer.

addFloat(string $name, string|Stringable|null $label = null)

Adds input for float.

addDate(string $name, string|object|null $label = null)

Adds input for date selection.

addTime(string $name, string|object|null $label = null, bool $withSeconds = false)

Adds input for time selection.

addDateTime(string $name, string|object|null $label = null, bool $withSeconds = false)

Adds input for date and time selection.

addUpload(string $name, string|Stringable|null $label = null)

Adds control that allows the user to upload files.

addMultiUpload(string $name, string|Stringable|null $label = null)

Adds control that allows the user to upload multiple files.

addHidden(string $name, $default = null)

Adds hidden form control used to store a non-displayed value.

addCheckbox(string $name, string|Stringable|null $caption = null)

Adds check box control to the form.

addRadioList(string $name, string|Stringable|null $label = null, array|null $items = null)

Adds set of radio button controls to the form.

addCheckboxList(string $name, string|Stringable|null $label = null, array|null $items = null)

Adds set of checkbox controls to the form.

addSelect(string $name, string|Stringable|null $label = null, array|null $items = null, int|null $size = null)

Adds select box control that allows single item selection.

addMultiSelect(string $name, string|Stringable|null $label = null, array|null $items = null, int|null $size = null)

Adds select box control that allows multiple item selection.

addColor(string $name, string|Stringable|null $label = null)

Adds color picker.

addSubmit(string $name, string|Stringable|null $caption = null)

Adds button used to submit form.

addButton(string $name, string|Stringable|null $caption = null)

Adds push buttons with no default behavior.

addImageButton(string $name, string|null $src = null, string|null $alt = null)

Adds graphical button used to submit form.

addImage()

No description

addContainer(string|int $name)

Adds naming container to the form.

__call(string $name, array $args)

No description

extensionMethod(string $name, $callback)

No description

__clone()

Prevents cloning.

ArrayAccess