Container
class Container extends Container implements ArrayAccess
Container for form controls.
Constants
| private ARRAY |
|
Properties
| $onValidate | Occurs when the form was validated |
||
| protected ControlGroup|null | $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.
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 integer.
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 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 56
Container
setDefaults(array|object $data, bool $erase = false)
Fill-in with default values.
at line 72
Container
setValues(array|object $data, bool $erase = false)
| internal |
Fill-in with values.
at line 112
object|array
getValues(string|object|null $returnType = null, array $controls = null)
Returns the values submitted by the form.
at line 137
object|array
getUnsafeValues(string|object|null $returnType, array $controls = null)
Returns the potentially unvalidated values submitted by the form.
at line 183
Container
setMappedType(string $type)
No description
at line 196
bool
isValid()
Is form valid?
at line 215
void
validate(array $controls = null)
Performs the server side validation.
at line 239
array
getErrors()
Returns all validation errors.
at line 253
Container
setCurrentGroup(ControlGroup $group = null)
No description
at line 263
ControlGroup|null
getCurrentGroup()
Returns current group.
at line 274
IContainer
addComponent(IComponent $component, string|null $name, string $insertBefore = null)
Adds the specified component to the IContainer.
at line 287
Iterator
getControls()
Iterates over all form controls.
at line 296
Form|null
getForm(bool $throw = true)
Returns form.
at line 309
TextInput
addText(string $name, string|object $label = null, int $cols = null, int $maxLength = null)
Adds single-line text input control to the form.
at line 320
TextInput
addPassword(string $name, string|object $label = null, int $cols = null, int $maxLength = null)
Adds single-line text input control used for sensitive input such as passwords.
at line 336
TextArea
addTextArea(string $name, string|object $label = null, int $cols = null, int $rows = null)
Adds multi-line text input control to the form.
at line 347
TextInput
addEmail(string $name, string|object $label = null)
Adds input for email.
at line 358
TextInput
addInteger(string $name, string|object $label = null)
Adds input for integer.
at line 370
UploadControl
addUpload(string $name, string|object $label = null)
Adds control that allows the user to upload files.
at line 380
UploadControl
addMultiUpload(string $name, string|object $label = null)
Adds control that allows the user to upload multiple files.
at line 389
HiddenField
addHidden(string $name, $default = null)
Adds hidden form control used to store a non-displayed value.
at line 400
Checkbox
addCheckbox(string $name, string|object $caption = null)
Adds check box control to the form.
at line 410
RadioList
addRadioList(string $name, string|object $label = null, array $items = null)
Adds set of radio button controls to the form.
at line 420
CheckboxList
addCheckboxList(string $name, string|object $label = null, array $items = null)
Adds set of checkbox controls to the form.
at line 430
SelectBox
addSelect(string $name, string|object $label = null, array $items = null, int $size = null)
Adds select box control that allows single item selection.
at line 441
MultiSelectBox
addMultiSelect(string $name, string|object $label = null, array $items = null, int $size = null)
Adds select box control that allows multiple item selection.
at line 456
SubmitButton
addSubmit(string $name, string|object $caption = null)
Adds button used to submit form.
at line 466
Button
addButton(string $name, string|object $caption = null)
Adds push buttons with no default behavior.
at line 477
ImageButton
addImageButton(string $name, string $src = null, string $alt = null)
Adds graphical button used to submit form.
at line 484
ImageButton
addImage()
deprecated
deprecated
No description
at line 494
Container
addContainer(string|int $name)
Adds naming container to the form.
at line 508
__call(string $name, array $args)
No description
at line 517
static void
extensionMethod(string $name, $callback)
No description
at line 529
__clone()
Prevents cloning.
Traits
Implementation of \ArrayAccess for IContainer.