API - XOOPS 2.5.11 Beta 2
By monxoops.fr
XoopsEditorHandler Class Reference

Public Member Functions

 __construct ()
 
 get ($name='', $options=null, $noHtml=false, $OnFailure='')
 
 getList ($noHtml=false)
 
 render ($editor)
 
 setConfig ($editor, $options)
 
 _loadEditor ($name, $options=null)
 

Static Public Member Functions

static getInstance ()
 

Data Fields

 $root_path = ''
 
 $nohtml = false
 
 $allowed_editors = array()
 

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Enter description here...

Member Function Documentation

◆ _loadEditor()

_loadEditor (   $name,
  $options = null 
)

XoopsEditorHandler::_loadEditor()

Parameters
mixed$name
mixed$options
Returns
Here is the call graph for this function:
Here is the caller graph for this function:

◆ get()

get (   $name = '',
  $options = null,
  $noHtml = false,
  $OnFailure = '' 
)
Parameters
string$nameEditor name which is actually the folder name
array$optionseditor options: $key => $val
string$OnFailurea pre-validated editor that will be used if the required editor is failed to create
bool$noHtmldohtml disabled
Returns
null
Here is the call graph for this function:

◆ getInstance()

static getInstance ( )
static

Access the only instance of this class

Returns
object

@staticvar object

Here is the caller graph for this function:

◆ getList()

getList (   $noHtml = false)

XoopsEditorHandler::getList()

Parameters
mixed$noHtml
Returns
array
Here is the call graph for this function:
Here is the caller graph for this function:

◆ render()

render (   $editor)

XoopsEditorHandler::render()

Parameters
mixed$editor
Returns

◆ setConfig()

setConfig (   $editor,
  $options 
)

XoopsEditorHandler::setConfig()

Parameters
mixed$editor
mixed$options
Returns
void

Field Documentation

◆ $allowed_editors

$allowed_editors = array()

◆ $nohtml

$nohtml = false

◆ $root_path

$root_path = ''

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