XOOPS 2.5.6  Final
 All Classes Namespaces Files Functions Variables Pages
XoopsFormText Class Reference
Inheritance diagram for XoopsFormText:
Inheritance graph

Public Member Functions

 getMaxlength ()
 
 getSize ()
 
 getValue ($encode=false)
 
 render ()
 
 setValue ($value)
 
 XoopsFormText ($caption, $name, $size, $maxlength, $value= '')
 
- Public Member Functions inherited from XoopsFormElement
 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

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

Detailed Description

A simple text field

Definition at line 26 of file formtext.php.

Member Function Documentation

XoopsFormText::getMaxlength ( )

Get maximum text length

Returns
int

Definition at line 85 of file formtext.php.

XoopsFormText::getSize ( )

Get size

Returns
int

Definition at line 75 of file formtext.php.

XoopsFormText::getValue (   $encode = false)

Get initial content

Parameters
bool$encodeTo sanitizer the text? Default value should be "true"; however we have to set "false" for backward compat
Returns
string

Definition at line 96 of file formtext.php.

XoopsFormText::render ( )

Prepare HTML for output

Returns
string HTML

Definition at line 116 of file formtext.php.

XoopsFormText::setValue (   $value)

Set initial text value

Parameters
$valuestring

Definition at line 106 of file formtext.php.

XoopsFormText::XoopsFormText (   $caption,
  $name,
  $size,
  $maxlength,
  $value = '' 
)

Constructor

Parameters
string$captionCaption
string$name"name" attribute
int$sizeSize
int$maxlengthMaximum length of text
string$valueInitial text

Definition at line 61 of file formtext.php.

Member Data Documentation

XoopsFormText::$_maxlength

Definition at line 42 of file formtext.php.

XoopsFormText::$_size

Definition at line 34 of file formtext.php.

XoopsFormText::$_value

Definition at line 50 of file formtext.php.


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