Container
class Container extends Container implements ArrayAccess
Container for form controls.
Constants
Array |
|
Properties
$onValidate | Occurs when the form was validated |
||
protected | $currentGroup | ||
ArrayHash | $values | ||
Iterator read-only | $controls | ||
Form|null read-only | $form |
Methods
Fill-in with default values.
Fill-in with values.
Returns the values submitted by the form.
Returns the potentially unvalidated values submitted by the form.
No description
Is form valid?
Performs the server side validation.
Returns all validation errors.
No description
Returns current group.
Adds the specified component to the IContainer.
Iterates over all form controls.
Returns form.
Adds single-line text input control to the form.
Adds single-line text input control used for sensitive input such as passwords.
Adds multi-line text input control to the form.
Adds input for email.
Adds input for integer.
Adds input for date selection.
Adds input for time selection.
Adds input for date and time selection.
Adds control that allows the user to upload files.
Adds control that allows the user to upload multiple files.
Adds hidden form control used to store a non-displayed value.
Adds check box control to the form.
Adds set of radio button controls to the form.
Adds set of checkbox controls to the form.
Adds select box control that allows single item selection.
Adds select box control that allows multiple item selection.
Adds color picker.
Adds button used to submit form.
Adds push buttons with no default behavior.
Adds graphical button used to submit form.
Adds naming container to the form.
No description
No description
Prevents cloning.
Details
at line 50
Container
setDefaults(array|object $data, bool $erase = false)
Fill-in with default values.
at line 62
Container
setValues(array|object $values, bool $erase = false, bool $onlyDisabled = false)
internal |
Fill-in with values.
at line 88
object|array
getValues(string|object|bool|null $returnType = null, array|null $controls = null)
Returns the values submitted by the form.
at line 126
object|array
getUntrustedValues(string|object|null $returnType = null, array|null $controls = null)
Returns the potentially unvalidated values submitted by the form.
at line 176
getUnsafeValues($returnType, array|null $controls = null)
deprecated
deprecated
No description
at line 182
Container
setMappedType(string $type)
No description
at line 195
bool
isValid()
Is form valid?
at line 216
void
validate(array|null $controls = null)
Performs the server side validation.
at line 241
array
getErrors()
Returns all validation errors.
at line 255
Container
setCurrentGroup(ControlGroup|null $group = null)
No description
at line 265
ControlGroup|null
getCurrentGroup()
Returns current group.
at line 275
Container
addComponent(IComponent $component, string|null $name, string|null $insertBefore = null)
Adds the specified component to the IContainer.
at line 290
Iterator
getControls()
Iterates over all form controls.
at line 300
Form|null
getForm(bool $throw = true)
Returns form.
at line 312
TextInput
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.
at line 327
TextInput
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.
at line 343
TextArea
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.
at line 358
TextInput
addEmail(string $name, string|Stringable|null $label = null, int $maxLength = 255)
Adds input for email.
at line 372
TextInput
addInteger(string $name, string|Stringable|null $label = null)
Adds input for integer.
at line 383
TextInput
addFloat(string $name, string|Stringable|null $label = null)
Adds input for float.
at line 396
DateTimeControl
addDate(string $name, string|object|null $label = null)
Adds input for date selection.
at line 405
DateTimeControl
addTime(string $name, string|object|null $label = null, bool $withSeconds = false)
Adds input for time selection.
at line 418
DateTimeControl
addDateTime(string $name, string|object|null $label = null, bool $withSeconds = false)
Adds input for date and time selection.
at line 431
UploadControl
addUpload(string $name, string|Stringable|null $label = null)
Adds control that allows the user to upload files.
at line 440
UploadControl
addMultiUpload(string $name, string|Stringable|null $label = null)
Adds control that allows the user to upload multiple files.
at line 449
HiddenField
addHidden(string $name, $default = null)
Adds hidden form control used to store a non-displayed value.
at line 459
Checkbox
addCheckbox(string $name, string|Stringable|null $caption = null)
Adds check box control to the form.
at line 468
RadioList
addRadioList(string $name, string|Stringable|null $label = null, array|null $items = null)
Adds set of radio button controls to the form.
at line 481
CheckboxList
addCheckboxList(string $name, string|Stringable|null $label = null, array|null $items = null)
Adds set of checkbox controls to the form.
at line 494
SelectBox
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.
at line 509
MultiSelectBox
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.
at line 524
ColorPicker
addColor(string $name, string|Stringable|null $label = null)
Adds color picker.
at line 533
SubmitButton
addSubmit(string $name, string|Stringable|null $caption = null)
Adds button used to submit form.
at line 542
Button
addButton(string $name, string|Stringable|null $caption = null)
Adds push buttons with no default behavior.
at line 553
ImageButton
addImageButton(string $name, string|null $src = null, string|null $alt = null)
Adds graphical button used to submit form.
at line 560
ImageButton
addImage()
deprecated
deprecated
No description
at line 569
Container
addContainer(string|int $name)
Adds naming container to the form.
at line 581
__call(string $name, array $args)
No description
at line 591
static void
extensionMethod(string $name, $callback)
No description
at line 604
__clone()
Prevents cloning.