XOOPS API 2.5.11 Beta1  UI v0.5
Réalisé par monxoops.fr
Référence de la classe XoopsFormDhtmlTextArea
+ Graphe d'héritage de XoopsFormDhtmlTextArea:
+ Graphe de collaboration de XoopsFormDhtmlTextArea:

Fonctions membres publiques

 __construct ($caption, $name, $value='', $rows=5, $cols=50, $hiddentext='xoopsHiddenText', $options=array())
 
 render ()
 
 renderValidationJS ()
 
- Fonctions membres publiques hérités de XoopsFormTextArea
 __construct ($caption, $name, $value='', $rows=5, $cols=50)
 
 getRows ()
 
 getCols ()
 
 getValue ($encode=false)
 
 setValue ($value)
 
- Fonctions membres publiques hérités de 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='')
 

Champs de données

 $htmlEditor = array()
 
 $_hiddenText
 
 $skipPreview = false
 
 $doHtml = false
 
 $js = ''
 
- Champs de données hérités de XoopsFormTextArea
 $_cols
 
 $_rows
 
 $_value
 
- Champs de données hérités de XoopsFormElement
 $customValidationCode = array()
 
 $_name
 
 $_caption
 
 $_accesskey = ''
 
 $_class = array()
 
 $_hidden = false
 
 $_extra = array()
 
 $_required = false
 
 $_description = ''
 
 $_nocolspan = false
 
 $_formtype = ''
 

Description détaillée

A textarea with xoopsish formatting and smilie buttons

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $caption,
  $name,
  $value = '',
  $rows = 5,
  $cols = 50,
  $hiddentext = 'xoopsHiddenText',
  $options = array() 
)

Constructor

Paramètres
string$captionCaption
string$name"name" attribute
string$valueInitial text
int$rowsNumber of rows
int$colsNumber of columns
string$hiddentextIdentifier for hidden Text
array$optionsExtra options
+ Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

◆ render()

render ( )

Prepare HTML for output

Renvoie
string HTML

Réimplémentée à partir de XoopsFormTextArea.

+ Voici le graphe d'appel pour cette fonction :

◆ renderValidationJS()

renderValidationJS ( )

XoopsFormDhtmlTextArea::renderValidationJS()

Renvoie
bool|string

Réimplémentée à partir de XoopsFormElement.

Documentation des champs

◆ $_hiddenText

$_hiddenText

◆ $doHtml

$doHtml = false

◆ $htmlEditor

$htmlEditor = array()

Extended HTML editor

If an extended HTML editor is set, the renderer will be replaced by the specified editor, usually a visual or WYSIWYG editor.

and user guide:

run-time settings per call To use an editor pre-configured by XoopsEditor, e.g. 'fckeditor': $options['editor'] = 'fckeditor'; To use a custom editor, e.g. 'MyEditor' class located in "/modules/myeditor/myeditor.php": $options['editor'] = array('MyEditor', XOOPS_ROOT_PATH . "/modules/myeditor/myeditor.php");

pre-configured settings, which will force to use a editor if no specific editor is set for call

up custom configs: in XOOPS_VAR_PATH . '/configs/xoopsconfig.php' set a editor as default, e.g. a pre-configured editor 'fckeditor': return array('editor' => 'fckeditor'); a custom editor 'MyEditor' class located in "/modules/myeditor/myeditor.php": return array('editor' => array('MyEditor', XOOPS_ROOT_PATH . "/modules/myeditor/myeditor.php"); To disable the default editor, in XOOPS_VAR_PATH . '/configs/xoopsconfig.php': return array(); To disable the default editor for a specific call: $options['editor'] = 'dhtmltextarea';

◆ $js

$js = ''

◆ $skipPreview

$skipPreview = false

La documentation de cette classe a été générée à partir du fichier suivant :