Editor

实现 DispatcherAwareInterface

用于处理 WYSIWYG 编辑器的 Editor 类

1.5

Joomla CMS

方法

__construct

构造函数

__construct( editor = 'none', \Joomla\Event\DispatcherInterface|null dispatcher = null, \Joomla\CMS\Editor\EditorsRegistry|null registry = null) : 

1.5

参数

editor

string编辑器名称

dispatcher

DispatcherInterface|null我们将使用的事件分发器

registry

EditorsRegistry|null编辑器注册表

响应

mixed

_loadEditor

加载编辑器

_loadEditor(mixed||string|int config = []) : 
已弃用

1.5

已弃用

6.0 应使用 EditorRegistry

参数

config

array<string|int, mixed>编辑器配置参数的关联数组

响应

mixed

display

显示编辑器区域。

display( name,  html,  width,  height,  col,  row,  buttons = true,  id = null,  asset = null,  author = null, mixed||string|int params = []) : 

1.5

参数

name

string控件名称。

html

string文本区域的内容。

width

string文本区域的宽度(px 或 %)。

height

string文本区域的高度(px 或 %)。

col

int文本区域的列数。

row

int文本区域的行数。

buttons

boolTrue 且将显示编辑器按钮。

id

string文本区域的可选 ID(注意:自 1.6 起)。如果未提供,则使用名称。

asset

string对象资源

author

object作者。

params

array<string|int, mixed>编辑器参数的关联数组。

响应

string

getButtons

获取编辑器的扩展按钮(通常来自插件)

getButtons( editor,  buttons = true) : mixed||string|int

1.5

参数

editor

string编辑器的 ID。

buttons

mixed可以是布尔值或数组,如果是布尔值,则定义是否显示按钮,如果是数组,则定义不显示的按钮列表。

响应

array<string|int, mixed>

getInstance

返回全局 Editor 对象,仅在它不存在时创建它。

getInstance( editor = 'none') : \Joomla\CMS\Editor\Editor
static

1.5

参数

editor

string要使用的编辑器。

响应

EditorEditor 对象。

initialise

初始化编辑器

initialise() : 
已弃用

1.5

已弃用

6.0 不会替换

响应

void

属性

_editor

Editor 插件对象

已弃用

1.5

已弃用

应使用 Provider 实例

类型

object

provider

Captcha Provider 实例

5.0.0

类型

EditorProviderInterface

_name

Editor 插件名称

1.5

类型

string

asset

对象资源

1.6

类型

string

author

对象作者

1.6

类型

string

instances

Editor 实例容器。

static

2.5

类型

array<string|int, Editor>