Docs For Class jFormsBuilderBase

Description

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)

abstract:

Located in /forms/jFormsBuilderBase.class.php (line 21)

Direct descendents

Class	Description
jFormsBuilderHtml	HTML form builder

Variable Summary

string $_action

array $_actionParams

mixed $_endt

jFormsBase $_form

mixed $_name

Method Summary

static void generateFormName ( $sel)

jFormsBuilderBase __construct (jFormsBase $form)

void getName ()

void outputAllControls ()

void outputControl (jFormsControl $ctrl, [array $attributes = array()])

void outputControlLabel (jFormsControl $ctrl)

void outputFooter ()

void outputHeader (array $params)

void outputMetaContent (jTpl $tpl)

void setAction (string $action, array $actionParams)

Variables

string $_action (line 32)

the action selector

access: protected

array $_actionParams = array() (line 38)

params for the action

access: protected

mixed $_endt = '/>' (line 45)

access: protected

jFormsBase $_form (line 26)

a form object

access: protected

mixed $_name (line 43)

form name

access: protected

Methods

static generateFormName (line 109)

generates a name for the form

access: protected

static void generateFormName ( $sel)

$sel

Constructor __construct (line 49)

access: public

jFormsBuilderBase __construct (jFormsBase $form)

jFormsBase $form: a form object

getName (line 66)

access: public

void getName ()

outputAllControls (line 91)

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

abstract:
since: 1.1
access: public

void outputAllControls ()

Redefined in descendants as:

jFormsBuilderHtml::outputAllControls()

outputControl (line 98)

displays the content corresponding of the given control

abstract:
access: public

void outputControl (jFormsControl $ctrl, [array $attributes = array()])

jFormsControl $ctrl: the control to display
array $attributes: attribute to add on the generated code (html attributes for example)

Redefined in descendants as:

jFormsBuilderHtml::outputControl()

outputControlLabel (line 104)

displays the label corresponding of the given control

abstract:
access: public

void outputControlLabel (jFormsControl $ctrl)

jFormsControl $ctrl: the control to display

Redefined in descendants as:

jFormsBuilderHtml::outputControlLabel()

outputFooter (line 85)

output the footer content of the form

abstract:
access: public

void outputFooter ()

Redefined in descendants as:

jFormsBuilderHtml::outputFooter()

outputHeader (line 80)

output the header content of the form

abstract:
access: public

void outputHeader (array $params)

array $params: some parameters, depending of the type of builder

Redefined in descendants as:

jFormsBuilderHtml::outputHeader() : output the header content of the form

outputMetaContent (line 74)

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

abstract:
access: public

void outputMetaContent (jTpl $tpl)

jTpl $tpl: the template object

Redefined in descendants as:

setAction (line 57)

access: public

void setAction (string $action, array $actionParams)

string $action: action selector where form will be submit
array $actionParams: parameters for the action