Class FormControl

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

Object

Component implements IComponent

FormControl implements IFormControl

Direct known subclasses

Button, Checkbox, HiddenField, RadioList, SelectBox, TextBase, UploadControl

Indirect known subclasses

ImageButton, MultiSelectBox, SubmitButton, TextArea, TextInput

Abstract
Package: Nette\Forms\Controls
Author: David Grudl
Located at Forms/Controls/BaseControl.php

Methods summary
`public`	# `__construct( string $caption = NULL )` Parameters `$caption` `string` caption Overrides `Component::__construct()`
`protected`	# `attached( IComponent $form )` This method will be called when the component becomes attached to Form. This method will be called when the component becomes attached to Form. Parameters `$form` `IComponent` Overrides `Component::attached()`
`public Form`	# `getForm( boolean $need = TRUE )` Returns form. Returns form. Parameters `$need` `boolean` throw exception if form doesn't exist? Returns `Form`
`public`	# `loadHttpData( )` Loads HTTP data. Loads HTTP data. Implementation of `IFormControl::loadHttpData()`
`public string`	# `getHtmlName( )` Returns HTML name of control. Returns HTML name of control. Returns `string`
`public FormControl`	# `setValue( mixed $value )` Sets control's value. Sets control's value. Parameters `$value` `mixed` Returns `FormControl` Implementation of `IFormControl::setValue()`
`public mixed`	# `getValue( )` Returns control's value. Returns control's value. Returns `mixed` Implementation of `IFormControl::getValue()`
`public boolean`	# `isFilled( )` Is control filled? Is control filled? Returns `boolean`
`public FormControl`	# `setDefaultValue( $value )` Sets control's default value. Sets control's default value. Returns `FormControl`
`public FormControl`	# `setDisabled( boolean $value = TRUE )` Disables or enables control. Disables or enables control. Parameters `$value` `boolean` Returns `FormControl`
`public boolean`	# `isDisabled( )` Is control disabled? Is control disabled? Returns `boolean` Implementation of `IFormControl::isDisabled()`
`public Html`	# `getControl( )` Generates control's HTML element. Generates control's HTML element. Returns `Html`
`public Html`	# `getLabel( string $caption = NULL )` Generates label's HTML element. Generates label's HTML element. Parameters `$caption` `string` Returns `Html`
`public Html`	# `getControlPrototype( )` Returns control's HTML element template. Returns control's HTML element template. Returns `Html`
`public Html`	# `getLabelPrototype( )` Returns label's HTML element template. Returns label's HTML element template. Returns `Html`
`public FormControl`	# `setHtmlId( string $id )` Changes control's HTML id. Changes control's HTML id. Parameters `$id` `string` new ID, or FALSE or NULL Returns `FormControl`
`public string`	# `getHtmlId( )` Returns control's HTML id. Returns control's HTML id. Returns `string`
`public FormControl`	# `setAttribute( string $name, mixed $value = TRUE )` Changes control's HTML attribute. Changes control's HTML attribute. Parameters `$name` `string` name `$value` `mixed` value Returns `FormControl`
`public FormControl`	# `setTranslator( ITranslator $translator = NULL )` Sets translate adapter. Sets translate adapter. Returns `FormControl`
`public ITranslator\|null`	# `getTranslator( )` Returns translate adapter. Returns translate adapter. Returns `ITranslator\|null`
`public string`	# `translate( string $s, integer $count = NULL )` Returns translated string. Returns translated string. Parameters `$s` `string` `$count` `integer` plural count Returns `string` Implementation of `IFormControl::translate()`
`public FormControl`	# `addRule( mixed $operation, string $message = NULL, mixed $arg = NULL )` Adds a validation rule. Adds a validation rule. Parameters `$operation` `mixed` rule type `$message` `string` message to display for invalid data `$arg` `mixed` optional rule arguments Returns `FormControl`
`public Rules`	# `addCondition( mixed $operation, mixed $value = NULL )` Adds a validation condition a returns new branch. Adds a validation condition a returns new branch. Parameters `$operation` `mixed` condition type `$value` `mixed` optional condition arguments Returns `Rules` new branch
`public Rules`	# `addConditionOn( IFormControl $control, mixed $operation, mixed $value = NULL )` Adds a validation condition based on another control a returns new branch. Adds a validation condition based on another control a returns new branch. Parameters `$control` `IFormControl` form control `$operation` `mixed` condition type `$value` `mixed` optional condition arguments Returns `Rules` new branch
`public Rules`	# `getRules( )` Returns `Rules` Implementation of `IFormControl::getRules()`
`public FormControl`	# `setRequired( string $message = NULL )` Makes control mandatory. Makes control mandatory. Parameters `$message` `string` error message Returns `FormControl`
`public boolean`	# `isRequired( )` Is control mandatory? Is control mandatory? Returns `boolean`
`public`	# `addError( string $message )` Adds error message to the list. Adds error message to the list. Parameters `$message` `string` error message
`public array`	# `getErrors( )` Returns errors corresponding to control. Returns errors corresponding to control. Returns `array` Implementation of `IFormControl::getErrors()`
`public boolean`	# `hasErrors( )` Returns `boolean`
`public`	# `cleanErrors( )`
`protected static array`	# `exportRules( $rules )` Returns `array`
`public FormControl`	# `setOption( $key, $value )` Sets user-specific option. Options recognized by DefaultFormRenderer 'description' - textual or Html object description Sets user-specific option. Options recognized by DefaultFormRenderer 'description' - textual or Html object description Returns `FormControl`
`public mixed`	# `getOption( $key, $default = NULL )` Returns user-specific option. Returns user-specific option. Returns `mixed`
`public array`	# `getOptions( )` Returns user-specific options. Returns user-specific options. Returns `array`

Methods inherited from Component
`__clone(), __sleep(), __wakeup(), detached(), getName(), getParent(), lookup(), lookupPath(), monitor(), unmonitor(), validateParent()`

Methods inherited from Object
`__call(), __callStatic(), __get(), __isset(), __set(), __unset(), extensionMethod(), getReflection()`

Methods inherited from IComponent
`setParent()`

Constants inherited from IComponent
`NAME_SEPARATOR`

Properties summary
`public static string`	`$idMask`	`'frm%s-%s'`	#
`public string`	`$caption`		# textual caption or label textual caption or label
`protected mixed`	`$value`		# unfiltered control value unfiltered control value
`protected Html`	`$control`		# control element template control element template
`protected Html`	`$label`		# label element template label element template

Magic properties summary
`public string`	`$htmlId`	#
`public ITranslator\|null`	`$translator`	#
`public mixed`	`$value`	#
`public boolean`	`$disabled`	#
`public boolean`	`$required`	#
`public read-only Form`	`$form`	#
`public read-only string`	`$htmlName`	#
`public read-only array`	`$options`	#
`public read-only boolean`	`$filled`	#
`public read-only Html`	`$control`	#
`public read-only Html`	`$label`	#
`public read-only Html`	`$controlPrototype`	#
`public read-only Html`	`$labelPrototype`	#
`public read-only Rules`	`$rules`	#
`public read-only array`	`$errors`	#
`public write-only`	`$defaultValue`	#

Magic properties inherited from Component
`$name, $parent`

Magic properties inherited from Object
`$reflection`

Packages

Classes

Class FormControl

Direct known subclasses

Indirect known subclasses

Parameters

Overrides

Parameters

Overrides

Parameters

Returns

Implementation of

Returns

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Returns

Parameters

Returns

Returns

Implementation of

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Implementation of

Parameters

Returns

Returns

Parameters

Returns

Implementation of

Returns

Returns

Returns

Returns

Returns