Inheritance diagram for XoopsFormElement:

Public Member Functions
	getAccessKey ()

	getAccessString ($str)

	getCaption ($encode=false)

	getClass ()

	getDescription ($encode=false)

	getExtra ($encode=false)

	getFormType ()

	getName ($encode=true)

	getNocolspan ()

	getTitle ($encode=true)

	isContainer ()

	isHidden ()

	isRequired ()

	render ()

	renderValidationJS ()

	setAccessKey ($key)

	setCaption ($caption)

	setClass ($class)

	setDescription ($description)

	setExtra ($extra, $replace=false)

	setFormType ($value= '')

	setHidden ()

	setName ($name)

	setNocolspan ($nocolspan=true)

	XoopsFormElement ()

Public Attributes
	$_accesskey = ''

	$_caption

	$_class = array()

	$_description = ''

	$_extra = array()

	$_formtype = ''

	$_hidden = false

	$_name

	$_nocolspan = false

	$_required = false

	$customValidationCode = array()

Detailed Description

Abstract base class for form elements

Definition at line 25 of file formelement.php.

Member Function Documentation

XoopsFormElement::getAccessKey ( )

get the "accesskey" attribute for the element

Returns: string "accesskey" attribute value

Definition at line 179 of file formelement.php.

XoopsFormElement::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

Definition at line 189 of file formelement.php.

References $pos.

XoopsFormElement::getCaption ( $encode = false )

get the caption for the element

Parameters

bool $encode To sanitizer the text?

Returns: string

Definition at line 243 of file formelement.php.

Referenced by XoopsFormTinymce\renderValidationJS().

Here is the caller graph for this function:

XoopsFormElement::getClass ( )

get the "class" attribute for the element

Returns: string "class" attribute value

Definition at line 215 of file formelement.php.

XoopsFormElement::getDescription ( $encode = false )

get the element's description

Parameters

bool $encode To sanitizer the text?

Returns: string

Definition at line 282 of file formelement.php.

XoopsFormElement::getExtra ( $encode = false )

Get the extra attributes for the element

Parameters

bool $encode To sanitizer the text?

Returns: string

Definition at line 341 of file formelement.php.

Referenced by XoopsFormRadio\render().

Here is the caller graph for this function:

XoopsFormElement::getFormType ( )

get the element's nocolspan Modified by Catzwolf

Returns: string

Deprecated:: PLEASE AVOID USING THIS METHOD

Definition at line 387 of file formelement.php.

XoopsFormElement::getName ( $encode = true )

get the "name" attribute for the element

Parameters

bool $ encode?

Returns: string "name" attribute

Definition at line 157 of file formelement.php.

Referenced by XoopsFormTinymce\__construct(), XoopsGroupFormCheckBox\_renderOptionTree(), XoopsFormRadio\render(), XoopsGroupFormCheckBox\render(), and XoopsFormTinymce\renderValidationJS().

Here is the caller graph for this function:

XoopsFormElement::getNocolspan ( )

Get the element's nocolspan Modified by Catzwolf

Returns: string

Deprecated:: PLEASE AVOID USING THIS METHOD

Definition at line 374 of file formelement.php.

XoopsFormElement::getTitle ( $encode = true )

get the caption for the element

Parameters

bool $encode To sanitizer the text?

Returns: string

Definition at line 254 of file formelement.php.

Referenced by XoopsFormRadio\render().

Here is the caller graph for this function:

XoopsFormElement::isContainer ( )

Is this element a container of other elements?

Returns: bool false

Definition at line 136 of file formelement.php.

XoopsFormElement::isHidden ( )

Find out if an element is "hidden".

Returns: bool

Definition at line 300 of file formelement.php.

XoopsFormElement::isRequired ( )

Find out if an element is required.

Returns: bool

Definition at line 310 of file formelement.php.

Referenced by XoopsFormTinymce\renderValidationJS().

Here is the caller graph for this function:

XoopsFormElement::render ( )

Generates output for the element.

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

Definition at line 443 of file formelement.php.

XoopsFormElement::renderValidationJS ( )

Render custom javascript validation code

XoopsForm::renderValidationJS

Definition at line 410 of file formelement.php.

References _FORM_ENTER.

XoopsFormElement::setAccessKey ( $key )

set the "accesskey" attribute for the element

Parameters

string $key "accesskey" attribute for the element

Definition at line 170 of file formelement.php.

XoopsFormElement::setCaption ( $caption )

set the caption for the element

Parameters

string $caption

Definition at line 232 of file formelement.php.

Referenced by XoopsFormRadio\XoopsFormRadio(), and XoopsGroupFormCheckBox\XoopsGroupFormCheckBox().

Here is the caller graph for this function:

XoopsFormElement::setClass ( $class )

set the "class" attribute for the element

Parameters

string $key "class" attribute for the element

Definition at line 203 of file formelement.php.

XoopsFormElement::setDescription ( $description )

set the element's description

Parameters

string $description

Definition at line 271 of file formelement.php.

XoopsFormElement::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
string	$replace	If true, passed string will replace current content otherwise it will be appended to it

Returns: array New content of the extra string

Definition at line 325 of file formelement.php.

XoopsFormElement::setFormType ( $value = '' )

set the element's nocolspan Modified by Catzwolf

Parameters

string $description

Deprecated:: PLEASE AVOID USING THIS METHOD

Definition at line 400 of file formelement.php.

XoopsFormElement::setHidden ( )

flag the element as "hidden"

Definition at line 290 of file formelement.php.

XoopsFormElement::setName ( $name )

set the "name" attribute for the element

Parameters

string $name "name" attribute for the element

Definition at line 146 of file formelement.php.

Referenced by XoopsFormRadio\XoopsFormRadio(), and XoopsGroupFormCheckBox\XoopsGroupFormCheckBox().

Here is the caller graph for this function:

XoopsFormElement::setNocolspan ( $nocolspan = true )

Set the element's nocolspan Modified by Catzwolf

Parameters

string $description

Deprecated:: PLEASE AVOID USING THIS METHOD

Definition at line 361 of file formelement.php.

XoopsFormElement::XoopsFormElement ( )

constructor

Definition at line 126 of file formelement.php.

References exit.

Member Data Documentation

XoopsFormElement::$_accesskey = ''

Definition at line 63 of file formelement.php.

XoopsFormElement::$_caption

Definition at line 56 of file formelement.php.

XoopsFormElement::$_class = array()

Definition at line 70 of file formelement.php.

XoopsFormElement::$_description = ''

Definition at line 98 of file formelement.php.

XoopsFormElement::$_extra = array()

Definition at line 84 of file formelement.php.

XoopsFormElement::$_formtype = ''

Get form type

Deprecated:: PLEASE AVOID USING THIS METHOD

Definition at line 121 of file formelement.php.

XoopsFormElement::$_hidden = false

Definition at line 77 of file formelement.php.

XoopsFormElement::$_name

Definition at line 49 of file formelement.php.

XoopsFormElement::$_nocolspan = false

Definition at line 114 of file formelement.php.

XoopsFormElement::$_required = false

Definition at line 91 of file formelement.php.

XoopsFormElement::$customValidationCode = array()

Definition at line 37 of file formelement.php.

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

L:/0xoops/xoops-2.5.6/htdocs/class/xoopsform/formelement.php

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation