Class Form (namespace Nette\Forms)

Creates, validates and renders HTML forms.

Object
   |
   --Component
      |
      --ComponentContainer
         |
         --FormContainer
            |
            --Form

Direct Known Sub-classes:

AppForm

Public Method Summary
void	addError (string `$message`) Adds error message to the list.
FormGroup	addGroup ([string `$label` = `NULL`], [bool `$setAsCurrent` = `TRUE`]) Adds fieldset group to the form.
void	addProtection ([string `$message` = `NULL`], [int `$timeout` = `NULL`]) Cross-Site Request Forgery (CSRF) form protection.
HiddenField	addTracker (string `$name`) Adds distinguishing mark.
void	cleanErrors ()
Form	__construct ([`$name` = `NULL`], [`$parent` = `NULL`]) Form constructor.
mixed	getAction () Returns form's action.
Html	getElementPrototype () Returns form's HTML element template.
string	getEncoding () Returns the encoding.
array	getErrors () Returns validation errors.
Form	getForm ([`$need` = `TRUE`]) Returns self.
FormGroup	getGroup (string `$name`) Returns the specified group.
array	getGroups () Returns all defined groups.
string	getMethod () Returns form's method.
IFormRenderer\|NULL	getRenderer () Returns form renderer.
ITranslator\|NULL	getTranslator () Returns translate adapter.
array	getValues () Returns the values submitted by the form.
bool	hasErrors ()
bool	isPopulated () Was form populated by setDefaults() or processHttpRequest() yet?
ISubmitterControl\|FALSE	isSubmitted () Tells if the form was submitted.
bool	isValid () Is form valid?
void	processHttpRequest ([IHttpRequest `$httpRequest` = `NULL`]) Detects form submission and loads HTTP values.
void	render () Renders form.
void	setAction (mixed `$url`) Sets form's action.
void	setDefaults (array\|Traversable `$values`, [bool `$erase` = `FALSE`]) Fill-in with default values.
void	setEncoding (string `$value`) Set the encoding for the values.
void	setMethod (string `$method`) Sets form's method.
void	setRenderer (IFormRenderer `$renderer`) Sets form renderer.
void	setSubmittedBy ([ISubmitterControl `$by` = `NULL`]) Sets the submittor control.
void	setTranslator ([`$translator` = `NULL`]) Sets translate adapter.
void	setValues (array\|Traversable `$values`, [bool `$erase` = `FALSE`]) Fill-in with values.
void	validate () Performs the server side validation.
bool	__toString () Renders form to string.

Protected Method Summary
protected void	attached (IComponent `$obj`) This method will be called when the component (or component's parent) becomes attached to a monitored object. Do not call this method yourself.
protected IHttpRequest	getHttpRequest ()
protected Session	getSession ()
protected void	loadHttpData (`$data`) Fill-in the form with HTTP data. Doesn't check if form was submitted.
protected void	submit () Fires submit/click events.

Methods Inherited From FormContainer
addButton(), addCheckbox(), addComponent(), addContainer(), addFile(), addHidden(), addImage(), addMultiSelect(), addPassword(), addRadioList(), addRepeater(), addSelect(), addSubmit(), addText(), addTextArea(), getControls(), getForm(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), setCurrentGroup()

Methods Inherited From ComponentContainer
addComponent(), createComponent(), getComponent(), getComponents(), removeComponent(), validateChildComponent(), __clone()

Methods Inherited From Component
__construct(), attached(), detached(), getName(), getParent(), getService(), getServiceLocator(), lookup(), lookupPath(), monitor(), setParent(), setServiceLocator(), validateParent(), __clone(), __wakeup()

Methods Inherited From Object
extensionMethod(), getClass(), getReflection(), __call(), __callStatic(), __get(), __isset(), __set(), __unset()

Constant Summary
string	`EMAIL`	`':email'`	line 57 operation name
string	`EQUAL`	`':equal'`	line 45 operation name
string	`FILLED`	`':filled'`	line 47 operation name
string	`FLOAT`	`':float'`	line 62 operation name
string	`INTEGER`	`':integer'`	line 60 operation name
string	`IS_IN`	`':equal'`	line 46 operation name
string	`LENGTH`	`':length'`	line 56 operation name
string	`MAX_FILE_SIZE`	`':fileSize'`	line 66 operation name
string	`MAX_LENGTH`	`':maxLength'`	line 55 operation name
string	`MIME_TYPE`	`':mimeType'`	line 67 operation name
string	`MIN_LENGTH`	`':minLength'`	line 54 operation name
string	`NUMERIC`	`':integer'`	line 61 operation name
string	`PROTECTOR_ID`	`'_token_'`	line 77 protection token ID
string	`RANGE`	`':range'`	line 63 operation name
string	`REGEXP`	`':regexp'`	line 59 operation name
string	`SCRIPT`	`'Nette\Forms\InstantClientScript::javascript'`	line 70 operation name
string	`SUBMITTED`	`':submitted'`	line 51 operation name
string	`TRACKER_ID`	`'_form_'`	line 74 tracker ID
string	`URL`	`':url'`	line 58 operation name
string	`VALID`	`':valid'`	line 48 operation name

Variable Summary
array	`$onInvalidSubmit`	line 83 of event handlers; Occurs when the form is submitted and not validated; function(Form $sender)
array	`$onSubmit`	line 80 of event handlers; Occurs when the form is submitted and successfully validated; function(Form $sender)
protected mixed	`$submittedBy`	line 86

Method Details

line 617

addError

public void addError (string $message)

Adds error message to the list.

Input
string	`$message`	error message
Output
void

line 240

addGroup

public FormGroup addGroup ([string $label = NULL], [bool $setAsCurrent = TRUE])

Adds fieldset group to the form.

Input
string	`$label`	label
bool	`$setAsCurrent`	set this group as current
Output
FormGroup

line 218

addProtection

public void addProtection ([string $message = NULL], [int $timeout = NULL])

Cross-Site Request Forgery (CSRF) form protection.

Input
string	`$message`
int	`$timeout`
Output
void

line 205

addTracker

public HiddenField addTracker (string $name)

Adds distinguishing mark.

Input
string	`$name`
Output
HiddenField

line 134

attached

protected void attached (IComponent $obj)

This method will be called when the component (or component's parent) becomes attached to a monitored object. Do not call this method yourself.

Overridden in child classes as:

AppForm::attached()

Input
IComponent	`$obj`
Output
void

line 651

cleanErrors

public void cleanErrors ()

Output
void

line 117

__construct

public Form __construct ([$name = NULL], [$parent = NULL])

Form constructor.

Overridden in child classes as:

AppForm::__construct()

Input
	`$name`
	`$parent`
Output
Form

line 170

getAction

public mixed getAction ()

Returns form's action.

Output
mixed	URI

line 667

getElementPrototype

public Html getElementPrototype ()

Returns form's HTML element template.

Output
Html

line 301

getEncoding

public string getEncoding ()

Returns the encoding.

Output
string

line 631

getErrors

public array getErrors ()

Returns validation errors.

Output
array

line 147

getForm

public Form getForm ([$need = TRUE])

Returns self.

Input
	`$need`
Output
Form

line 275

getGroup

public FormGroup getGroup (string $name)

Returns the specified group.

Input
string	`$name`	name
Output
FormGroup

line 263

getGroups

public array getGroups ()

Returns all defined groups.

Output
array	of FormGroup

line 752

getHttpRequest

protected IHttpRequest getHttpRequest ()

Output
IHttpRequest

line 193

getMethod

public string getMethod ()

Returns form's method.

Output
string	get \| post

line 690

getRenderer

public IFormRenderer|NULL getRenderer ()

Returns form renderer.

Output
IFormRenderer\|NULL

line 762

getSession

protected Session getSession ()

Output
Session

line 328

getTranslator

public ITranslator|NULL getTranslator ()

Returns translate adapter.

Output
ITranslator\|NULL

line 544

getValues

public array getValues ()

Returns the values submitted by the form.

Output
array

line 641

hasErrors

public bool hasErrors ()

Output
bool

line 489

isPopulated

public bool isPopulated ()

Was form populated by setDefaults() or processHttpRequest() yet?

Output
bool

line 343

isSubmitted

public ISubmitterControl|FALSE isSubmitted ()

Tells if the form was submitted.

Output
ISubmitterControl\|FALSE	submittor control

line 580

isValid

public bool isValid ()

Is form valid?

Output
bool

line 456

loadHttpData

protected void loadHttpData ($data)

Fill-in the form with HTTP data. Doesn't check if form was submitted.

Input
	`$data`	user data
Output
void

line 371

processHttpRequest

public void processHttpRequest ([IHttpRequest $httpRequest = NULL])

Detects form submission and loads HTTP values.

Overridden in child classes as:

AppForm::processHttpRequest()

Input
IHttpRequest	`$httpRequest`	optional request object
Output
void

line 704

render

public void render ()

Renders form.

Output
void

line 159

setAction

public void setAction (mixed $url)

Sets form's action.

Input
mixed	`$url`	URI
Output
void

line 442

setDefaults

public void setDefaults (array|Traversable $values, [bool $erase = FALSE])

Fill-in with default values.

Input
array\|Traversable	`$values`	values used to fill the form
bool	`$erase`	erase other controls?
Output
void

line 287

setEncoding

public void setEncoding (string $value)

Set the encoding for the values.

Input
string	`$value`
Output
void

line 182

setMethod

public void setMethod (string $method)

Sets form's method.

Input
string	`$method`	get \| post
Output
void

line 679

setRenderer

public void setRenderer (IFormRenderer $renderer)

Sets form renderer.

Input
IFormRenderer	`$renderer`
Output
void

line 359

setSubmittedBy

public void setSubmittedBy ([ISubmitterControl $by = NULL])

Sets the submittor control.

Input
ISubmitterControl	`$by`
Output
void

line 317

setTranslator

public void setTranslator ([$translator = NULL])

Sets translate adapter.

Input
	`$translator`
Output
void

line 502

setValues

public void setValues (array|Traversable $values, [bool $erase = FALSE])

Fill-in with values.

Input
array\|Traversable	`$values`	values used to fill the form
bool	`$erase`	erase other controls?
Output
void

line 408

submit

protected void submit ()

Fires submit/click events.

Output
void

line 594

validate

public void validate ()

Performs the server side validation.

Output
void

line 724

__toString

public bool __toString ()

Renders form to string.

Output
bool	can throw exceptions? (hidden parameter)

Class Form (namespace Nette\Forms)

Direct Known Sub-classes:

addError

addGroup

addProtection

addTracker

attached

cleanErrors

__construct

getAction

getElementPrototype

getEncoding

getErrors

getForm

getGroup

getGroups

getHttpRequest

getMethod

getRenderer

getSession

getTranslator

getValues

hasErrors

isPopulated

isSubmitted

isValid

loadHttpData

processHttpRequest

render

setAction

setDefaults

setEncoding

setMethod

setRenderer

setSubmittedBy

setTranslator

setValues

submit

validate

__toString

Namespaces

Classes

Interfaces