PHP Class Xpressengine\Editor\EditorHandler

Author: XE Developers ([email protected])

Show file Open project: xpressengine/xpressengine Class Usage Examples

Protected Properties

Property	Type	Description
$configManager	Xpressengine\Config\ConfigManager	ConfigManager instance
$container	Illuminate\Contracts\Container\Container	Container instance
$defaultEditorId	string	Default editor identifier
$mediaManager	Xpressengine\Media\MediaManager	MediaManager instance
$register	Xpressengine\Plugin\PluginRegister	PluginRegister instance
$selectorName	string	The selector for tool's compiling
$storage	Xpressengine\Storage\Storage	Storage instance
$tagHandler	Xpressengine\Tag\TagHandler	TagHandler instance

Public Methods

Method	Description
__construct ( PluginRegister $register, ConfigManager $configManager, Illuminate\Contracts\Container\Container $container, Storage $storage, MediaManager $mediaManager, TagHandler $tagHandler )	EditorHandler constructor.
compile ( string $instanceId, string $content, boolean $htmlable = false ) : string	Compile the raw content to be useful
get ( string $instanceId ) : AbstractEditor	Get editor by instance id
getAll ( ) : array	Get registered editor ids
getConfigKey ( string $instanceId ) : string	Get a key string for the config
getDefaultEditorId ( ) : string	Get default editor id
getEditorId ( string $instanceId ) : string	Get editor id by instance id
getFiles ( string $targetId ) : File[]	Get files of target used
getPermKey ( string $instanceId ) : string	Get a key string for the permission
getTool ( string $toolId, string $instanceId ) : AbstractTool \| null	Get a tool
getToolAll ( ) : array	Get all registered tools
render ( string $instanceId, array \| false $args, string \| null $targetId = null ) : string	Rendering the editor
setDefaultEditorId ( string $editorId ) : void	Set default editor id
setInstance ( string $instanceId, string $editorId ) : void	Set instance by instance id

Protected Methods

Method	Description
compileTools ( string $instanceId, string $content ) : string	Compile the raw content to be useful by tools

Method Details

__construct() public method

EditorHandler constructor.

public __construct ( PluginRegister $register, ConfigManager $configManager, Illuminate\Contracts\Container\Container $container, Storage $storage, MediaManager $mediaManager, TagHandler $tagHandler )
$register	Xpressengine\Plugin\PluginRegister	PluginRegister instance
$configManager	Xpressengine\Config\ConfigManager	ConfigManager instance
$container	Illuminate\Contracts\Container\Container	Container instance
$storage	Xpressengine\Storage\Storage	Storage instance
$mediaManager	Xpressengine\Media\MediaManager	MediaManager instance
$tagHandler	Xpressengine\Tag\TagHandler	TagHandler instance

compile() public method

Compile the raw content to be useful

public compile ( string $instanceId, string $content, boolean $htmlable = false ) : string
$instanceId	string	instance id
$content	string	content
$htmlable	boolean	content is htmlable
return	string

compileTools() protected method

Compile the raw content to be useful by tools

protected compileTools ( string $instanceId, string $content ) : string
$instanceId	string	instance id
$content	string	content
return	string

get() public method

Get editor by instance id

public get ( string $instanceId ) : AbstractEditor
$instanceId	string	instance id
return	AbstractEditor

getAll() public method

Get registered editor ids

public getAll ( ) : array
return	array

getConfigKey() public method

Get a key string for the config

public getConfigKey ( string $instanceId ) : string
$instanceId	string	instance identifier
return	string

getDefaultEditorId() public method

Get default editor id

public getDefaultEditorId ( ) : string
return	string

getEditorId() public method

Get editor id by instance id

public getEditorId ( string $instanceId ) : string
$instanceId	string	instance id
return	string

getFiles() public method

Get files of target used

public getFiles ( string $targetId ) : File[]
$targetId	string	target identifier
return	Xpressengine\Storage\File[]

getPermKey() public method

Get a key string for the permission

public getPermKey ( string $instanceId ) : string
$instanceId	string	instance identifier
return	string

getTool() public method

Get a tool

public getTool ( string $toolId, string $instanceId ) : AbstractTool \| null
$toolId	string	tool id
$instanceId	string	instance id
return	AbstractTool \| null

getToolAll() public method

Get all registered tools

public getToolAll ( ) : array
return	array

render() public method

Rendering the editor

public render ( string $instanceId, array \| false $args, string \| null $targetId = null ) : string
$instanceId	string	instance id
$args	array \| false	argument for editor
$targetId	string \| null	target id
return	string

setDefaultEditorId() public method

Set default editor id

public setDefaultEditorId ( string $editorId ) : void
$editorId	string	editor id
return	void

setInstance() public method

Set instance by instance id

public setInstance ( string $instanceId, string $editorId ) : void
$instanceId	string	instance id
$editorId	string	editor id
return	void

Property Details

$configManager protected property

ConfigManager instance

protected ConfigManager,Xpressengine\Config $configManager
return	Xpressengine\Config\ConfigManager

$container protected property

Container instance

protected Container,Illuminate\Contracts\Container $container
return	Illuminate\Contracts\Container\Container

$defaultEditorId protected property

Default editor identifier

protected string $defaultEditorId
return	string

$mediaManager protected property

MediaManager instance

protected MediaManager,Xpressengine\Media $mediaManager
return	Xpressengine\Media\MediaManager

$register protected property

PluginRegister instance

protected PluginRegister,Xpressengine\Plugin $register
return	Xpressengine\Plugin\PluginRegister

$selectorName protected property

The selector for tool's compiling

protected string $selectorName
return	string

$storage protected property

Storage instance

protected Storage,Xpressengine\Storage $storage
return	Xpressengine\Storage\Storage

$tagHandler protected property

TagHandler instance

protected TagHandler,Xpressengine\Tag $tagHandler
return	Xpressengine\Tag\TagHandler