Packages

  • Nette
    • Application
    • Caching
    • Collections
    • Config
    • Forms
    • IO
    • Loaders
    • Mail
    • Reflection
    • Security
    • Templates
    • Web
  • None
  • PHP

Classes

  • NButton
  • NCheckbox
  • NConventionalRenderer
  • NFileUpload
  • NForm
  • NFormContainer
  • NFormGroup
  • NHiddenField
  • NImageButton
  • NInstantClientScript
  • NMultiSelectBox
  • NRadioList
  • NRule
  • NRules
  • NSelectBox
  • NSubmitButton
  • NTextArea
  • NTextBase
  • NTextInput

Interfaces

  • IFormControl
  • IFormRenderer
  • INamingContainer
  • ISubmitterControl
  • Overview
  • Package
  • Class
  • Tree
  • Other releases

Class NFormContainer

Container for form controls.

NObject
Extended by NComponent implements IComponent
Extended by NComponentContainer implements IComponentContainer
Extended by NFormContainer implements ArrayAccess, INamingContainer

Direct known subclasses

NForm

Indirect known subclasses

NAppForm
Package: Nette\Forms
Author: David Grudl
Located at Forms/FormContainer.php
Methods summary
public NFormContainer
# setDefaults( array|Traversable $values, boolean $erase = FALSE )

Fill-in with default values.

Fill-in with default values.

Parameters

$values
array|Traversable
values used to fill the form
$erase
boolean
erase other default values?

Returns

NFormContainer
provides a fluent interface
public NFormContainer
# setValues( array|Traversable $values, boolean $erase = FALSE )

Fill-in with values.

Fill-in with values.

Parameters

$values
array|Traversable
values used to fill the form
$erase
boolean
erase other controls?

Returns

NFormContainer
provides a fluent interface
public array
# getValues( )

Returns the values submitted by the form.

Returns the values submitted by the form.

Returns

array
public boolean
# isValid( )

Is form valid?

Is form valid?

Returns

boolean
public
# validate( )

Performs the server side validation.

Performs the server side validation.
public NFormContainer
# setCurrentGroup( NFormGroup $group = NULL )

Parameters

$group
NFormGroup

Returns

NFormContainer
provides a fluent interface
public
# addComponent( IComponent $component, string $name, string $insertBefore = NULL )

Adds the specified component to the IComponentContainer.

Adds the specified component to the IComponentContainer.

Parameters

$component
IComponent
$name
string
$insertBefore
string

Throws

InvalidStateException

Implementation of

IComponentContainer::addComponent
public ArrayIterator
# getControls( )

Iterates over all form controls.

Iterates over all form controls.

Returns

ArrayIterator
public NForm
# getForm( boolean $need = TRUE )

Returns form.

Returns form.

Parameters

$need
boolean
throw exception if form doesn't exist?

Returns

NForm
public NTextInput
# addText( string $name, string $label = NULL, integer $cols = NULL, integer $maxLength = NULL )

Adds single-line text input control to the form.

Adds single-line text input control to the form.

Parameters

$name
string
control name
$label
string
label
$cols
integer
width of the control
$maxLength
integer
maximum number of characters the user may enter

Returns

NTextInput
public NTextInput
# addPassword( string $name, string $label = NULL, integer $cols = NULL, integer $maxLength = NULL )

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

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

Parameters

$name
string
control name
$label
string
label
$cols
integer
width of the control
$maxLength
integer
maximum number of characters the user may enter

Returns

NTextInput
public NTextArea
# addTextArea( string $name, string $label = NULL, integer $cols = 40, integer $rows = 10 )

Adds multi-line text input control to the form.

Adds multi-line text input control to the form.

Parameters

$name
string
control name
$label
string
label
$cols
integer
width of the control
$rows
integer
height of the control in text lines

Returns

NTextArea
public NFileUpload
# addFile( string $name, string $label = NULL )

Adds control that allows the user to upload files.

Adds control that allows the user to upload files.

Parameters

$name
string
control name
$label
string
label

Returns

NFileUpload
public NHiddenField
# addHidden( string $name, mixed $default = NULL )

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

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

Parameters

$name
string
control name
$default
mixed
default value

Returns

NHiddenField
public NCheckbox
# addCheckbox( string $name, string $caption = NULL )

Adds check box control to the form.

Adds check box control to the form.

Parameters

$name
string
control name
$caption
string
caption

Returns

NCheckbox
public NRadioList
# addRadioList( string $name, string $label = NULL, array $items = NULL )

Adds set of radio button controls to the form.

Adds set of radio button controls to the form.

Parameters

$name
string
control name
$label
string
label
$items
array
options from which to choose

Returns

NRadioList
public NSelectBox
# addSelect( string $name, string $label = NULL, array $items = NULL, integer $size = NULL )

Adds select box control that allows single item selection.

Adds select box control that allows single item selection.

Parameters

$name
string
control name
$label
string
label
$items
array
items from which to choose
$size
integer
number of rows that should be visible

Returns

NSelectBox
public NMultiSelectBox
# addMultiSelect( string $name, string $label = NULL, array $items = NULL, integer $size = NULL )

Adds select box control that allows multiple item selection.

Adds select box control that allows multiple item selection.

Parameters

$name
string
control name
$label
string
label
$items
array
options from which to choose
$size
integer
number of rows that should be visible

Returns

NMultiSelectBox
public NSubmitButton
# addSubmit( string $name, string $caption = NULL )

Adds button used to submit form.

Adds button used to submit form.

Parameters

$name
string
control name
$caption
string
caption

Returns

NSubmitButton
public NButton
# addButton( string $name, string $caption )

Adds push buttons with no default behavior.

Adds push buttons with no default behavior.

Parameters

$name
string
control name
$caption
string
caption

Returns

NButton
public NImageButton
# addImage( string $name, string $src = NULL, string $alt = NULL )

Adds graphical button used to submit form.

Adds graphical button used to submit form.

Parameters

$name
string
control name
$src
string
URI of the image
$alt
string
alternate text for the image

Returns

NImageButton
public NFormContainer
# addContainer( string $name )

Adds naming container to the form.

Adds naming container to the form.

Parameters

$name
string
name

Returns

NFormContainer
final public
# offsetSet( string $name, IComponent $component )

Adds the component to the container.

Adds the component to the container.

Parameters

$name
string
component name
$component
IComponent

Implementation of

ArrayAccess::offsetSet
final public IComponent
# offsetGet( string $name )

Returns component specified by name. Throws exception if component doesn't exist.

Returns component specified by name. Throws exception if component doesn't exist.

Parameters

$name
string
component name

Returns

IComponent

Throws

InvalidArgumentException

Implementation of

ArrayAccess::offsetGet
final public boolean
# offsetExists( string $name )

Does component specified by name exists?

Does component specified by name exists?

Parameters

$name
string
component name

Returns

boolean

Implementation of

ArrayAccess::offsetExists
final public
# offsetUnset( string $name )

Removes component from the container.

Removes component from the container.

Parameters

$name
string
component name

Implementation of

ArrayAccess::offsetUnset
final public
# __clone( )

Prevents cloning.

Prevents cloning.
Methods inherited from NComponentContainer
createComponent(), getComponent(), getComponents(), removeComponent(), validateChildComponent()
Methods inherited from NComponent
__construct(), __wakeup(), attached(), detached(), getName(), getParent(), lookup(), lookupPath(), monitor(), setParent(), unmonitor(), validateParent()
Methods inherited from NObject
__call(), __callStatic(), __get(), __isset(), __set(), __unset(), extensionMethod(), getReflection()
Constants inherited from IComponent
NAME_SEPARATOR
Properties summary
public array $onValidate
#

of function(Form $sender); Occurs when the form is validated

of function(Form $sender); Occurs when the form is validated
protected NFormGroup $currentGroup
#
protected boolean $valid
#
Nette Framework 0.9.7 (for PHP 5.2) API documentation generated by ApiGen 2.3.0