• Home
• Nette
• Forms
• Form

PHP Class Nette\Forms\Form

Show file Open project: nette/forms Class Usage Examples

Public Properties

Property	Type	Description
$httpRequest		used only by standalone form
$onError		function (Form $sender); Occurs when the form is submitted and is not valid
$onRender		function (Form $sender); Occurs before the form is rendered
$onSubmit		function (Form $sender); Occurs when the form is submitted
$onSuccess		function (Form $sender); Occurs when the form is submitted and successfully validated

Public Methods

Method	Description
__construct ( $name = NULL )	Form constructor.
__toString ( ) : string	Renders form to string.
addError ( $message ) : void	Adds global error message.
addGroup ( $caption = NULL, $setAsCurrent = TRUE ) : ControlGroup	Adds fieldset group to the form.
addProtection ( $message = NULL ) : CsrfProtection	Cross-Site Request Forgery (CSRF) form protection.
cleanErrors ( ) : void
fireEvents ( ) : void	Fires submit/click events.
fireRenderEvents ( ) : void	Must be called before form is rendered and render() is not used.
getAction ( ) : mixed	Returns form's action.
getElementPrototype ( ) : Nette\Utils\Html	Returns form's HTML element template.
getErrors ( ) : array	Returns global validation errors.
getForm ( $need = TRUE ) : self	Returns self.
getGroup ( $name ) : ControlGroup	Returns the specified group.
getGroups ( ) : ControlGroup[]	Returns all defined groups.
getHttpData ( $type = NULL, $htmlName = NULL ) : mixed	Returns submitted HTTP data.
getMethod ( ) : string	Returns form's method.
getOwnErrors ( ) : array	Returns form's validation errors.
getRenderer ( ) : Nette\Forms\IFormRenderer	Returns form renderer.
getToggles ( ) : array
getTranslator ( ) : Nette\Localization\ITranslator | null	Returns translate adapter.
hasErrors ( ) : boolean
isAnchored ( ) : boolean	Tells if the form is anchored.
isMethod ( $method ) : boolean	Checks if the request method is the given one.
isSubmitted ( ) : Nette\Forms\ISubmitterControl | FALSE	Tells if the form was submitted.
isSuccess ( ) : boolean	Tells if the form was submitted and successfully validated.
removeGroup ( $name ) : void	Removes fieldset group from form.
render ( $args ) : void	Renders form.
setAction ( $url ) : self	Sets form's action.
setMethod ( $method ) : self	Sets form's method.
setRenderer ( Nette\Forms\IFormRenderer $renderer = NULL ) : self	Sets form renderer.
setSubmittedBy ( Nette\Forms\ISubmitterControl $by = NULL ) : self	Sets the submittor control.
setTranslator ( Nette\Localization\ITranslator $translator = NULL ) : self	Sets translate adapter.
validate ( array $controls = NULL )	******************* validation ****************d*g*
validateMaxPostSize ( )

Protected Methods

Method	Description
attached ( $obj ) : 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.
beforeRender ( ) : void
receiveHttpData ( ) : array | null	Internal: returns submitted HTTP data or NULL when form was not submitted.
validateParent ( Nette\ComponentModel\IContainer $parent ) : void

Private Methods

Method	Description
getHttpRequest ( ) : Nette\Http\IRequest

Method Details

Property Details