XOOPS  2.6.0
Public Member Functions | Public Attributes | List of all members
Xoops\Form\Editor Class Reference
Inheritance diagram for Xoops\Form\Editor:
Inheritance graph

Public Member Functions

 __construct ($caption, $name, $configs=null, $nohtml=false, $OnFailure= '')
 
 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

 $editor
 
- Public Attributes inherited from Xoops\Form\Element
 $customValidationCode = array()
 

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 25 of file Editor.php.

Constructor & Destructor Documentation

Xoops\Form\Editor::__construct (   $caption,
  $name,
  $configs = null,
  $nohtml = false,
  $OnFailure = '' 
)

Constructor

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

Definition at line 45 of file Editor.php.

References Xoops\Form\Element\$caption, $configs, $name, and XoopsEditorHandler\getInstance().

Here is the call graph for this function:

Member Function Documentation

Xoops\Form\Editor::render ( )

render

Returns
string

Definition at line 90 of file Editor.php.

Xoops\Form\Editor::renderValidationJS ( )

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

Returns
string|false

Definition at line 69 of file Editor.php.

References Xoops\Form\Element\getCaption(), Xoops\Form\Element\getName(), and Xoops\Form\Element\isRequired().

Here is the call graph for this function:

Member Data Documentation

Xoops\Form\Editor::$editor

Definition at line 30 of file Editor.php.

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