htmlJformsBuilder
extends jFormsBuilderHtml
in package
HTML form builder
Tags
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
- $isRootControl : mixed
- $jFormsJsVarName : mixed
- $jsContent : mixed
- $lastJsContent : mixed
- $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
- outputControl() : mixed
- displays the content corresponding of the given control
- outputControlLabel() : mixed
- displays the label corresponding of the given 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
- _outputAttr() : mixed
- _outputDateControlDay() : mixed
- _outputDateControlHour() : mixed
- _outputDateControlMinutes() : mixed
- _outputDateControlMonth() : mixed
- _outputDateControlSeconds() : mixed
- _outputDateControlYear() : mixed
- commonJs() : mixed
- echoCheckboxes() : mixed
- escJsStr() : mixed
- fillSelect() : mixed
- generateFormName() : mixed
- generates a name for the form
- jsButton() : mixed
- jsCaptcha() : mixed
- jsCheckbox() : mixed
- jsCheckboxes() : mixed
- jsChoice() : mixed
- jsChoiceInternal() : mixed
- jsDate() : mixed
- jsDatetime() : mixed
- jsGroup() : mixed
- jsHtmleditor() : mixed
- jsInput() : mixed
- jsListbox() : mixed
- jsMenulist() : mixed
- jsOutput() : mixed
- jsRadiobuttons() : mixed
- jsReset() : mixed
- jsSecret() : mixed
- jsSecretconfirm() : mixed
- jsSubmit() : mixed
- jsTextarea() : mixed
- jsTime() : mixed
- jsUpload() : mixed
- jsWikieditor() : mixed
- outputButton() : mixed
- outputCaptcha() : mixed
- outputCheckbox() : mixed
- outputCheckboxes() : mixed
- outputChoice() : mixed
- outputDate() : mixed
- outputDatetime() : mixed
- outputGroup() : mixed
- outputHeaderScript() : mixed
- outputHelp() : mixed
- outputHtmleditor() : mixed
- outputInput() : mixed
- outputListbox() : mixed
- outputMenulist() : mixed
- outputOutput() : mixed
- outputRadiobuttons() : mixed
- outputReset() : mixed
- outputSecret() : mixed
- outputSecretconfirm() : mixed
- outputSubmit() : mixed
- outputTextarea() : mixed
- outputTime() : mixed
- outputUpload() : mixed
- outputWikieditor() : mixed
- showRadioCheck() : mixed
Properties
$_action
the action selector
protected
string
$_action
$_actionParams
params for the action
protected
array<string|int, mixed>
$_actionParams
= array()
$_endt
protected
mixed
$_endt
= '/>'
$_form
a form object
protected
jFormsBase
$_form
$_name
form name
protected
mixed
$_name
$isRootControl
protected
mixed
$isRootControl
= rue
$jFormsJsVarName
protected
mixed
$jFormsJsVarName
= 'jFormsJQ'
$jsContent
protected
mixed
$jsContent
= ''
$lastJsContent
protected
mixed
$lastJsContent
= ''
$options
protected
array<string|int, mixed>
$options
= array()
options for the builder
Methods
__construct()
public
__construct(jFormsBase $form) : mixed
Parameters
- $form : jFormsBase
-
a form object
Return values
mixed —endOfTag()
public
endOfTag() : mixed
Return values
mixed —getForm()
public
getForm() : mixed
Return values
mixed —getName()
public
getName() : mixed
Return values
mixed —getOption()
public
getOption(string $name) : mixed
Parameters
- $name : string
-
name of an option
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
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)
Return values
mixed —outputControlLabel()
displays the label corresponding of the given control
public
abstract outputControlLabel(jFormsControl $ctrl[, mixed $editMode = true ]) : mixed
Parameters
- $ctrl : jFormsControl
-
the control to display
- $editMode : mixed = true
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)
Return values
mixed —outputFooter()
output the footer content of the form
public
abstract outputFooter() : mixed
Return values
mixed —outputHeader()
output the header content of the form
public
abstract outputHeader() : mixed
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
outputMetaContent(mixed $t) : mixed
Parameters
- $t : mixed
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
Return values
mixed —setOptions()
set options
public
setOptions(array<string|int, mixed> $options) : mixed
Parameters
- $options : array<string|int, mixed>
-
associative array
Return values
mixed —_outputAttr()
protected
_outputAttr(mixed &$attributes) : mixed
Parameters
- $attributes : mixed
Return values
mixed —_outputDateControlDay()
protected
_outputDateControlDay(mixed $ctrl, mixed $attr, mixed $value) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
- $value : mixed
Return values
mixed —_outputDateControlHour()
protected
_outputDateControlHour(mixed $ctrl, mixed $attr, mixed $value[, mixed $configParameter = 'controls.datetime.input' ]) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
- $value : mixed
- $configParameter : mixed = 'controls.datetime.input'
Return values
mixed —_outputDateControlMinutes()
protected
_outputDateControlMinutes(mixed $ctrl, mixed $attr, mixed $value[, mixed $configParameter = 'controls.datetime.input' ]) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
- $value : mixed
- $configParameter : mixed = 'controls.datetime.input'
Return values
mixed —_outputDateControlMonth()
protected
_outputDateControlMonth(mixed $ctrl, mixed $attr, mixed $value) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
- $value : mixed
Return values
mixed —_outputDateControlSeconds()
protected
_outputDateControlSeconds(mixed $ctrl, mixed $attr, mixed $value[, mixed $configParameter = 'controls.datetime.input' ]) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
- $value : mixed
- $configParameter : mixed = 'controls.datetime.input'
Return values
mixed —_outputDateControlYear()
protected
_outputDateControlYear(mixed $ctrl, mixed $attr, mixed $value) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
- $value : mixed
Return values
mixed —commonJs()
protected
commonJs(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —echoCheckboxes()
protected
echoCheckboxes(mixed $span, mixed $id, mixed &$values, mixed &$attr, mixed &$value, mixed &$i) : mixed
Parameters
- $span : mixed
- $id : mixed
- $values : mixed
- $attr : mixed
- $value : mixed
- $i : mixed
Return values
mixed —escJsStr()
protected
escJsStr(mixed $str) : mixed
Parameters
- $str : mixed
Return values
mixed —fillSelect()
protected
fillSelect(mixed $ctrl, mixed $value) : mixed
Parameters
- $ctrl : mixed
- $value : mixed
Return values
mixed —generateFormName()
generates a name for the form
protected
static generateFormName(mixed $sel) : mixed
Parameters
- $sel : mixed
Return values
mixed —jsButton()
protected
jsButton(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsCaptcha()
protected
jsCaptcha(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsCheckbox()
protected
jsCheckbox(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsCheckboxes()
protected
jsCheckboxes(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsChoice()
protected
jsChoice(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsChoiceInternal()
protected
jsChoiceInternal(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsDate()
protected
jsDate(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsDatetime()
protected
jsDatetime(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsGroup()
protected
jsGroup(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsHtmleditor()
protected
jsHtmleditor(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsInput()
protected
jsInput(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsListbox()
protected
jsListbox(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsMenulist()
protected
jsMenulist(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsOutput()
protected
jsOutput(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsRadiobuttons()
protected
jsRadiobuttons(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsReset()
protected
jsReset(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsSecret()
protected
jsSecret(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsSecretconfirm()
protected
jsSecretconfirm(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsSubmit()
protected
jsSubmit(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsTextarea()
protected
jsTextarea(mixed $ctrl[, mixed $withjsobj = true ]) : mixed
Parameters
- $ctrl : mixed
- $withjsobj : mixed = true
Return values
mixed —jsTime()
protected
jsTime(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsUpload()
protected
jsUpload(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —jsWikieditor()
protected
jsWikieditor(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —outputButton()
protected
outputButton(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputCaptcha()
protected
outputCaptcha(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputCheckbox()
protected
outputCheckbox(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputCheckboxes()
protected
outputCheckboxes(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputChoice()
protected
outputChoice(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputDate()
protected
outputDate(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputDatetime()
protected
outputDatetime(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputGroup()
protected
outputGroup(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputHeaderScript()
protected
outputHeaderScript() : mixed
Return values
mixed —outputHelp()
protected
outputHelp(mixed $ctrl) : mixed
Parameters
- $ctrl : mixed
Return values
mixed —outputHtmleditor()
protected
outputHtmleditor(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputInput()
protected
outputInput(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputListbox()
protected
outputListbox(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputMenulist()
protected
outputMenulist(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputOutput()
protected
outputOutput(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputRadiobuttons()
protected
outputRadiobuttons(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputReset()
protected
outputReset(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputSecret()
protected
outputSecret(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputSecretconfirm()
protected
outputSecretconfirm(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputSubmit()
protected
outputSubmit(mixed $ctrl, mixed $attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputTextarea()
protected
outputTextarea(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputTime()
protected
outputTime(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputUpload()
protected
outputUpload(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —outputWikieditor()
protected
outputWikieditor(mixed $ctrl, mixed &$attr) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
Return values
mixed —showRadioCheck()
protected
showRadioCheck(mixed $ctrl, mixed &$attr, mixed &$value, mixed $span) : mixed
Parameters
- $ctrl : mixed
- $attr : mixed
- $value : mixed
- $span : mixed