Class FormControl (namespace Nette\Forms)

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

Object
   |
   --Component
      |
      --FormControl

Implements interfaces:

Direct Known Sub-classes:

Author: David Grudl
Copyright: Copyright (c) 2004, 2009 David Grudl
Abstract:
Located: in /Forms/Controls/FormControl.php (line 36)
Public Method Summary
FormControl
__construct (string $label)
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.
FormContainer
addRule (mixed $operation, [string $message = NULL], [mixed $arg = NULL])
Adds a validation rule.
void
cleanErrors ()
Html
getControl ()
Generates control's HTML element.
Html
getControlPrototype ()
Returns control's HTML element template.
array
getErrors ()
Returns errors corresponding to control.
Form
getForm ([bool $need = TRUE])
Returns form.
string
getHtmlId ()
Returns control's HTML id.
string
getHtmlName ()
Returns name of control within a Form & INamingContainer scope.
Html
getLabel ()
Generates label's HTML element.
Html
getLabelPrototype ()
Returns label's HTML element template.
mixed
getOption (string $key, [mixed $default = NULL])
Returns user-specific option.
array
getOptions ()
Returns user-specific options.
Rules
getRules ()
ITranslator|NULL
getTranslator ()
Returns translate adapter.
mixed
getValue ()
Returns control's value.
bool
hasErrors ()
bool
isDisabled ()
Is control disabled?
bool
isRendered ()
Does method getControl() have been called?
bool
isRequired ()
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
validateFilled (IFormControl $control)
Filled validator: is control filled?
static bool
validateValid (IFormControl $control)
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 42

textual caption or label
protected Html $control

line 48

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

line 39
protected Html $label

line 51

label element template
protected mixed $value

line 45

unfiltered control value
Method Details

line 79

__construct

public FormControl __construct (string $label)

Overridden in child classes as:

Input
string $label label
Output
FormControl  

line 438

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 452

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 564

addError

public void addError (string $message)

Adds error message to the list.

Input
string $message error message
Output
void  

line 424

addRule

public FormContainer 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
FormContainer provides a fluent interface

line 598

cleanErrors

public void cleanErrors ()

Output
void  

line 334

getControl

public Html getControl ()

Generates control's HTML element.

Overridden in child classes as:

Output
Html  

line 369

getControlPrototype

public Html getControlPrototype ()

Returns control's HTML element template.

Output
Html  

line 578

getErrors

public array getErrors ()

Returns errors corresponding to control.

Implementation of:

Output
array  

line 111

getForm

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

Returns form.

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

line 156

getHtmlId

public string getHtmlId ()

Returns control's HTML id.

Output
string  

line 122

getHtmlName

public string getHtmlName ()

Returns name of control within a Form & INamingContainer scope.

Output
string  

line 350

getLabel

public Html getLabel ()

Generates label's HTML element.

Overridden in child classes as:

Output
Html  

line 380

getLabelPrototype

public Html getLabelPrototype ()

Returns label's HTML element template.

Output
Html  

line 201

getOption

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

Returns user-specific option.

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

line 212

getOptions

public array getOptions ()

Returns user-specific options.

Output
array  

line 462

getRules

public Rules getRules ()

Implementation of:

Output
Rules  

line 239

getTranslator

public ITranslator|NULL getTranslator ()

Returns translate adapter.

Output
ITranslator|NULL  

line 282

getValue

public mixed getValue ()

Returns control's value.

Overridden in child classes as:

Implementation of:

Output
mixed  

line 588

hasErrors

public bool hasErrors ()

Output
bool  

line 319

isDisabled

public bool isDisabled ()

Is control disabled?

Implementation of:

Output
bool  

line 406

isRendered

public bool isRendered ()

Does method getControl() have been called?

Output
bool  
Tags
Deprecated

line 488

isRequired

public bool isRequired ()

Is control mandatory?

Output
bool  
Tags
Deprecated

line 294

loadHttpData

public void loadHttpData (array $data)

Loads HTTP data.

Overridden in child classes as:

Implementation of:

Input
array $data
Output
void  

line 500

notifyRule

public void notifyRule (Rule $rule)

New rule or condition notification callback.

Overridden in child classes as:

Input
Rule $rule
Output
void  

line 307

setDisabled

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

Disables or enables control.

Input
bool $value
Output
FormControl provides a fluent interface

line 145

setHtmlId

public void setHtmlId (string $id)

Changes control's HTML id.

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

line 182

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 96

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 393

setRendered

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

Sets 'rendered' indicator.

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

line 475

setRequired

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

Makes control mandatory.

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

line 228

setTranslator

public void setTranslator ([$translator = NULL])

Sets translate adapter.

Input
$translator
Output
void  

line 271

setValue

public void setValue (mixed $value)

Sets control's value.

Overridden in child classes as:

Implementation of:

Input
mixed $value
Output
void  

line 254

translate

public string translate (string $s)

Returns translated string.

Implementation of:

Input
string $s
Output
string  

line 519

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 540

validateFilled

public static bool validateFilled (IFormControl $control)

Filled validator: is control filled?

Overridden in child classes as:

Input
IFormControl $control
Output
bool  

line 552

validateValid

public static bool validateValid (IFormControl $control)

Valid validator: is control valid?

Input
IFormControl $control
Output
bool