Class XoopsFormElement

Abstract base class for form elements

Direct known subclasses

XoopsFormButton, XoopsFormButtonTray, XoopsFormSelect, XoopsFormText, XoopsFormTextArea, XoopsGroupFormCheckBox, XoopsFormCaptcha, XoopsFormCheckBox, XoopsFormElementTray, XoopsFormFile, XoopsFormHidden, XoopsFormLabel, XoopsFormPassword, XoopsFormRadio

Indirect known subclasses

FormDhtmlTextArea, FormTextArea, XoopsFormSelectCountry, XoopsFormSelectEditor, XoopsFormSelectGroup, XoopsFormSelectLang, XoopsFormSelectMatchOption, XoopsFormSelectTheme, XoopsFormSelectTimezone, XoopsFormSelectUser, XoopsFormTextDateSelect, XoopsFormTinymce, XoopsEditor, XoopsFormColorPicker, XoopsFormDateTime, XoopsFormDhtmlTextArea, XoopsFormEditor, XoopsFormHiddenToken, XoopsFormRadioYN, XoopsFormSelectCheckGroup

Package: kernel\form
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Located at lass/xoopsform/formelement.php

Methods summary
`public`	# `__construct( )` constructor constructor
`public boolean`	# `isContainer( )` Is this element a container of other elements? Is this element a container of other elements? Returns boolean false
`public`	# `setName( string $name )` set the "name" attribute for the element set the "name" attribute for the element Parameters `$name` "name" attribute for the element
`public string`	# `getName( boolean $encode = true )` get the "name" attribute for the element get the "name" attribute for the element Parameters `$encode` Returns string "name" attribute
`public`	# `setAccessKey( string $key )` set the "accesskey" attribute for the element set the "accesskey" attribute for the element Parameters `$key` "accesskey" attribute for the element
`public string`	# `getAccessKey( )` get the "accesskey" attribute for the element get the "accesskey" attribute for the element Returns string "accesskey" attribute value
`public string`	# `getAccessString( string $str )` If the accesskey is found in the specified string, underlines it If the accesskey is found in the specified string, underlines it Parameters `$str` String where to search the accesskey occurence Returns string Enhanced string with the 1st occurence of accesskey underlined
`public`	# `setClass( string $class )` set the "class" attribute for the element set the "class" attribute for the element Parameters `$class`
`public string`	# `getClass( )` get the "class" attribute for the element get the "class" attribute for the element Returns string "class" attribute value
`public`	# `setCaption( string $caption )` set the caption for the element set the caption for the element Parameters `$caption`
`public string`	# `getCaption( boolean $encode = false )` get the caption for the element get the caption for the element Parameters `$encode` To sanitizer the text? Returns string
`public string`	# `getTitle( boolean $encode = true )` get the caption for the element get the caption for the element Parameters `$encode` To sanitizer the text? Returns string
`public`	# `setDescription( string $description )` set the element's description set the element's description Parameters `$description`
`public string`	# `getDescription( boolean $encode = false )` get the element's description get the element's description Parameters `$encode` To sanitizer the text? Returns string
`public`	# `setHidden( )` flag the element as "hidden" flag the element as "hidden"
`public boolean`	# `isHidden( )` Find out if an element is "hidden". Find out if an element is "hidden". Returns boolean
`public boolean`	# `isRequired( )` Find out if an element is required. Find out if an element is required. Returns boolean
`public array`	# `setExtra( string $extra, boolean $replace = false )` Add extra attributes to the element. 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 `$extra` `$replace` If true, passed string will replace current content otherwise it will be appended to it Returns array New content of the extra string
`public string`	# `getExtra( boolean $encode = false )` Get the extra attributes for the element Get the extra attributes for the element Parameters `$encode` To sanitizer the text? Returns string
`public`	# `setNocolspan( boolean $nocolspan = true )` Set the element's nocolspan Modified by Catzwolf Set the element's nocolspan Modified by Catzwolf Deprecated PLEASE AVOID USING THIS METHOD Parameters `$nocolspan`
`public string`	# `getNocolspan( )` Get the element's nocolspan Modified by Catzwolf Get the element's nocolspan Modified by Catzwolf Deprecated PLEASE AVOID USING THIS METHOD Returns string
`public string`	# `getFormType( )` get the element's nocolspan Modified by Catzwolf get the element's nocolspan Modified by Catzwolf Deprecated PLEASE AVOID USING THIS METHOD Returns string
`public`	# `setFormType( string $value = '' )` set the element's nocolspan Modified by Catzwolf set the element's nocolspan Modified by Catzwolf Deprecated PLEASE AVOID USING THIS METHOD Parameters `$value`
`public`	# `renderValidationJS( )` Render custom javascript validation code Render custom javascript validation code Seealso XoopsForm::renderValidationJS
`public`	# `render( )` Generates output for the element. Generates output for the element. This method is abstract and must be overwritten by the child classes.

Properties summary
`public array`	`$customValidationCode` Javascript performing additional validation of this element data Javascript performing additional validation of this element data This property contains a list of Javascript snippets that will be sent to XoopsForm::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.	# `array()`
`public string`	`$_name` "name" attribute of the element "name" attribute of the element	#
`public string`	`$_caption` caption of the element caption of the element	#
`public string`	`$_accesskey` Accesskey for this element Accesskey for this element	# `''`
`public array`	`$_class` HTML classes for this element HTML classes for this element	# `array()`
`public boolean`	`$_hidden` hidden? hidden?	# `false`
`public array`	`$_extra` extra attributes to go in the tag extra attributes to go in the tag	# `array()`
`public boolean`	`$_required` required field? required field?	# `false`
`public string`	`$_description` description of the field description of the field	# `''`
`public boolean`	`$_nocolspan` CAtzwolf: Modified for No Colspan CAtzwolf: Modified for No Colspan Lets a developer have only one column in a form element rather than two. Example of usgage: Allows text editors to span 2 columns rathe than pushed into one column Deprecated PLEASE AVOID USING THIS METHOD	# `false`
`public string`	`$_formtype` Get form type Get form type Deprecated PLEASE AVOID USING THIS METHOD	# `''`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsFormElement

Direct known subclasses

Indirect known subclasses

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Deprecated

Parameters

Deprecated

Returns

Deprecated

Returns

Deprecated

Parameters

Seealso

Deprecated

Deprecated