XoopsFormElement Class Reference

Inheritance diagram for XoopsFormElement:

Public Member Functions
	__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
	$customValidationCode = array()
	$_name
	$_caption
	$_accesskey = ''
	$_class = array()
	$_hidden = false
	$_extra = array()
	$_required = false
	$_description = ''
	$_nocolspan = false
	$_formtype = ''

Detailed Description

Abstract base class for form elements

Constructor & Destructor Documentation

__construct()

__construct

(

)

constructor

Reimplemented in XoopsEditor.

Member Function Documentation

getAccessKey()

getAccessKey

(

)

get the "accesskey" attribute for the element

Returns

string "accesskey" attribute value

Here is the caller graph for this function:

getAccessString()

getAccessString

(

$str

)

If the accesskey is found in the specified string, underlines it

Parameters

string

$str

String where to search the accesskey occurence

Returns

string Enhanced string with the 1st occurence of accesskey underlined

Here is the call graph for this function:

getCaption()

getCaption

(

$encode = false

)

get the caption for the element

Parameters

bool

$encode

To sanitizer the text?

Returns

string

Here is the caller graph for this function:

getClass()

getClass

(

)

get the "class" attribute for the element

Returns

string|false "class" attribute value

getDescription()

getDescription

(

$encode = false

)

get the element's description

Parameters

bool

$encode

To sanitizer the text?

Returns

string

getExtra()

getExtra

(

$encode = false

)

Get the extra attributes for the element

Parameters

bool

$encode

To sanitizer the text?

Returns

string

Here is the caller graph for this function:

getFormType()

getFormType

(

)

get the element's nocolspan Modified by Catzwolf

Returns

string

Deprecated:

PLEASE AVOID USING THIS METHOD

Here is the caller graph for this function:

getName()

getName

(

$encode = true

)

get the "name" attribute for the element

Parameters

bool

$encode

Returns

string "name" attribute

getNocolspan()

getNocolspan

(

)

Get the element's nocolspan Modified by Catzwolf

Returns

string|bool

Deprecated:

PLEASE AVOID USING THIS METHOD

getTitle()

getTitle

(

$encode = true

)

get the caption for the element

Parameters

bool

$encode

To sanitizer the text?

Returns

string

Here is the caller graph for this function:

isContainer()

isContainer

(

)

Is this element a container of other elements?

Returns

bool false

Reimplemented in XoopsFormElementTray.

Here is the caller graph for this function:

isHidden()

isHidden

(

)

Find out if an element is "hidden".

Returns

bool

isRequired()

isRequired

(

)

Find out if an element is required.

Returns

bool

Reimplemented in XoopsFormElementTray.

Here is the caller graph for this function:

render()

render

(

)

Generates output for the element.

This method is abstract and must be overwritten by the child classes.

@abstract

Reimplemented in FormDhtmlTextArea, XoopsFormTinymce, XoopsFormButton, XoopsFormButtonTray, XoopsFormCaptcha, XoopsFormCheckBox, XoopsFormColorPicker, XoopsFormDhtmlTextArea, XoopsFormEditor, XoopsFormElementTray, XoopsFormFile, XoopsFormHidden, XoopsFormLabel, XoopsFormPassword, XoopsFormRadio, XoopsFormSelect, XoopsFormSelectEditor, XoopsFormText, XoopsFormTextArea, XoopsFormTextDateSelect, and XoopsGroupFormCheckBox.

renderValidationJS()

renderValidationJS

(

)

Render custom javascript validation code

@seealso XoopsForm::renderValidationJS

Reimplemented in XoopsFormTinymce, XoopsFormCaptcha, XoopsFormCheckBox, XoopsFormColorPicker, XoopsFormDhtmlTextArea, XoopsFormEditor, and XoopsFormSelect.

Here is the call graph for this function:

setAccessKey()

setAccessKey

(

$key

)

set the "accesskey" attribute for the element

Parameters

string

$key

"accesskey" attribute for the element

setCaption()

setCaption

(

$caption

)

set the caption for the element

Parameters

string

$caption

Here is the caller graph for this function:

setClass()

setClass

(

$class

)

set the "class" attribute for the element

Parameters

string

$class

setDescription()

setDescription

(

$description

)

set the element's description

Parameters

string

$description

setExtra()

setExtra	(		$extra,
			$replace = false
	)

Add extra attributes to the element.

This string will be inserted verbatim and unvalidated in the element's tag. Know what you are doing!

Parameters

string	$extra
bool	$replace	If true, passed string will replace current content otherwise it will be appended to it

Returns

array New content of the extra string

Here is the caller graph for this function:

setFormType()

setFormType

(

$value = ''

)

set the element's nocolspan Modified by Catzwolf

Parameters

string

$value

Deprecated:

PLEASE AVOID USING THIS METHOD

Here is the caller graph for this function:

setHidden()

setHidden

(

)

flag the element as "hidden"

Here is the caller graph for this function:

setName()

setName

(

$name

)

set the "name" attribute for the element

Parameters

string

$name

"name" attribute for the element

Here is the caller graph for this function:

setNocolspan()

setNocolspan

(

$nocolspan = true

)

Set the element's nocolspan Modified by Catzwolf

Parameters

bool

$nocolspan

Deprecated:

PLEASE AVOID USING THIS METHOD

Field Documentation

$_accesskey

$_accesskey = ''

$_caption

$_caption

$_class

$_class = array()

$_description

$_description = ''

$_extra

$_extra = array()

$_formtype

$_formtype = ''

Get form type

Deprecated:

PLEASE AVOID USING THIS METHOD

$_hidden

$_hidden = false

$_name

$_name

$_nocolspan

$_nocolspan = false

$_required

$_required = false

$customValidationCode

$customValidationCode = array()

---

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

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