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.
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.
Retrieves the entire hierarchy of form controls including nested.
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 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 49
Container
setDefaults(array|object $data, bool $erase = false)
Fill-in with default values.
at line 64
Container
setValues(array|object $data, bool $erase = false)
internal |
Fill-in with values.
at line 99
object|array
getValues(string|object|bool|null $returnType = null, array|null $controls = null)
Returns the values submitted by the form.
at line 137
object|array
getUntrustedValues(string|object|null $returnType = null, array|null $controls = null)
Returns the potentially unvalidated values submitted by the form.
at line 183
getUnsafeValues($returnType, array|null $controls = null)
deprecated
deprecated
No description
at line 191
Container
setMappedType(string $type)
No description
at line 204
bool
isValid()
Is form valid?
at line 225
void
validate(array|null $controls = null)
Performs the server side validation.
at line 250
array
getErrors()
Returns all validation errors.
at line 264
Container
setCurrentGroup(ControlGroup|null $group = null)
No description
at line 274
ControlGroup|null
getCurrentGroup()
Returns current group.
at line 284
Container
addComponent(IComponent $component, string|null $name, string|null $insertBefore = null)
Adds the specified component to the IContainer.
at line 307
array
getControls()
Retrieves the entire hierarchy of form controls including nested.
at line 317
Form|null
getForm(bool $throw = true)
Returns form.
at line 329
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 344
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 360
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 375
TextInput
addEmail(string $name, string|Stringable|null $label = null)
Adds input for email.
at line 385
TextInput
addInteger(string $name, string|Stringable|null $label = null)
Adds input for integer.
at line 396
TextInput
addFloat(string $name, string|Stringable|null $label = null)
Adds input for float.
at line 409
DateTimeControl
addDate(string $name, string|object|null $label = null)
Adds input for date selection.
at line 418
DateTimeControl
addTime(string $name, string|object|null $label = null, bool $withSeconds = false)
Adds input for time selection.
at line 431
DateTimeControl
addDateTime(string $name, string|object|null $label = null, bool $withSeconds = false)
Adds input for date and time selection.
at line 444
UploadControl
addUpload(string $name, string|Stringable|null $label = null)
Adds control that allows the user to upload files.
at line 453
UploadControl
addMultiUpload(string $name, string|Stringable|null $label = null)
Adds control that allows the user to upload multiple files.
at line 462
HiddenField
addHidden(string $name, $default = null)
Adds hidden form control used to store a non-displayed value.
at line 472
Checkbox
addCheckbox(string $name, string|Stringable|null $caption = null)
Adds check box control to the form.
at line 481
RadioList
addRadioList(string $name, string|Stringable|null $label = null, array|null $items = null)
Adds set of radio button controls to the form.
at line 494
CheckboxList
addCheckboxList(string $name, string|Stringable|null $label = null, array|null $items = null)
Adds set of checkbox controls to the form.
at line 507
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 522
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 537
ColorPicker
addColor(string $name, string|Stringable|null $label = null)
Adds color picker.
at line 546
SubmitButton
addSubmit(string $name, string|Stringable|null $caption = null)
Adds button used to submit form.
at line 555
Button
addButton(string $name, string|Stringable|null $caption = null)
Adds push buttons with no default behavior.
at line 566
ImageButton
addImageButton(string $name, string|null $src = null, string|null $alt = null)
Adds graphical button used to submit form.
at line 573
ImageButton
addImage()
deprecated
deprecated
No description
at line 583
Container
addContainer(string|int $name)
Adds naming container to the form.
at line 598
mixed
__call(string $name, array $args)
No description
at line 608
static void
extensionMethod(string $name, $callback)
No description
at line 621
__clone()
Prevents cloning.