Skip to content

icms_plugins_EditorHandler

Jump to bottom
Raimondas Rimkevičius edited this page Mar 9, 2020 · 1 revision
Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_plugins_EditorHandler

Editor framework

  • Class name: icms_plugins_EditorHandler
  • Namespace:

Properties

$root_path

private string $root_path

Path where is editor

  • Visibility: private

$nohtml

public bool $nohtml = \false

No HTML mode?

  • Visibility: public

$allowed_editors

public array $allowed_editors = array()

What editors to allow?

  • Visibility: public

$_type

private string $_type

Editor type

  • Visibility: private

Methods

__construct

mixed icms_plugins_EditorHandler::__construct(string type)

Constructor

  • Visibility: public

Arguments

  • type string - <p>Editor type</p>

getInstance

object icms_plugins_EditorHandler::getInstance(mixed type)

Access the only instance of this class

  • Visibility: public
  • This method is static.

Arguments

  • type mixed

get

mixed icms_plugins_EditorHandler::get(string name, array options, bool noHtml, string OnFailure)
  • Visibility: public

Arguments

  • name string - <p>Editor name which is actually the folder name</p>
  • options array - <p>editor options: $key => $val</p>
  • noHtml bool - <p>dohtml disabled</p>
  • OnFailure string - <p>a pre-validated editor that will be used if the required editor is failed to create</p>

getList

array icms_plugins_EditorHandler::getList(bool noHtml)

Gets list of available editors

  • Visibility: public

Arguments

  • noHtml bool - <p>is this an editor with no html options?</p>

render

string icms_plugins_EditorHandler::render(mixed editor)

Render the editor

  • Visibility: public

Arguments

  • editor mixed

setConfig

mixed icms_plugins_EditorHandler::setConfig(mixed editor, string options)

Sets the config of the editor

  • Visibility: public

Arguments

  • editor mixed
  • options string - <p>Options in the configuration to set</p>

_loadEditor

object icms_plugins_EditorHandler::_loadEditor(string name, string options)

Loads the editor

  • Visibility: public

Arguments

  • name string - <p>Name of the editor to load</p>
  • options string - <p>Options in the editor to load (configuration)</p>

_getRootPath

string icms_plugins_EditorHandler::_getRootPath(string type)

Determines the root path of the editor type

  • Visibility: private

Arguments

  • type string

getListByType

array icms_plugins_EditorHandler::getListByType(string type)

Retrieve a list of the available editors, by type

  • Visibility: public
  • This method is static.

Arguments

  • type string
Clone this wiki locally