Jelix 1.6
Back to top  

HtmlBuilder

Extends \jelix\forms\Builder\BuilderBase

Main HTML form builder

a builder form class is a class which help to generate a form for the output (html form for example)

package

jelix

Methods

__construct

__construct(\jFormsBase $form)
inherited

Arguments

$form

\jFormsBase

a form object

_outputAttr

_outputAttr( &$attributes)

Arguments

$attributes

endOfTag

endOfTag()
inherited

escJsStr

escJsStr( $str)

Arguments

$str

generates a name for the form

generateFormName( $sel)
inherited static

Arguments

$sel

getForm

getForm()
inherited

getjFormsJsVarName

getjFormsJsVarName()

getName

getName()
inherited

getOption

getOption(string $name) : mixed
inherited

Arguments

$name

string

name of an option

Response

mixed

the value of the option

getWidget

getWidget(\jFormsControl $ctrl, \jelix\forms\HtmlWidget\ParentWidgetInterface|null $parentWidget = null) : \jelix\forms\HtmlWidget\WidgetBase
Throws
\Exception

Arguments

$ctrl

\jFormsControl

$parentWidget

\jelix\forms\HtmlWidget\ParentWidgetInterface|null

Response

\jelix\forms\HtmlWidget\WidgetBase

displays all the form. outputMetaContent, outputHeader and outputFooters are also called

outputAllControls()
inherited abstract
since 1.1

displays the content corresponding of the given control

outputControl(\jFormsControl $ctrl, array $attributes = array())
inherited abstract

Arguments

$ctrl

\jFormsControl

the control to display

$attributes

array

attribute to add on the generated code (html attributes for example)

outputControlHelp

outputControlHelp(\jFormsControl $ctrl)
since 1.6.17
Throws
\Exception

Arguments

$ctrl

\jFormsControl

displays the label corresponding of the given control

outputControlLabel(\jFormsControl $ctrl,  $format = '',  $editMode = true)
inherited abstract

Arguments

$ctrl

\jFormsControl

the control to display

$format

$editMode

displays the value of the control (without the control)

outputControlValue(\jFormsControl $ctrl, array $attributes = array())
inherited abstract

Arguments

$ctrl

\jFormsControl

the control to display

$attributes

array

attribute to add on the generated code (html attributes for example)

outputErrors

outputErrors()

output the footer content of the form

outputFooter()
inherited abstract

output the header content of the form

outputHeader()
inherited abstract

called during the meta content processing in templates This method should set things on the response, like adding css styles, javascript links etc.

outputMetaContent(\jTpl $tpl)
inherited abstract

Arguments

$tpl

\jTpl

the template object

setAction

setAction(string $action, array $actionParams)
inherited

Arguments

$action

string

action selector where form will be submit

$actionParams

array

parameters for the action

set options

setOptions(array $options)
inherited

Arguments

$options

array

associative array

Properties

formType

formType :

Type(s)

formConfig

formConfig :

Type(s)

jFormsJsVarName

jFormsJsVarName :

Type(s)

define default plugins for each formwidget

defaultPluginsConf : array
var

define default plugins for each formwidget

Type(s)

array

define plugins for each formwidget for the current builder

pluginsConf : array
var

define plugins for each formwidget for the current builder

Type(s)

array

list of default html attributes to set on the form element

htmlFormAttributes : array
var

list of default html attributes to set on the form element

Type(s)

array

list of attributes for each type of widgets. Keys are widgets type.

htmlWidgetsAttributes : array
var

list of attributes for each type of widgets. Keys are widgets type.

Type(s)

array

rootWidget

rootWidget : \jelix\forms\HtmlWidget\RootWidget
var

Type(s)

\jelix\forms\HtmlWidget\RootWidget

widgets

widgets :

Type(s)

a form object

_form : \jFormsBase
inherited
var

Type(s)

\jFormsBase

the action selector

_action : string
inherited
var

Type(s)

string

params for the action

_actionParams : array
inherited
var

Type(s)

array

form name

_name :
inherited

Type(s)

options for the builder

options : array
inherited
var

options for the builder

Type(s)

array

_endt

_endt :
inherited

Type(s)