Référence de la classe XoopsFormElement

Graphe d'héritage de XoopsFormElement:

Fonctions membres publiques
	__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 ()

Champs de données
	$customValidationCode = array()
	$_name
	$_caption
	$_accesskey = ''
	$_class = array()
	$_hidden = false
	$_extra = array()
	$_required = false
	$_description = ''
	$_nocolspan = false
	$_formtype = ''

Description détaillée

Abstract base class for form elements

Documentation des constructeurs et destructeur

__construct()

__construct

(

)

constructor

Réimplémentée dans XoopsEditor.

Documentation des fonctions membres

getAccessKey()

getAccessKey

(

)

get the "accesskey" attribute for the element

Renvoie

string "accesskey" attribute value

Voici le graphe des appelants de cette fonction :

getAccessString()

getAccessString

(

$str

)

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

Paramètres

string

$str

String where to search the accesskey occurence

Renvoie

string Enhanced string with the 1st occurence of accesskey underlined

Voici le graphe d'appel pour cette fonction :

getCaption()

getCaption

(

$encode = false

)

get the caption for the element

Paramètres

bool

$encode

To sanitizer the text?

Renvoie

string

Voici le graphe des appelants de cette fonction :

getClass()

getClass

(

)

get the "class" attribute for the element

Renvoie

string "class" attribute value

getDescription()

getDescription

(

$encode = false

)

get the element's description

Paramètres

bool

$encode

To sanitizer the text?

Renvoie

string

getExtra()

getExtra

(

$encode = false

)

Get the extra attributes for the element

Paramètres

bool

$encode

To sanitizer the text?

Renvoie

string

Voici le graphe des appelants de cette fonction :

getFormType()

getFormType

(

)

get the element's nocolspan Modified by Catzwolf

Renvoie

string

Obsolète:

PLEASE AVOID USING THIS METHOD

Voici le graphe des appelants de cette fonction :

getName()

getName

(

$encode = true

)

get the "name" attribute for the element

Paramètres

bool

$encode

Renvoie

string "name" attribute

Voici le graphe des appelants de cette fonction :

getNocolspan()

getNocolspan

(

)

Get the element's nocolspan Modified by Catzwolf

Renvoie

string

Obsolète:

PLEASE AVOID USING THIS METHOD

getTitle()

getTitle

(

$encode = true

)

get the caption for the element

Paramètres

bool

$encode

To sanitizer the text?

Renvoie

string

Voici le graphe des appelants de cette fonction :

isContainer()

isContainer

(

)

Is this element a container of other elements?

Renvoie

bool false

Réimplémentée dans XoopsFormElementTray.

Voici le graphe des appelants de cette fonction :

isHidden()

isHidden

(

)

Find out if an element is "hidden".

Renvoie

bool

isRequired()

isRequired

(

)

Find out if an element is required.

Renvoie

bool

Réimplémentée dans XoopsFormElementTray.

Voici le graphe des appelants de cette fonction :

render()

render

(

)

Generates output for the element.

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

@abstract

Réimplémentée dans XoopsGroupFormCheckBox, XoopsFormSelect, XoopsFormCheckBox, XoopsFormElementTray, XoopsFormRadio, XoopsFormDhtmlTextArea, XoopsFormPassword, XoopsFormTinymce, XoopsFormTextArea, XoopsFormText, XoopsFormButton, XoopsFormButtonTray, XoopsFormCaptcha, XoopsFormEditor, XoopsFormHidden, XoopsFormLabel, XoopsFormFile, XoopsFormSelectEditor, FormDhtmlTextArea, XoopsFormColorPicker, et XoopsFormTextDateSelect.

renderValidationJS()

renderValidationJS

(

)

Render custom javascript validation code

@seealso XoopsForm::renderValidationJS

Réimplémentée dans XoopsFormSelect, XoopsFormCheckBox, XoopsFormDhtmlTextArea, XoopsFormCaptcha, XoopsFormTinymce, XoopsFormEditor, et XoopsFormColorPicker.

Voici le graphe d'appel pour cette fonction :

setAccessKey()

setAccessKey

(

$key

)

set the "accesskey" attribute for the element

Paramètres

string

$key

"accesskey" attribute for the element

setCaption()

setCaption

(

$caption

)

set the caption for the element

Paramètres

string

$caption

Voici le graphe des appelants de cette fonction :

setClass()

setClass

(

$class

)

set the "class" attribute for the element

Paramètres

string

$class

setDescription()

setDescription

(

$description

)

set the element's description

Paramètres

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!

Paramètres

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

Renvoie

array New content of the extra string

Voici le graphe des appelants de cette fonction :

setFormType()

setFormType

(

$value = ''

)

set the element's nocolspan Modified by Catzwolf

Paramètres

string

$value

Obsolète:

PLEASE AVOID USING THIS METHOD

Voici le graphe des appelants de cette fonction :

setHidden()

setHidden

(

)

flag the element as "hidden"

Voici le graphe des appelants de cette fonction :

setName()

setName

(

$name

)

set the "name" attribute for the element

Paramètres

string

$name

"name" attribute for the element

Voici le graphe des appelants de cette fonction :

setNocolspan()

setNocolspan

(

$nocolspan = true

)

Set the element's nocolspan Modified by Catzwolf

Paramètres

bool

$nocolspan

Obsolète:

PLEASE AVOID USING THIS METHOD

Documentation des champs

$_accesskey

$_accesskey = ''

$_caption

$_caption

$_class

$_class = array()

$_description

$_description = ''

$_extra

$_extra = array()

$_formtype

$_formtype = ''

Get form type

Obsolète:

PLEASE AVOID USING THIS METHOD

$_hidden

$_hidden = false

$_name

$_name

$_nocolspan

$_nocolspan = false

$_required

$_required = false

$customValidationCode

$customValidationCode = array()

---

La documentation de cette classe a été générée à partir du fichier suivant :

• XoopsCore25-2.5.11-Beta1/htdocs/class/xoopsform/formelement.php