WIKINDX API 6.4.9

FORM

Table of Contents

_inlineHtmlAttribute()  : string
Build a string for insertion of an HTML tag attribute.
formHeader()  : string
print form header with hidden action field
formHeaderVisibleAction()  : string
print form header with visible action field -- typically used for tinyMCE popups
formHeaderName()  : string
print form header with hidden action field and name and id fields
formEnd()  : string
end a form
formMultiHeader()  : string
print form header with hidden action field for multi-part upload forms
formSubmit()  : string
print form footer with submit field
closePopup()  : string
print form footer with close popup button
formSubmitButton()  : string
print form footer with submit button field
formReset()  : string
print form reset button
hidden()  : string
print hidden form input
hiddenNoJS()  : string
print hidden form input without JavaScript action
radioButton()  : string
print radio button
checkbox()  : string
print checkbox
selectFBox()  : string
create select boxes for HTML forms
selectedBox()  : string
create select boxes for HTML forms
selectFBoxValue()  : string
create select boxes for HTML forms
selectedBoxValue()  : string
create select boxes for HTML forms
selectFBoxValueMultiple()  : string
create select boxes for HTML forms
selectedBoxValueMultiple()  : string
create select boxes for HTML forms
passwordInput()  : string
password input type
textInput()  : string
text input type
colorInput()  : string
color input type
textareaInput()  : string
textarea input type
textareaInputmceNoEditor()  : string
textarea input type without MCE editor
textareaReadonly()  : string
textarea readonly
fileUpload()  : string
upload box
fileUploadMultiple()  : string
upload box for multiple files
dateInput()  : string
date input type
reduceLongText()  : string
reduce the size of long text (in select boxes usually) to keep web browser display tidy

Functions

_inlineHtmlAttribute()

Build a string for insertion of an HTML tag attribute.

_inlineHtmlAttribute([string $name = '' ][, string $value = '' ]) : string

Ensures that the attribute value is never empty (incorrect syntax)

Parameters
$name : string = ''
$value : string = ''

Default is ''

formHeader()

print form header with hidden action field

formHeader(string $action[, string $js = '' ]) : string

$js is for javascript functions

Parameters
$action : string
$js : string = ''

Default is ''

formHeaderVisibleAction()

print form header with visible action field -- typically used for tinyMCE popups

formHeaderVisibleAction(string $action, string $name[, string $js = '' ]) : string

$js is for javascript functions

Parameters
$action : string
$name : string
$js : string = ''

Default is ''

formHeaderName()

print form header with hidden action field and name and id fields

formHeaderName(string $action, string $name[, string $js = '' ]) : string

js is for javascript functions

Parameters
$action : string
$name : string
$js : string = ''

Default is ''

formEnd()

end a form

formEnd() : string

formMultiHeader()

print form header with hidden action field for multi-part upload forms

formMultiHeader(string $action[, string $js = '' ]) : string
Parameters
$action : string
$js : string = ''

Default is ''

formSubmit()

print form footer with submit field

formSubmit([string $value = FALSE ][, string $name = FALSE ][, string $js = '' ]) : string
Parameters
$value : string = FALSE

Default is FALSE

$name : string = FALSE

Default is FALSE

$js : string = ''

Default is ''

closePopup()

print form footer with close popup button

closePopup(mixed $value) : string
Parameters
$value : mixed

formSubmitButton()

print form footer with submit button field

formSubmitButton(string $value[, string $name = FALSE ][, string $js = '' ]) : string
Parameters
$value : string

Default is FALSE

$name : string = FALSE

Default is FALSE

$js : string = ''

Default is ''

formReset()

print form reset button

formReset(mixed $value[, string $js = '' ]) : string
Parameters
$value : mixed
$js : string = ''

Default is ''

hidden()

print hidden form input

hidden(string $name, string $value[, string $js = '' ]) : string
Parameters
$name : string
$value : string
$js : string = ''

Default is ''

hiddenNoJS()

print hidden form input without JavaScript action

hiddenNoJS(string $name, string $value) : string
Parameters
$name : string
$value : string

radioButton()

print radio button

radioButton(string $label, string $name[, string $value = FALSE ][, string $checked = FALSE ][, string $js = '' ]) : string
Parameters
$label : string
$name : string
$value : string = FALSE

Default is FALSE

$checked : string = FALSE

Default is FALSE

$js : string = ''

Default is ''

checkbox()

print checkbox

checkbox(string $label, string $name[, string $checked = FALSE ][, string $title = '' ][, string $js = '' ]) : string
Parameters
$label : string
$name : string
$checked : string = FALSE

Default is FALSE

$title : string = ''

Default is ''

$js : string = ''

Default is ''

selectFBox()

create select boxes for HTML forms

selectFBox(string $label, string $name, array<string|int, mixed> $array[, int $size = 3 ][, int $override = FALSE ][, string $js = '' ]) : string

First OPTION is always SELECTED optional $override allows the programmer to override the user set preferences for character limiting in select boxes

Parameters
$label : string
$name : string
$array : array<string|int, mixed>
$size : int = 3

Default is 3

$override : int = FALSE

Default is FALSE

$js : string = ''

Default is ''

selectedBox()

create select boxes for HTML forms

selectedBox(string $label, string $name, array<string|int, mixed> $array, string $select[, int $size = 3 ][, int $override = FALSE ][, string $js = '' ]) : string

'selected value' is set SELECTED optional $override allows the programmer to override the user set preferences for character limiting in select boxes

Parameters
$label : string
$name : string
$array : array<string|int, mixed>
$select : string
$size : int = 3

Default is 3

$override : int = FALSE

Default is FALSE

$js : string = ''

Default is ''

selectFBoxValue()

create select boxes for HTML forms

selectFBoxValue(string $label, string $name, array<string|int, mixed> $array[, int $size = 3 ][, int $override = FALSE ][, string $js = '' ]) : string

First entry is default selection. OPTION VALUE is set so expects assoc. array where key holds this value optional $override allows the programmer to override the user set preferences for character limiting in select boxes

Parameters
$label : string
$name : string
$array : array<string|int, mixed>
$size : int = 3

Default is 3

$override : int = FALSE

Default is FALSE

$js : string = ''

Default is ''

selectedBoxValue()

create select boxes for HTML forms

selectedBoxValue(string $label, string $name, array<string|int, mixed> $array, string $select[, int $size = 3 ][, int $override = FALSE ][, string $js = '' ]) : string

$select is default selection. OPTION VALUE is set so expects assoc. array where key holds this value optional $override allows the programmer to override the user set preferences for character limiting in select boxes

Parameters
$label : string
$name : string
$array : array<string|int, mixed>
$select : string
$size : int = 3

Default is 3

$override : int = FALSE

Default is FALSE

$js : string = ''

Default is ''

selectFBoxValueMultiple()

create select boxes for HTML forms

selectFBoxValueMultiple(string $label, string $name, array<string|int, mixed> $array[, int $size = 3 ][, int $override = FALSE ][, string $js = '' ]) : string

First entry is default selection. OPTION VALUE is set so expects assoc. array where key holds this value. MULTIPLE values may be selected optional $override allows the programmer to override the user set preferences for character limiting in select boxes

Parameters
$label : string
$name : string
$array : array<string|int, mixed>
$size : int = 3

Default is 3

$override : int = FALSE

Default is FALSE

$js : string = ''

Default is ''

selectedBoxValueMultiple()

create select boxes for HTML forms

selectedBoxValueMultiple(string $label, string $name, array<string|int, mixed> $array, array<string|int, mixed> $values[, int $size = 3 ][, int $override = FALSE ][, string $js = '' ]) : string

OPTION VALUE is set so expects assoc. array where key holds this value. MULTIPLE values may be selected optional $override allows the programmer to override the user set preferences for character limiting in select boxes

Parameters
$label : string
$name : string
$array : array<string|int, mixed>
$values : array<string|int, mixed>
$size : int = 3

Default is 3

$override : int = FALSE

Default is FALSE

$js : string = ''

Default is ''

passwordInput()

password input type

passwordInput(string $label, string $name[, string $value = FALSE ][, int $size = 20 ][, int $maxLength = 255 ][, string $js = '' ]) : string
Parameters
$label : string
$name : string
$value : string = FALSE

Default is FALSE

$size : int = 20

Default is 20

$maxLength : int = 255

Default is 255

$js : string = ''

Default is ''

textInput()

text input type

textInput(string $label, string $name[, string $value = FALSE ][, int $size = 20 ][, int $maxLength = 255 ][, string $js = '' ]) : string
Parameters
$label : string
$name : string
$value : string = FALSE

Default is FALSE

$size : int = 20

Default is 20

$maxLength : int = 255

Default is 255

$js : string = ''

Default is ''

colorInput()

color input type

colorInput(string $label, string $name[, string $value = FALSE ][, string $js = '' ]) : string
Parameters
$label : string
$name : string
$value : string = FALSE

Default is FALSE

$js : string = ''

Default is ''

textareaInput()

textarea input type

textareaInput(string $label, string $name[, string $value = FALSE ][, int $cols = 30 ][, int $rows = 5 ][, string $js = '' ]) : string
Parameters
$label : string
$name : string
$value : string = FALSE

Default is FALSE

$cols : int = 30

Default is 30

$rows : int = 5

Default is 5

$js : string = ''

Default is ''

textareaInputmceNoEditor()

textarea input type without MCE editor

textareaInputmceNoEditor(string $label, string $name[, string $value = FALSE ][, int $cols = 30 ][, int $rows = 5 ][, string $js = '' ]) : string
Parameters
$label : string
$name : string
$value : string = FALSE

Default is FALSE

$cols : int = 30

Default is 30

$rows : int = 5

Default is 5

$js : string = ''

Default is ''

textareaReadonly()

textarea readonly

textareaReadonly(string $label, string $name[, string $value = FALSE ][, int $cols = 30 ][, int $rows = 5 ][, string $js = '' ]) : string
Parameters
$label : string
$name : string
$value : string = FALSE

Default is FALSE

$cols : int = 30

Default is 30

$rows : int = 5

Default is 5

$js : string = ''

Default is ''

fileUpload()

upload box

fileUpload(string $label, string $name[, int $size = 20 ][, string $accept = "" ][, string $js = '' ]) : string
Parameters
$label : string
$name : string
$size : int = 20

Default is 20

$accept : string = ""

Default is "" (all file types)

$js : string = ''

Default is ''

fileUploadMultiple()

upload box for multiple files

fileUploadMultiple(string $label, array<string|int, mixed> $name[, int $size = 20 ][, string $accept = "" ][, string $js = '' ]) : string
Parameters
$label : string
$name : array<string|int, mixed>
$size : int = 20

Default is 20

$accept : string = ""

Default is "" (all file types)

$js : string = ''

Default is ''

dateInput()

date input type

dateInput(string $label, string $name[, string $value = FALSE ][, string $js = '' ]) : string
Parameters
$label : string
$name : string
$value : string = FALSE

Default is FALSE

$js : string = ''

Default is ''

reduceLongText()

reduce the size of long text (in select boxes usually) to keep web browser display tidy

reduceLongText(string $text[, string $override = FALSE ]) : string

optional $override allows the programmer to override the user set preferences

Parameters
$text : string
$override : string = FALSE

Default is FALSE

Search results