class Container extends Container implements ArrayAccess

Container for form controls.

Constants

private Array

Properties

$onValidate

Occurs when the form was validated

protected $currentGroup
ArrayHash $values
Iterator read-only $controls
Form|null read-only $form

Methods

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

Fill-in with default values.

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

Fill-in with values.

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

Returns the values submitted by the form.

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

Returns the potentially unvalidated values submitted by the form.

setMappedType(string $type)

No description

bool
isValid()

Is form valid?

void
validate(array|null $controls = null)

Performs the server side validation.

array
getErrors()

Returns all validation errors.

setCurrentGroup(ControlGroup|null $group = null)

No description

ControlGroup|null
getCurrentGroup()

Returns current group.

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

Adds the specified component to the IContainer.

getControls()

Iterates over all form controls.

Form|null
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)

Adds input for email.

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

Adds input for integer.

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.

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() deprecated

No description

addContainer(string|int $name)

Adds naming container to the form.

mixed
__call(string $name, array $args)

No description

static void
extensionMethod(string $name, $callback)

No description

__clone()

Prevents cloning.

Details

at line 52
Container setDefaults(array|object $data, bool $erase = false)

Fill-in with default values.

Parameters

array|object $data
bool $erase

Return Value

Container

at line 67
Container setValues(array|object $data, bool $erase = false)

internal  
 

Fill-in with values.

Parameters

array|object $data
bool $erase

Return Value

Container

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

Returns the values submitted by the form.

Parameters

string|object|bool|null $returnType

'array' for array

array|null $controls

Return Value

object|array

at line 135
object|array getUnsafeValues(string|object|null $returnType, array|null $controls = null)

Returns the potentially unvalidated values submitted by the form.

Parameters

string|object|null $returnType

'array' for array

array|null $controls

Return Value

object|array

at line 180
Container setMappedType(string $type)

No description

Parameters

string $type

Return Value

Container

at line 193
bool isValid()

Is form valid?

Return Value

bool

at line 214
void validate(array|null $controls = null)

Performs the server side validation.

Parameters

array|null $controls

Return Value

void

at line 239
array getErrors()

Returns all validation errors.

Return Value

array

at line 253
Container setCurrentGroup(ControlGroup|null $group = null)

No description

Parameters

ControlGroup|null $group

Return Value

Container

at line 263
ControlGroup|null getCurrentGroup()

Returns current group.

Return Value

ControlGroup|null

at line 273
Container addComponent(IComponent $component, string|null $name, string|null $insertBefore = null)

Adds the specified component to the IContainer.

Parameters

IComponent $component
string|null $name
string|null $insertBefore

Return Value

Container

Exceptions

InvalidStateException

at line 294
Iterator getControls()

Iterates over all form controls.

Return Value

Iterator

at line 303
Form|null getForm(bool $throw = true)

Returns form.

Parameters

bool $throw

Return Value

Form|null

at line 315
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.

Parameters

string $name
string|Stringable|null $label
int|null $cols
int|null $maxLength

Return Value

TextInput

at line 329
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.

Parameters

string $name
string|Stringable|null $label
int|null $cols
int|null $maxLength

Return Value

TextInput

at line 344
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.

Parameters

string $name
string|Stringable|null $label
int|null $cols
int|null $rows

Return Value

TextArea

at line 358
TextInput addEmail(string $name, string|Stringable|null $label = null)

Adds input for email.

Parameters

string $name
string|Stringable|null $label

Return Value

TextInput

at line 368
TextInput addInteger(string $name, string|Stringable|null $label = null)

Adds input for integer.

Parameters

string $name
string|Stringable|null $label

Return Value

TextInput

at line 379
UploadControl addUpload(string $name, string|Stringable|null $label = null)

Adds control that allows the user to upload files.

Parameters

string $name
string|Stringable|null $label

Return Value

UploadControl

at line 388
UploadControl addMultiUpload(string $name, string|Stringable|null $label = null)

Adds control that allows the user to upload multiple files.

Parameters

string $name
string|Stringable|null $label

Return Value

UploadControl

at line 397
HiddenField addHidden(string $name, $default = null)

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

Parameters

string $name
$default

Return Value

HiddenField

at line 407
Checkbox addCheckbox(string $name, string|Stringable|null $caption = null)

Adds check box control to the form.

Parameters

string $name
string|Stringable|null $caption

Return Value

Checkbox

at line 416
RadioList addRadioList(string $name, string|Stringable|null $label = null, array|null $items = null)

Adds set of radio button controls to the form.

Parameters

string $name
string|Stringable|null $label
array|null $items

Return Value

RadioList

at line 428
CheckboxList addCheckboxList(string $name, string|Stringable|null $label = null, array|null $items = null)

Adds set of checkbox controls to the form.

Parameters

string $name
string|Stringable|null $label
array|null $items

Return Value

CheckboxList

at line 440
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.

Parameters

string $name
string|Stringable|null $label
array|null $items
int|null $size

Return Value

SelectBox

at line 454
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.

Parameters

string $name
string|Stringable|null $label
array|null $items
int|null $size

Return Value

MultiSelectBox

at line 468
SubmitButton addSubmit(string $name, string|Stringable|null $caption = null)

Adds button used to submit form.

Parameters

string $name
string|Stringable|null $caption

Return Value

SubmitButton

at line 477
Button addButton(string $name, string|Stringable|null $caption = null)

Adds push buttons with no default behavior.

Parameters

string $name
string|Stringable|null $caption

Return Value

Button

at line 488
ImageButton addImageButton(string $name, string|null $src = null, string|null $alt = null)

Adds graphical button used to submit form.

Parameters

string $name
string|null $src

URI of the image

string|null $alt

alternate text for the image

Return Value

ImageButton

at line 495
ImageButton addImage() deprecated

deprecated use addImageButton()

No description

Return Value

ImageButton

at line 504
Container addContainer(string|int $name)

Adds naming container to the form.

Parameters

string|int $name

Return Value

Container

at line 519
mixed __call(string $name, array $args)

No description

Parameters

string $name
array $args

Return Value

mixed

at line 529
static void extensionMethod(string $name, $callback)

No description

Parameters

string $name
$callback

Return Value

void

at line 542
__clone()

Prevents cloning.

Traits

ArrayAccess