1. class
  2. Xpressengine
  3. Editor
  4. EditorHandler

EditorHandler

class EditorHandler

Class EditorHandler

Constants

NAME

Unique name
CONFIG_NAME

The name of config prefix
MAP_CONFIG_NAME

The name of map config
FILE_UPLOAD_PATH

The path for upload
THUMBNAIL_TYPE

The type of thumbnail

Properties

protected PluginRegister $register PluginRegister instance
protected ConfigManager $configManager ConfigManager instance
protected Container $container Container instance
protected Storage $storage Storage instance
protected MediaManager $mediaManager MediaManager instance
protected TagHandler $tagHandler TagHandler instance
protected string $defaultEditorId Default editor identifier
protected string $selectorName The selector for tool's compiling

Methods

__construct(PluginRegister $register, ConfigManager $configManager, Container $container, Storage $storage, MediaManager $mediaManager, TagHandler $tagHandler)

EditorHandler constructor.

array
getAll()

Get registered editor ids

void
setDefaultEditorId(string $editorId)

Set default editor id

string
getDefaultEditorId()

Get default editor id

void
setInstance(string $instanceId, string $editorId)

Set instance by instance id

string
getEditorId(string $instanceId)

Get editor id by instance id

AbstractEditor
get(string $instanceId)

Get editor by instance id

string
render(string $instanceId, array|false $args, string|null $targetId = null)

Rendering the editor

array
getToolAll()

Get all registered tools

AbstractTool|null
getTool(string $toolId, string $instanceId)

Get a tool

void
setTools(string $instanceId, array $tools)

Set tools for specific instance

string[]
getTools(string $instanceId)

Get tools for specific instance

string
compile(string $instanceId, string $content, bool $htmlable = false)

Compile the raw content to be useful

string
compileTools(string $instanceId, string $content)

Compile the raw content to be useful by tools

File[]
getFiles(string $targetId)

Get files of target used

ConfigEntity
setConfig(string $instanceId, array $data)

Set the config for specific instance

ConfigEntity
getConfig(string $instanceId)

Get the config for specific instance

string
getConfigKey(string $instanceId)

Get a key string for the config

string
getPermKey(string $instanceId)

Get a key string for the permission

Details

at line 141
__construct(PluginRegister $register, ConfigManager $configManager, Container $container, Storage $storage, MediaManager $mediaManager, TagHandler $tagHandler)

EditorHandler constructor.

Parameters

PluginRegister $register PluginRegister instance
ConfigManager $configManager ConfigManager instance
Container $container Container instance
Storage $storage Storage instance
MediaManager $mediaManager MediaManager instance
TagHandler $tagHandler TagHandler instance

at line 162
array getAll()

Get registered editor ids

Return Value

array

at line 173
void setDefaultEditorId(string $editorId)

Set default editor id

Parameters

string $editorId editor id

Return Value

void

at line 183
string getDefaultEditorId()

Get default editor id

Return Value

string

at line 195
void setInstance(string $instanceId, string $editorId)

Set instance by instance id

Parameters

string $instanceId instance id
string $editorId editor id

Return Value

void

at line 210
string getEditorId(string $instanceId)

Get editor id by instance id

Parameters

string $instanceId instance id

Return Value

string

at line 225
AbstractEditor get(string $instanceId)

Get editor by instance id

Parameters

string $instanceId instance id

Return Value

AbstractEditor

at line 248
string render(string $instanceId, array|false $args, string|null $targetId = null)

Rendering the editor

Parameters

string $instanceId instance id
array|false $args argument for editor
string|null $targetId target id

Return Value

string

at line 263
array getToolAll()

Get all registered tools

Return Value

array

at line 275
AbstractTool|null getTool(string $toolId, string $instanceId)

Get a tool

Parameters

string $toolId tool id
string $instanceId instance id

Return Value

AbstractTool|null

at line 293
void setTools(string $instanceId, array $tools)

Set tools for specific instance

Parameters

string $instanceId instance id
array $tools tool component ids

Return Value

void

at line 304
string[] getTools(string $instanceId)

Get tools for specific instance

Parameters

string $instanceId instance id

Return Value

string[]

at line 317
string compile(string $instanceId, string $content, bool $htmlable = false)

Compile the raw content to be useful

Parameters

string $instanceId instance id
string $content content
bool $htmlable content is htmlable

Return Value

string

at line 331
protected string compileTools(string $instanceId, string $content)

Compile the raw content to be useful by tools

Parameters

string $instanceId instance id
string $content content

Return Value

string

at line 367
File[] getFiles(string $targetId)

Get files of target used

Parameters

string $targetId target identifier

Return Value

File[]

at line 392
ConfigEntity setConfig(string $instanceId, array $data)

Set the config for specific instance

Parameters

string $instanceId instance id
array $data config data

Return Value

ConfigEntity

at line 403
ConfigEntity getConfig(string $instanceId)

Get the config for specific instance

Parameters

string $instanceId instance id

Return Value

ConfigEntity

at line 414
protected string getConfigKey(string $instanceId)

Get a key string for the config

Parameters

string $instanceId instance identifier

Return Value

string

at line 425
string getPermKey(string $instanceId)

Get a key string for the permission

Parameters

string $instanceId instance identifier

Return Value

string