XOOPS  2.6.0
XoopsEditorHandler Class Reference

Public Member Functions

 buildEditorList ()
 
 get ($name= '', $options=null, $noHtml=false, $OnFailure= '')
 
 getList ($noHtml=false)
 
 setConfig (XoopsEditor $editor, $options)
 

Static Public Member Functions

static getInstance ()
 

Public Attributes

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

Private Member Functions

 __construct ()
 
 _loadEditor ($name, $options=null)
 

Detailed Description

Definition at line 135 of file xoopseditor.php.

Constructor & Destructor Documentation

XoopsEditorHandler::__construct ( )
private

Constructor

Definition at line 155 of file xoopseditor.php.

References XoopsBaseConfig\get().

Here is the call graph for this function:

Member Function Documentation

XoopsEditorHandler::_loadEditor (   $name,
  $options = null 
)
private

XoopsEditorHandler::_loadEditor()

Parameters
string$name
mixed$options
Returns
XoopsEditor|null

Definition at line 272 of file xoopseditor.php.

References $config, $editor, $file, $name, $options, $xoops, XoopsLoad\fileExists(), Xoops\getInstance(), Xoops_Locale_Abstract\getLegacyLanguage(), and getList().

Referenced by get().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsEditorHandler::buildEditorList ( )
Parameters
bool$noHtml
Returns
array

Definition at line 203 of file xoopseditor.php.

References $config, $file, XoopsLoad\fileExists(), and Xoops_Locale_Abstract\getLegacyLanguage().

Here is the call graph for this function:

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

Definition at line 185 of file xoopseditor.php.

References $editor, $name, $options, _loadEditor(), and getList().

Here is the call graph for this function:

static XoopsEditorHandler::getInstance ( )
static

Access the only instance of this class

Returns
XoopsEditorHandler

XoopsEditorHandler

Definition at line 167 of file xoopseditor.php.

Referenced by Xoops\Form\Editor\__construct(), Xoops\Form\DhtmlTextArea\__construct(), and Xoops\Form\SelectEditor\render().

Here is the caller graph for this function:

XoopsEditorHandler::getList (   $noHtml = false)
Parameters
bool$noHtml
Returns
array

Definition at line 234 of file xoopseditor.php.

References $editors, $name, $xoops, XoopsEditor\CACHE_KEY_EDITOR_LIST, and Xoops\getInstance().

Referenced by _loadEditor(), and get().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsEditorHandler::setConfig ( XoopsEditor  $editor,
  $options 
)
Parameters
XoopsEditor$editor
array$options
Returns
void

Definition at line 260 of file xoopseditor.php.

References $options, and XoopsEditor\setConfig().

Here is the call graph for this function:

Member Data Documentation

XoopsEditorHandler::$allowed_editors = array()

Definition at line 150 of file xoopseditor.php.

XoopsEditorHandler::$nohtml = false

Definition at line 145 of file xoopseditor.php.

XoopsEditorHandler::$root_path = ""

Definition at line 140 of file xoopseditor.php.


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