$_options
$_options : mixed||string|int
Options
A select box with timezones
$customValidationCode : mixed||string|int
Javascript performing additional validation of this element data
This property contains a list of Javascript snippets that will be sent to APIForm::renderValidationJS(). NB: All elements are added to the output one after the other, so don't forget to add a ";" after each to ensure no Javascript syntax error is generated.
$_hidden :
hidden?
None found |
__construct( caption, name, value = null, size = 1) :
Constructor
caption | ||
name | ||
value | Pre-selected value (or array of them). Legal values are "-12" to "12" with some ".5"s strewn in ;-) |
|
size | Number of rows. "1" makes a drop-down-box. |
None found |
None found |
None found |
getValue( encode = false) : mixed||string|int
Get an array of pre-selected values
encode | To sanitizer the text? |
None found |
None found |
addOption( value, name) :
Add an option
value | "value" attribute |
|
name | "name" attribute |
None found |
addOptionArray(mixed||string|int options) :
Add multiple options
mixed||string|int | options | Associative array of value->name pairs |
None found |
getOptions(bool|int encode = false) : mixed||string|int
Get an array with all the options
Note: both name and value should be sanitized. However for backward compatibility, only value is sanitized for now.
bool|int | encode | To sanitizer the text? potential values: 0 - skip; 1 - only for value; 2 - for both value and name |
Associative array of value->name pairs
None found |
render() :
Generates output for the element.
This method is abstract and must be overwritten by the child classes.
None found |
seealso |
APIForm::renderValidationJS |
---|
None found |
setName( name) :
set the "name" attribute for the element
name | "name" attribute for the element |
None found |
getName( encode = true) :
get the "name" attribute for the element
encode |
"name" attribute
None found |
setAccessKey( key) :
set the "accesskey" attribute for the element
key | "accesskey" attribute for the element |
None found |
getAccessKey() :
get the "accesskey" attribute for the element
"accesskey" attribute value
None found |
getAccessString( str) :
If the accesskey is found in the specified string, underlines it
str | String where to search the accesskey occurence |
Enhanced string with the 1st occurence of accesskey underlined
None found |
None found |
None found |
None found |
getCaption( encode = false) :
get the caption for the element
encode | To sanitizer the text? |
None found |
getTitle( encode = true) :
get the caption for the element
encode | To sanitizer the text? |
None found |
setDescription( description) :
set the element's description
description |
None found |
getDescription( encode = false) :
get the element's description
encode | To sanitizer the text? |
None found |
None found |
None found |
None found |
setExtra( extra, replace = false) : mixed||string|int
Add extra attributes to the element.
This string will be inserted verbatim and unvalidated in the element's tag. Know what you are doing!
extra | ||
replace | If true, passed string will replace current content otherwise it will be appended to it |
New content of the extra string
None found |
getExtra( encode = false) :
Get the extra attributes for the element
encode | To sanitizer the text? |
None found |
setNocolspan( nocolspan = true) :
Set the element's nocolspan Modified by Catzwolf
nocolspan |
None found |
None found |
None found |
setFormType( value) :
set the element's nocolspan Modified by Catzwolf
value |
None found |