Class Form (namespace Nette\Forms)


Creates, validates and renders HTML forms.

Direct Known Sub-classes:

Public Method Summary
void
addError (string $message)
Adds error message to the list.
FormGroup
addGroup ([string $caption = 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
mixed
Returns form's action.
Html
Returns form's HTML element template.
string
Returns the encoding.
array
Returns validation errors.
Form
getForm ([$need = TRUE])
Returns self.
FormGroup
getGroup (string $name)
Returns the specified group.
array
Returns all defined groups.
string
Returns form's method.
IFormRenderer|NULL
Returns form renderer.
ITranslator|NULL
Returns translate adapter.
array
Returns the values submitted by the form.
bool
bool
Was form populated by setDefaults() or processHttpRequest() yet?
ISubmitterControl|FALSE
Tells if the form was submitted.
bool
isValid ()
Is form valid?
void
processHttpRequest ([IHttpRequest $httpRequest = NULL])
Detects form submission and loads HTTP values.
Form
__construct ([$name = NULL], [$parent = NULL])
Form constructor.
void
removeGroup (string|FormGroup $name)
Removes fieldset group from form.
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
Sets the submittor control.
void
setTranslator ([$translator = NULL])
Sets translate adapter.
void
setValues (array|Traversable $values, [bool $erase = FALSE])
Fill-in with values.
void
Performs the server side validation.
bool
Renders form to string.
Protected Method Summary
protected void
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
protected Session
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 70

operation name
string EQUAL ':equal'

line 58

operation name
string FILLED ':filled'

line 60

operation name
string FLOAT ':float'

line 75

operation name
string GET 'get'

line 87

method
string INTEGER ':integer'

line 73

operation name
string IS_IN ':equal'

line 59

operation name
string LENGTH ':length'

line 69

operation name
string MAX_FILE_SIZE ':fileSize'

line 79

operation name
string MAX_LENGTH ':maxLength'

line 68

operation name
string MIME_TYPE ':mimeType'

line 80

operation name
string MIN_LENGTH ':minLength'

line 67

operation name
string NUMERIC ':integer'

line 74

operation name
string POST 'post'

line 88

method
string PROTECTOR_ID '_token_'

line 95

protection token ID
string RANGE ':range'

line 76

operation name
string REGEXP ':regexp'

line 72

operation name
string SCRIPT 'Nette\Forms\InstantClientScript::javascript'

line 83

operation name
string SUBMITTED ':submitted'

line 64

operation name
string TRACKER_ID '_form_'

line 92

tracker ID
string URL ':url'

line 71

operation name
string VALID ':valid'

line 61

operation name
Variable Summary
array $onInvalidSubmit

line 101

of function(Form $sender); Occurs when the form is submitted and not validated
array $onSubmit

line 98

of function(Form $sender); Occurs when the form is submitted and successfully validated
protected mixed $submittedBy

line 104


Method Details

line 665

addError

public void addError (string $message)

Adds error message to the list.

Input
string $message error message
Output
void  

line 261

addGroup

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

Adds fieldset group to the form.

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

line 239

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 226

addTracker

public HiddenField addTracker (string $name)

Adds distinguishing mark.

Overridden in child classes as:

Input
string $name
Output
HiddenField  

line 155

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:

Input
IComponent $obj
Output
void  

line 699

cleanErrors

public void cleanErrors ()

Output
void  

line 191

getAction

public mixed getAction ()

Returns form's action.

Output
mixed URI

line 715

getElementPrototype

public Html getElementPrototype ()

Returns form's HTML element template.

Output
Html  

line 349

getEncoding

public string getEncoding ()

Returns the encoding.

Output
string  

line 679

getErrors

public array getErrors ()

Returns validation errors.

Output
array  

line 168

getForm

public Form getForm ([$need = TRUE])

Returns self.

Input
$need
Output
Form  

line 323

getGroup

public FormGroup getGroup (string $name)

Returns the specified group.

Input
string $name name
Output
FormGroup  

line 311

getGroups

public array getGroups ()

Returns all defined groups.

Output
array of FormGroup

line 800

getHttpRequest

protected IHttpRequest getHttpRequest ()

Output
IHttpRequest  

line 214

getMethod

public string getMethod ()

Returns form's method.

Output
string get | post

line 738

getRenderer

public IFormRenderer|NULL getRenderer ()

Returns form renderer.

Output
IFormRenderer|NULL  

line 810

getSession

protected Session getSession ()

Output
Session  

line 376

getTranslator

public ITranslator|NULL getTranslator ()

Returns translate adapter.

Output
ITranslator|NULL  

line 592

getValues

public array getValues ()

Returns the values submitted by the form.

Output
array  

line 689

hasErrors

public bool hasErrors ()

Output
bool  

line 537

isPopulated

public bool isPopulated ()

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

Output
bool  

line 391

isSubmitted

public ISubmitterControl|FALSE isSubmitted ()

Tells if the form was submitted.

Output
ISubmitterControl|FALSE submittor control

line 628

isValid

public bool isValid ()

Is form valid?

Output
bool  

line 504

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 419

processHttpRequest

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

Detects form submission and loads HTTP values.

Overridden in child classes as:

Input
IHttpRequest $httpRequest optional request object
Output
void  

line 135

__construct

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

Form constructor.

Overridden in child classes as:

Input
$name
$parent
Output
Form  

line 285

removeGroup

public void removeGroup (string|FormGroup $name)

Removes fieldset group from form.

Input
string|FormGroup $name
Output
void  

line 752

render

public void render ()

Renders form.

Output
void  

line 180

setAction

public void setAction (mixed $url)

Sets form's action.

Input
mixed $url URI
Output
void  

line 490

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 335

setEncoding

public void setEncoding (string $value)

Set the encoding for the values.

Input
string $value
Output
void  

line 203

setMethod

public void setMethod (string $method)

Sets form's method.

Input
string $method get | post
Output
void  

line 727

setRenderer

public void setRenderer (IFormRenderer $renderer)

Sets form renderer.

Input
IFormRenderer $renderer
Output
void  

line 407

setSubmittedBy

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

Sets the submittor control.

Input
ISubmitterControl $by
Output
void  

line 365

setTranslator

public void setTranslator ([$translator = NULL])

Sets translate adapter.

Input
$translator
Output
void  

line 550

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 456

submit

protected void submit ()

Fires submit/click events.

Output
void  

line 642

validate

public void validate ()

Performs the server side validation.

Output
void  

line 772

__toString

public bool __toString ()

Renders form to string.

Output
bool can throw exceptions? (hidden parameter)