WIKINDX API trunk

FORM_EXTENDED

Table of Contents

Functions

getFormAttribute()  : string
Get the form attribute string
formHeaderName()  : string
print form header with hidden action field and name and id fields
hidden()  : string
print hidden form input
hiddenNoJSNoId()  : string
print hidden form input without JavaScript action
textInput()  : string
text input type
checkbox()  : string
print checkbox
radioButton()  : string
print radio button
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
selectYesNoBox()  : string
create special select box that only provides yes (1) and no (0) as options (values)

Functions

getFormAttribute()

Get the form attribute string

getFormAttribute(string $formName) : string
Parameters
$formName : string
Return values
string

formHeaderName()

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

formHeaderName(string $action, string $name[, string $js = '' ][, bool $BT = TRUE ][, array<string|int, mixed> $hidden = [] ]) : string

js is for javascript functions

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

Default is ''

$BT : bool = TRUE

Default is TRUE

$hidden : array<string|int, mixed> = []

= []

Return values
string

hidden()

print hidden form input

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

Default is ''

Return values
string

hiddenNoJSNoId()

print hidden form input without JavaScript action

hiddenNoJSNoId(string $formName, string $name, mixed $value) : string
Parameters
$formName : string
$name : string
$value : mixed
Return values
string

textInput()

text input type

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

Default is FALSE

$size : int = 20

Default is 20

$maxLength : int = 255

Default is 255

$js : string = ''

Default is ''

Return values
string

checkbox()

print checkbox

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

Default is FALSE

$title : string = ''

Default is ''

$js : string = ''

Default is ''

Return values
string

radioButton()

print radio button

radioButton(string $formName, string $name[, mixed $value = FALSE ][, bool|string $checked = FALSE ][, string $js = '' ]) : string
Parameters
$formName : string
$name : string
$value : mixed = FALSE

Default is FALSE

$checked : bool|string = FALSE

Default is FALSE

$js : string = ''

Default is ''

Return values
string

selectFBoxValue()

create select boxes for HTML forms

selectFBoxValue(string $formName, string $name, array<string|int, mixed> $array[, int $size = 3 ][, int|bool $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
$formName : string
$name : string
$array : array<string|int, mixed>
$size : int = 3

Default is 3

$override : int|bool = FALSE

Default is FALSE

$js : string = ''

Default is ''

Return values
string

selectedBoxValue()

create select boxes for HTML forms

selectedBoxValue(string $formName, string $name, array<string|int, mixed> $array, string $select[, int $size = 3 ][, int|bool $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
$formName : string
$name : string
$array : array<string|int, mixed>
$select : string
$size : int = 3

Default is 3

$override : int|bool = FALSE

Default is FALSE

$js : string = ''

Default is ''

Return values
string

selectFBoxValueMultiple()

create select boxes for HTML forms

selectFBoxValueMultiple(string $formName, string $name, array<string|int, mixed> $array[, int $size = 3 ][, int|bool $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
$formName : string
$name : string
$array : array<string|int, mixed>
$size : int = 3

Default is 3

$override : int|bool = FALSE

Default is FALSE

$js : string = ''

Default is ''

Return values
string

selectedBoxValueMultiple()

create select boxes for HTML forms

selectedBoxValueMultiple(string $formName, string $name, array<string|int, mixed> $array, array<string|int, mixed> $values[, int $size = 3 ][, int|bool $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
$formName : string
$name : string
$array : array<string|int, mixed>
$values : array<string|int, mixed>
$size : int = 3

Default is 3

$override : int|bool = FALSE

Default is FALSE

$js : string = ''

Default is ''

Return values
string

selectYesNoBox()

create special select box that only provides yes (1) and no (0) as options (values)

selectYesNoBox(string $formName, string $name, string|null $select[, string $js = '' ]) : string

'selected value' is set SELECTED

Parameters
$formName : string
$name : string
$select : string|null
$js : string = ''

Default is ''

Return values
string 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results