XOOPS  2.6.0
Xoops\Form\DhtmlTextArea Class Reference
Inheritance diagram for Xoops\Form\DhtmlTextArea:
Inheritance graph

Public Member Functions

 __construct ($caption, $name, $value="", $rows=5, $cols=50, $hiddentext="xoopsHiddenText", $options=array())
 
 codeIcon ()
 
 fontArray ()
 
 render ()
 
 renderValidationJS ()
 
- Public Member Functions inherited from Xoops\Form\TextArea
 __construct ($caption, $name, $value="", $rows=5, $cols=5, $placeholder= '')
 
 getCols ()
 
 getPlaceholder ()
 
 getRows ()
 
 render ()
 
- Public Member Functions inherited from Xoops\Form\Element
 getAccessKey ()
 
 getAccessString ($str)
 
 getCaption ()
 
 getClass ()
 
 getDatalist ()
 
 getDescription ($encode=false)
 
 getExtra ($encode=false)
 
 getMaxcols ()
 
 getName ()
 
 getPattern ()
 
 getPatternDescription ()
 
 getTitle ()
 
 getValue ($encode=false)
 
 isDatalist ()
 
 isHidden ()
 
 isRequired ()
 
 render ()
 
 renderAttributeString ()
 
 renderValidationJS ()
 
 setAccessKey ($key)
 
 setCaption ($caption)
 
 setClass ($class)
 
 setDatalist ($datalist)
 
 setDescription ($description)
 
 setExtra ($extra, $replace=false)
 
 setHidden ()
 
 setName ($name)
 
 setPattern ($pattern, $pattern_description= '')
 
 setRequired ($bool=true)
 
 setTitle ($title)
 
 setValue ($value)
 
- Public Member Functions inherited from Xoops\Html\Attributes
 addAttribute ($name, $value)
 
 getAttribute ($name)
 
 hasAttribute ($name)
 
 renderAttributeString ()
 
 setAttribute ($name, $value=null)
 
 setAttributes ($values)
 
 unsetAttribute ($name)
 

Public Attributes

 $configs = array()
 
 $doHtml = false
 
 $htmlEditor = array()
 
 $js = ''
 
 $skipPreview = false
 
- Public Attributes inherited from Xoops\Form\Element
 $customValidationCode = array()
 

Private Attributes

 $hiddenText
 

Additional Inherited Members

- Protected Attributes inherited from Xoops\Form\Element
 $value = ''
 
- Protected Attributes inherited from Xoops\Html\Attributes
 $attributes = array()
 

Detailed Description

Definition at line 27 of file DhtmlTextArea.php.

Constructor & Destructor Documentation

Xoops\Form\DhtmlTextArea::__construct (   $caption,
  $name,
  $value = "",
  $rows = 5,
  $cols = 50,
  $hiddentext = "xoopsHiddenText",
  $options = array() 
)

Constructor

Parameters
string$captionCaption
string$namename attribute
string$valueInitial text
integer$rowsNumber of rows
integer$colsNumber of columns
string$hiddentextIdentifier for hidden Text
array$optionsExtra options

Definition at line 95 of file DhtmlTextArea.php.

References Xoops\Form\Element\$caption, $editor, Xoops\Form\DhtmlTextArea\$htmlEditor, $name, $options, $path, Xoops\Form\Element\$value, $xoops, Xoops\getInstance(), XoopsEditorHandler\getInstance(), Xoops\Form\Element\getName(), and Xoops\Form\Element\getValue().

Here is the call graph for this function:

Member Function Documentation

Xoops\Form\DhtmlTextArea::renderValidationJS ( )

renderValidationJS

Returns
bool|string

Definition at line 301 of file DhtmlTextArea.php.

Member Data Documentation

Xoops\Form\DhtmlTextArea::$configs = array()

Definition at line 82 of file DhtmlTextArea.php.

Xoops\Form\DhtmlTextArea::$doHtml = false

Definition at line 72 of file DhtmlTextArea.php.

Xoops\Form\DhtmlTextArea::$hiddenText
private

Definition at line 62 of file DhtmlTextArea.php.

Referenced by Xoops\Form\DhtmlTextArea\fontArray().

Xoops\Form\DhtmlTextArea::$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';

Definition at line 55 of file DhtmlTextArea.php.

Referenced by Xoops\Form\DhtmlTextArea\__construct().

Xoops\Form\DhtmlTextArea::$js = ''
Xoops\Form\DhtmlTextArea::$skipPreview = false

Definition at line 67 of file DhtmlTextArea.php.


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