XoopsFormText Class Reference

Inheritance diagram for XoopsFormText:

Collaboration diagram for XoopsFormText:

Public Member Functions
	__construct ($caption, $name, $size, $maxlength, $value='')
	getSize ()
	getMaxlength ()
	getValue ($encode=false)
	setValue ($value)
	render ()
Public Member Functions inherited from XoopsFormElement
	__construct ()
	isContainer ()
	setName ($name)
	getName ($encode=true)
	setAccessKey ($key)
	getAccessKey ()
	getAccessString ($str)
	setClass ($class)
	getClass ()
	setCaption ($caption)
	getCaption ($encode=false)
	getTitle ($encode=true)
	setDescription ($description)
	getDescription ($encode=false)
	setHidden ()
	isHidden ()
	isRequired ()
	setExtra ($extra, $replace=false)
	getExtra ($encode=false)
	setNocolspan ($nocolspan=true)
	getNocolspan ()
	getFormType ()
	setFormType ($value='')
	renderValidationJS ()
	render ()

Data Fields
	$_size
	$_maxlength
	$_value
Data Fields inherited from XoopsFormElement
	$customValidationCode = array()
	$_name
	$_caption
	$_accesskey = ''
	$_class = array()
	$_hidden = false
	$_extra = array()
	$_required = false
	$_description = ''
	$_nocolspan = false
	$_formtype = ''

Detailed Description

A simple text field

Constructor & Destructor Documentation

__construct()

__construct	(		$caption,
			$name,
			$size,
			$maxlength,
			$value = ''
	)

Constructor

Parameters

string	$caption	Caption
string	$name	"name" attribute
int	$size	Size
int	$maxlength	Maximum length of text
string	$value	Initial text

Here is the call graph for this function:

Member Function Documentation

getMaxlength()

getMaxlength

(

)

Get maximum text length

Returns

int

Here is the caller graph for this function:

getSize()

getSize

(

)

Get size

Returns

int

Here is the caller graph for this function:

getValue()

getValue

(

$encode = false

)

Get initial content

Parameters

bool

$encode

To sanitizer the text? Default value should be "true"; however we have to set "false" for backward compatibility

Returns

string

Here is the caller graph for this function:

render()

render

(

)

Prepare HTML for output

Returns

string HTML

Reimplemented from XoopsFormElement.

Reimplemented in XoopsFormColorPicker, and XoopsFormTextDateSelect.

Here is the call graph for this function:

setValue()

setValue

(

$value

)

Set initial text value

Parameters

string

$value

Here is the caller graph for this function:

Field Documentation

$_maxlength

$_maxlength

$_size

$_size

$_value

$_value

---

The documentation for this class was generated from the following file:

• C:/xoops2511b2/htdocs/class/xoopsform/formtext.php