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

Public Member Functions

 __construct ($caption, $name, $configs=null, $nohtml=false, $OnFailure='')
 
 renderValidationJS ()
 
 render ()
 
- Public Member Functions inherited from XoopsFormTextArea
 __construct ($caption, $name, $value='', $rows=5, $cols=50)
 
 getRows ()
 
 getCols ()
 
 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

 $editor
 
- Data Fields inherited from XoopsFormTextArea
 $_cols
 
 $_rows
 
 $_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

XOOPS Form Editor

Constructor & Destructor Documentation

◆ __construct()

__construct (   $caption,
  $name,
  $configs = null,
  $nohtml = false,
  $OnFailure = '' 
)

Constructor

Parameters
string$captionCaption
string$nameName for textarea field
array$configsconfigures: editor - editor identifier; name - textarea field name; width, height - dimensions for textarea; value - text content
bool$nohtmluse non-WYSIWYG editor onfailure
string$OnFailureeditor to be used if current one failed

Reimplemented from XoopsFormTextArea.

Here is the call graph for this function:

Member Function Documentation

◆ render()

render ( )

XoopsFormEditor::render()

Returns
string|null

Reimplemented from XoopsFormTextArea.

◆ renderValidationJS()

renderValidationJS ( )

renderValidationJS TEMPORARY SOLUTION to 'override' original renderValidationJS method with custom XoopsEditor's renderValidationJS method

Reimplemented from XoopsFormElement.

Here is the call graph for this function:

Field Documentation

◆ $editor

$editor

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