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

Public Member Functions

 __construct ($name, $value)
 
 getValue ($encode=false)
 
 setValue ($value)
 
 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
 
- Data Fields inherited from XoopsFormElement
 $customValidationCode = array()
 
 $_name
 
 $_caption
 
 $_accesskey = ''
 
 $_class = array()
 
 $_hidden = false
 
 $_extra = array()
 
 $_required = false
 
 $_description = ''
 
 $_nocolspan = false
 
 $_formtype = ''
 

Detailed Description

A hidden field

Constructor & Destructor Documentation

◆ __construct()

__construct (   $name,
  $value 
)

Constructor

Parameters
string$name"name" attribute
string$value"value" attribute

Reimplemented in XoopsFormHiddenToken.

Here is the call graph for this function:

Member Function Documentation

◆ getValue()

getValue (   $encode = false)

Get the "value" attribute

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

◆ render()

render ( )

Prepare HTML for output

Returns
string HTML

Reimplemented from XoopsFormElement.

Here is the call graph for this function:

◆ setValue()

setValue (   $value)

Sets the "value" attribute

@patam $value string

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

Field Documentation

◆ $_value

$_value

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