1. class
  2. Nette
  3. \
  4. Forms
  5. \
  6. Container

Container

class Container extends Container implements ArrayAccess

Container for form controls.

Constants

ARRAY

Properties

array $onValidate Occurs when the form was validated
protected ControlGroup|null $currentGroup
ArrayHash $values

Methods

Container
setDefaults($data, bool $erase = false)

Fill-in with default values.

Container
setValues($data, bool $erase = false)

Fill-in with values.

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

Returns the values submitted by the form.

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

Returns the potentially unvalidated values submitted by the form.

Container
setMappedType(string $type)

No description

bool
isValid()

Is form valid?

void
validate(array $controls = null)

Performs the server side validation.

array
getErrors()

Returns all validation errors.

Container
setCurrentGroup(ControlGroup $group = null)

No description

ControlGroup|null
getCurrentGroup()

Returns current group.

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

Adds the specified component to the IContainer.

Iterator
getControls()

Iterates over all form controls.

Form|null
getForm(bool $throw = true)

Returns form.

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

Adds single-line text input control to the form.

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

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

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

Adds multi-line text input control to the form.

TextInput
addEmail(string $name, $label = null)

Adds input for email.

TextInput
addInteger(string $name, $label = null)

Adds input for integer.

UploadControl
addUpload(string $name, $label = null)

Adds control that allows the user to upload files.

UploadControl
addMultiUpload(string $name, $label = null)

Adds control that allows the user to upload multiple files.

HiddenField
addHidden(string $name, $default = null)

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

Checkbox
addCheckbox(string $name, $caption = null)

Adds check box control to the form.

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

Adds set of radio button controls to the form.

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

Adds set of checkbox controls to the form.

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

Adds select box control that allows single item selection.

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

Adds select box control that allows multiple item selection.

SubmitButton
addSubmit(string $name, $caption = null)

Adds button used to submit form.

Button
addButton(string $name, $caption = null)

Adds push buttons with no default behavior.

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

Adds graphical button used to submit form.

ImageButton
addImage() deprecated

No description

Container
addContainer(string|int $name)

Adds naming container to the form.

__call(string $name, array $args)

No description

static void
extensionMethod(string $name, $callback)

No description

__clone()

Prevents cloning.

Details

at line 56
Container setDefaults($data, bool $erase = false)

Fill-in with default values.

Parameters

$data
bool $erase

Return Value

Container

at line 72
Container setValues($data, bool $erase = false)

Fill-in with values.

Parameters

$data
bool $erase

Return Value

Container

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

Returns the values submitted by the form.

Parameters

string|object|null $returnType 'array' for array
array $controls

Return Value

object|array

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

Returns the potentially unvalidated values submitted by the form.

Parameters

string|object|null $returnType 'array' for array
array $controls

Return Value

object|array

at line 170
Container setMappedType(string $type)

Parameters

string $type

Return Value

Container

at line 183
bool isValid()

Is form valid?

Return Value

bool

at line 199
void validate(array $controls = null)

Performs the server side validation.

Parameters

array $controls

Return Value

void

at line 222
array getErrors()

Returns all validation errors.

Return Value

array

at line 236
Container setCurrentGroup(ControlGroup $group = null)

Parameters

ControlGroup $group

Return Value

Container

at line 246
ControlGroup|null getCurrentGroup()

Returns current group.

Return Value

ControlGroup|null

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

Adds the specified component to the IContainer.

Parameters

IComponent $component
string|null $name
string $insertBefore

Return Value

Container

Exceptions

InvalidStateException

at line 270
Iterator getControls()

Iterates over all form controls.

Return Value

Iterator

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

Returns form.

Parameters

bool $throw

Return Value

Form|null

at line 292
TextInput addText(string $name, $label = null, int $cols = null, int $maxLength = null)

Adds single-line text input control to the form.

Parameters

string $name
$label
int $cols
int $maxLength

Return Value

TextInput

at line 303
TextInput addPassword(string $name, $label = null, int $cols = null, int $maxLength = null)

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

Parameters

string $name
$label
int $cols
int $maxLength

Return Value

TextInput

at line 319
TextArea addTextArea(string $name, $label = null, int $cols = null, int $rows = null)

Adds multi-line text input control to the form.

Parameters

string $name
$label
int $cols
int $rows

Return Value

TextArea

at line 330
TextInput addEmail(string $name, $label = null)

Adds input for email.

Parameters

string $name
$label

Return Value

TextInput

at line 341
TextInput addInteger(string $name, $label = null)

Adds input for integer.

Parameters

string $name
$label

Return Value

TextInput

at line 353
UploadControl addUpload(string $name, $label = null)

Adds control that allows the user to upload files.

Parameters

string $name
$label

Return Value

UploadControl

at line 363
UploadControl addMultiUpload(string $name, $label = null)

Adds control that allows the user to upload multiple files.

Parameters

string $name
$label

Return Value

UploadControl

at line 372
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 383
Checkbox addCheckbox(string $name, $caption = null)

Adds check box control to the form.

Parameters

string $name
$caption

Return Value

Checkbox

at line 393
RadioList addRadioList(string $name, $label = null, array $items = null)

Adds set of radio button controls to the form.

Parameters

string $name
$label
array $items

Return Value

RadioList

at line 403
CheckboxList addCheckboxList(string $name, $label = null, array $items = null)

Adds set of checkbox controls to the form.

Parameters

string $name
$label
array $items

Return Value

CheckboxList

at line 413
SelectBox addSelect(string $name, $label = null, array $items = null, int $size = null)

Adds select box control that allows single item selection.

Parameters

string $name
$label
array $items
int $size

Return Value

SelectBox

at line 424
MultiSelectBox addMultiSelect(string $name, $label = null, array $items = null, int $size = null)

Adds select box control that allows multiple item selection.

Parameters

string $name
$label
array $items
int $size

Return Value

MultiSelectBox

at line 439
SubmitButton addSubmit(string $name, $caption = null)

Adds button used to submit form.

Parameters

string $name
$caption

Return Value

SubmitButton

at line 449
Button addButton(string $name, $caption = null)

Adds push buttons with no default behavior.

Parameters

string $name
$caption

Return Value

Button

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

Adds graphical button used to submit form.

Parameters

string $name
string $src
string $alt

Return Value

ImageButton

at line 467
ImageButton addImage() deprecated

deprecated use addImageButton()

Return Value

ImageButton

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

Adds naming container to the form.

Parameters

string|int $name

Return Value

Container

at line 491
__call(string $name, array $args)

Parameters

string $name
array $args

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

Parameters

string $name
$callback

Return Value

void

at line 512
__clone()

Prevents cloning.

Traits

ArrayAccess