Jelix 1.8.9

BuilderBase
in package

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)

Tags
subpackage

forms

Table of Contents

$_action  : string
the action selector.
$_actionParams  : array<string|int, mixed>
params for the action.
$_endt  : mixed
$_form  : jFormsBase
a form object.
$_name  : mixed
form name.
$options  : array<string|int, mixed>
__construct()  : mixed
endOfTag()  : mixed
getForm()  : mixed
getName()  : mixed
getOption()  : mixed
outputAllControls()  : mixed
displays all the form. outputMetaContent, outputHeader and outputFooters are also called.
outputAllControlsValues()  : mixed
displays all data of the form.
outputControl()  : mixed
displays the content corresponding of the given control.
outputControlLabel()  : mixed
displays the label corresponding of the given control.
outputControlRawValue()  : mixed
displays the raw value of the control (without the control).
outputControlValue()  : mixed
displays the value of the control (without the control).
outputFooter()  : mixed
output the footer content of the form.
outputHeader()  : mixed
output the header content of the form.
outputMetaContent()  : mixed
called during the meta content processing in templates This method should set things on the response, like adding css styles, javascript links etc.
setAction()  : mixed
setOptions()  : mixed
set options.
generateFormName()  : mixed
generates a name for the form.

Properties

$_action

the action selector.

protected string $_action
Tags

$_actionParams

params for the action.

protected array<string|int, mixed> $_actionParams = array()
Tags

$options

protected array<string|int, mixed> $options = array()

options for the builder

Tags

Methods

endOfTag()

public endOfTag() : mixed
Tags
Return values
mixed

getForm()

public getForm() : mixed
Tags
Return values
mixed

getName()

public getName() : mixed
Tags
Return values
mixed

getOption()

public getOption(string $name) : mixed
Parameters
$name : string

name of an option

Tags
Return values
mixed

the value of the option

outputAllControls()

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

public abstract outputAllControls() : mixed
Tags
since
1.1
Return values
mixed

outputAllControlsValues()

displays all data of the form.

public abstract outputAllControlsValues() : mixed
Tags
since
1.8
Return values
mixed

outputControl()

displays the content corresponding of the given control.

public abstract outputControl(jFormsControl $ctrl[, array<string|int, mixed> $attributes = array() ]) : mixed
Parameters
$ctrl : jFormsControl

the control to display

$attributes : array<string|int, mixed> = array()

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

Tags
Return values
mixed

outputControlLabel()

displays the label corresponding of the given control.

public abstract outputControlLabel(jFormsControl $ctrl[, mixed $format = '' ][, mixed $editMode = true ]) : mixed
Parameters
$ctrl : jFormsControl

the control to display

$format : mixed = ''
$editMode : mixed = true
Tags
Return values
mixed

outputControlRawValue()

displays the raw value of the control (without the control).

public abstract outputControlRawValue(jFormsControl $ctrl[, array<string|int, mixed> $attributes = array() ]) : mixed
Parameters
$ctrl : jFormsControl

the control to display

$attributes : array<string|int, mixed> = array()

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

Tags
Return values
mixed

outputControlValue()

displays the value of the control (without the control).

public abstract outputControlValue(jFormsControl $ctrl[, array<string|int, mixed> $attributes = array() ]) : mixed
Parameters
$ctrl : jFormsControl

the control to display

$attributes : array<string|int, mixed> = array()

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

Tags
Return values
mixed

outputFooter()

output the footer content of the form.

public abstract outputFooter() : mixed
Tags
Return values
mixed

outputHeader()

output the header content of the form.

public abstract outputHeader() : mixed
Tags
Return values
mixed

outputMetaContent()

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

public abstract outputMetaContent(jTpl $tpl) : mixed
Parameters
$tpl : jTpl

the template object

Tags
Return values
mixed

setAction()

public setAction(string $action, array<string|int, mixed> $actionParams) : mixed
Parameters
$action : string

action selector where form will be submit

$actionParams : array<string|int, mixed>

parameters for the action

Tags
Return values
mixed

setOptions()

set options.

public setOptions(array<string|int, mixed> $options) : mixed
Parameters
$options : array<string|int, mixed>

associative array

Tags
Return values
mixed

generateFormName()

generates a name for the form.

protected static generateFormName(mixed $sel) : mixed
Parameters
$sel : mixed
Tags
Return values
mixed

Search results