Class FormControl (namespace Nette\Forms)


Base class that implements the basic functionality common to form controls.

Object
   |
   --Component
      |
      --FormControl

Implements interfaces:

Author: David Grudl
Copyright: Copyright (c) 2004, 2009 David Grudl
Abstract:
Located: in /Forms/Controls/FormControl.php (line 51)
Public Method Summary
FormControl
__construct ([string $caption = NULL])
Rules
addCondition (mixed $operation, [mixed $value = NULL])
Adds a validation condition a returns new branch.
Rules
addConditionOn (IFormControl $control, mixed $operation, [mixed $value = NULL])
Adds a validation condition based on another control a returns new branch.
void
addError (string $message)
Adds error message to the list.
FormControl
addRule (mixed $operation, [string $message = NULL], [mixed $arg = NULL])
Adds a validation rule.
void
Html
Generates control's HTML element.
Html
Returns control's HTML element template.
array
Returns errors corresponding to control.
Form
getForm ([bool $need = TRUE])
Returns form.
string
Returns control's HTML id.
string
Returns name of control within a Form & INamingContainer scope.
Html
Generates label's HTML element.
Html
Returns label's HTML element template.
mixed
getOption (string $key, [mixed $default = NULL])
Returns user-specific option.
array
Returns user-specific options.
Rules
ITranslator|NULL
Returns translate adapter.
mixed
Returns control's value.
bool
bool
Is control disabled?
bool
Does method getControl() have been called?
bool
Is control mandatory?
void
loadHttpData (array $data)
Loads HTTP data.
void
notifyRule (Rule $rule)
New rule or condition notification callback.
FormControl
setDisabled ([bool $value = TRUE])
Disables or enables control.
void
setHtmlId (string $id)
Changes control's HTML id.
FormControl
setOption (string $key, mixed $value)
Sets user-specific option.
void
setParent ([$parent = NULL], [string $name = NULL])
Overloaded parent setter. This method checks for invalid control name.
FormControl
setRendered ([bool $value = TRUE])
Sets 'rendered' indicator.
FormControl
setRequired ([string $message = NULL])
Makes control mandatory.
void
setTranslator ([$translator = NULL])
Sets translate adapter.
void
setValue (mixed $value)
Sets control's value.
string
translate (string $s)
Returns translated string.
static bool
validateEqual (IFormControl $control, mixed $arg)
Equal validator: are control's value and second parameter equal?
static bool
Filled validator: is control filled?
static bool
Valid validator: is control valid?
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()
Variable Summary
string $caption

line 57

textual caption or label
protected Html $control

line 63

control element template
static string $idMask 'frm%s-%s'

line 54

protected Html $label

line 66

label element template
protected mixed $value

line 60

unfiltered control value

Method Details

line 94

__construct

public FormControl __construct ([string $caption = NULL])

Input
string $caption caption
Output
FormControl  

line 452

addCondition

public Rules addCondition (mixed $operation, [mixed $value = NULL])

Adds a validation condition a returns new branch.

Input
mixed $operation condition type
mixed $value optional condition arguments
Output
Rules new branch

line 466

addConditionOn

public Rules addConditionOn (IFormControl $control, mixed $operation, [mixed $value = NULL])

Adds a validation condition based on another control a returns new branch.

Input
IFormControl $control form control
mixed $operation condition type
mixed $value optional condition arguments
Output
Rules new branch

line 578

addError

public void addError (string $message)

Adds error message to the list.

Input
string $message error message
Output
void  

line 438

addRule

public FormControl addRule (mixed $operation, [string $message = NULL], [mixed $arg = NULL])

Adds a validation rule.

Input
mixed $operation rule type
string $message message to display for invalid data
mixed $arg optional rule arguments
Output
FormControl provides a fluent interface

line 612

cleanErrors

public void cleanErrors ()

Output
void  

line 349

getControl

public Html getControl ()

Generates control's HTML element.

Output
Html  

line 383

getControlPrototype

public Html getControlPrototype ()

Returns control's HTML element template.

Output
Html  

line 592

getErrors

public array getErrors ()

Returns errors corresponding to control.

Implementation of:

Output
array  

line 126

getForm

public Form getForm ([bool $need = TRUE])

Returns form.

Input
bool $need throw exception if form doesn't exist?
Output
Form  

line 171

getHtmlId

public string getHtmlId ()

Returns control's HTML id.

Output
string  

line 137

getHtmlName

public string getHtmlName ()

Returns name of control within a Form & INamingContainer scope.

Overridden in child classes as:

Output
string  

line 365

getLabel

public Html getLabel ()

Generates label's HTML element.

Output
Html  

line 394

getLabelPrototype

public Html getLabelPrototype ()

Returns label's HTML element template.

Output
Html  

line 216

getOption

public mixed getOption (string $key, [mixed $default = NULL])

Returns user-specific option.

Input
string $key key
mixed $default default value
Output
mixed  

line 227

getOptions

public array getOptions ()

Returns user-specific options.

Output
array  

line 476

getRules

public Rules getRules ()

Implementation of:

Output
Rules  

line 254

getTranslator

public ITranslator|NULL getTranslator ()

Returns translate adapter.

Output
ITranslator|NULL  

line 297

getValue

public mixed getValue ()

Returns control's value.

Implementation of:

Output
mixed  

line 602

hasErrors

public bool hasErrors ()

Output
bool  

line 334

isDisabled

public bool isDisabled ()

Is control disabled?

Implementation of:

Output
bool  

line 420

isRendered

public bool isRendered ()

Does method getControl() have been called?

Output
bool  
Tags
Deprecated

line 502

isRequired

public bool isRequired ()

Is control mandatory?

Output
bool  
Tags
Deprecated

line 309

loadHttpData

public void loadHttpData (array $data)

Loads HTTP data.

Implementation of:

Input
array $data
Output
void  

line 514

notifyRule

public void notifyRule (Rule $rule)

New rule or condition notification callback.

Overridden in child classes as:

Input
Rule $rule
Output
void  

line 322

setDisabled

public FormControl setDisabled ([bool $value = TRUE])

Disables or enables control.

Input
bool $value
Output
FormControl provides a fluent interface

line 160

setHtmlId

public void setHtmlId (string $id)

Changes control's HTML id.

Input
string $id new ID, or FALSE or NULL
Output
void  

line 197

setOption

public FormControl setOption (string $key, mixed $value)

Sets user-specific option.

Common options:

  • 'rendered' - indicate if method getControl() have been called
  • 'required' - indicate if ':required' rule has been applied
  • 'description' - textual or Html object description (recognized by ConventionalRenderer)

Input
string $key key
mixed $value value
Output
FormControl provides a fluent interface

line 111

setParent

public void setParent ([$parent = NULL], [string $name = NULL])

Overloaded parent setter. This method checks for invalid control name.

Input
$parent
string $name
Output
void  

line 407

setRendered

public FormControl setRendered ([bool $value = TRUE])

Sets 'rendered' indicator.

Input
bool $value
Output
FormControl provides a fluent interface
Tags
Deprecated

line 489

setRequired

public FormControl setRequired ([string $message = NULL])

Makes control mandatory.

Input
string $message error message
Output
FormControl provides a fluent interface
Tags
Deprecated

line 243

setTranslator

public void setTranslator ([$translator = NULL])

Sets translate adapter.

Input
$translator
Output
void  

line 286

setValue

public void setValue (mixed $value)

Sets control's value.

Implementation of:

Input
mixed $value
Output
void  

line 269

translate

public string translate (string $s)

Returns translated string.

Implementation of:

Input
string $s
Output
string  

line 533

validateEqual

public static bool validateEqual (IFormControl $control, mixed $arg)

Equal validator: are control's value and second parameter equal?

Input
IFormControl $control
mixed $arg
Output
bool  

line 554

validateFilled

public static bool validateFilled (IFormControl $control)

Filled validator: is control filled?

Input
IFormControl $control
Output
bool  

line 566

validateValid

public static bool validateValid (IFormControl $control)

Valid validator: is control valid?

Input
IFormControl $control
Output
bool