API - XOOPS 2.5.11 Beta 2
By monxoops.fr
XoopsFormButton Class Reference
Inheritance diagram for XoopsFormButton:
Collaboration diagram for XoopsFormButton:

Public Member Functions

 __construct ($caption, $name, $value='', $type='button')
 
 getValue ($encode=false)
 
 setValue ($value)
 
 getType ()
 
 render ()
 
- Public Member Functions inherited from XoopsFormElement
 __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

 $_value
 
 $_type
 
- Data Fields inherited from XoopsFormElement
 $customValidationCode = array()
 
 $_name
 
 $_caption
 
 $_accesskey = ''
 
 $_class = array()
 
 $_hidden = false
 
 $_extra = array()
 
 $_required = false
 
 $_description = ''
 
 $_nocolspan = false
 
 $_formtype = ''
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $caption,
  $name,
  $value = '',
  $type = 'button' 
)

Constructor

Parameters
string$captionCaption
string$name
string$value
string$typeType of the button. Potential values: "button", "submit", or "reset"
Here is the call graph for this function:

Member Function Documentation

◆ getType()

getType ( )

Get the type

Returns
string
Here is the caller graph for this function:

◆ getValue()

getValue (   $encode = false)

Get the initial value

Parameters
bool$encodeTo sanitizer the text?
Returns
string
Here is the caller graph for this function:

◆ render()

render ( )

prepare HTML for output

Returns
string

Reimplemented from XoopsFormElement.

Here is the call graph for this function:

◆ setValue()

setValue (   $value)

Set the initial value

Parameters
$value
Returns
string
Here is the caller graph for this function:

Field Documentation

◆ $_type

$_type

◆ $_value

$_value

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