PHP Class Xpressengine\Editor\EditorHandler

Author: XE Developers ([email protected])

Afficher le fichier Open project: xpressengine/xpressengine Class Usage Examples

Protected Properties

Свойство	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

Méthodes publiques

Méthode	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

Méthodes protégées

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

Method Details

__construct() public méthode

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 méthode

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
Résultat	string

compileTools() protected méthode

Compile the raw content to be useful by tools

protected compileTools ( string $instanceId, string $content ) : string
$instanceId	string	instance id
$content	string	content
Résultat	string

get() public méthode

Get editor by instance id

public get ( string $instanceId ) : AbstractEditor
$instanceId	string	instance id
Résultat	AbstractEditor

getAll() public méthode

Get registered editor ids

public getAll ( ) : array
Résultat	array

getConfigKey() public méthode

Get a key string for the config

public getConfigKey ( string $instanceId ) : string
$instanceId	string	instance identifier
Résultat	string

getDefaultEditorId() public méthode

Get default editor id

public getDefaultEditorId ( ) : string
Résultat	string

getEditorId() public méthode

Get editor id by instance id

public getEditorId ( string $instanceId ) : string
$instanceId	string	instance id
Résultat	string

getFiles() public méthode

Get files of target used

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

getPermKey() public méthode

Get a key string for the permission

public getPermKey ( string $instanceId ) : string
$instanceId	string	instance identifier
Résultat	string

getTool() public méthode

Get a tool

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

getToolAll() public méthode

Get all registered tools

public getToolAll ( ) : array
Résultat	array

render() public méthode

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
Résultat	string

setDefaultEditorId() public méthode

Set default editor id

public setDefaultEditorId ( string $editorId ) : void
$editorId	string	editor id
Résultat	void

setInstance() public méthode

Set instance by instance id

public setInstance ( string $instanceId, string $editorId ) : void
$instanceId	string	instance id
$editorId	string	editor id
Résultat	void

Property Details

$configManager protected_oe property

ConfigManager instance

protected ConfigManager,Xpressengine\Config $configManager
Résultat	Xpressengine\Config\ConfigManager

$container protected_oe property

Container instance

protected Container,Illuminate\Contracts\Container $container
Résultat	Illuminate\Contracts\Container\Container

$defaultEditorId protected_oe property

Default editor identifier

protected string $defaultEditorId
Résultat	string

$mediaManager protected_oe property

MediaManager instance

protected MediaManager,Xpressengine\Media $mediaManager
Résultat	Xpressengine\Media\MediaManager

$register protected_oe property

PluginRegister instance

protected PluginRegister,Xpressengine\Plugin $register
Résultat	Xpressengine\Plugin\PluginRegister

$selectorName protected_oe property

The selector for tool's compiling

protected string $selectorName
Résultat	string

$storage protected_oe property

Storage instance

protected Storage,Xpressengine\Storage $storage
Résultat	Xpressengine\Storage\Storage

$tagHandler protected_oe property

TagHandler instance

protected TagHandler,Xpressengine\Tag $tagHandler
Résultat	Xpressengine\Tag\TagHandler