BuilderBase

base class of all builder form classes generated by the jform compiler.

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

package	jelix
subpackage	forms

Methods

__construct

__construct(\jFormsBase $form)

Arguments

$form

\jFormsBase

a form object

endOfTag

endOfTag()

generates a name for the form

generateFormName( $sel)

static

Arguments

$sel

getForm

getForm()

getName

getName()

getOption

getOption(string $name) : mixed

Arguments

$name

string

name of an option

Response

mixed

the value of the option

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

outputAllControls()

abstract

since	1.1

displays the content corresponding of the given control

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

abstract

Arguments

$ctrl

\jFormsControl

the control to display

$attributes

array

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

displays the label corresponding of the given control

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

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())

abstract

Arguments

$ctrl

\jFormsControl

the control to display

$attributes

array

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

output the footer content of the form

outputFooter()

abstract

output the header content of the form

outputHeader()

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)

abstract

Arguments

$tpl

\jTpl

the template object

setAction

setAction(string $action, array $actionParams)

Arguments

$action

string

action selector where form will be submit

$actionParams

array

parameters for the action

set options

setOptions(array $options)

Arguments

$options

array

associative array

Properties

a form object

_form : \jFormsBase

var

Type(s)

\jFormsBase

the action selector

_action : string

var

Type(s)

string

params for the action

_actionParams : array

var

Type(s)

array

form name

_name :

Type(s)

options for the builder

options : array

var	options for the builder

Type(s)

array

_endt

_endt :