PHP Class Xpressengine\Editor\AbstractTool

Author: XE Developers ([email protected])

Inheritance: implements Xpressengine\Plugin\ComponentInterface, implements JsonSerializable, use trait Xpressengine\Plugin\ComponentTrait

Protected Properties

Property	Type	Description
$instanceId	string	Instance identifier

Method	Description
__construct ( string $instanceId )	AbstractTool constructor.
compile ( string $content ) : string	Compile the raw content to be useful
enable ( ) : boolean	Indicates if usable the tool
getIcon ( ) : array	Get the tool's symbol
getInstanceSettingURI ( string $instanceId ) : string \| null	Get uri string for tool setting by instance identifier
getOptions ( ) : array	Get options for the tool
initAssets ( ) : void	Initialize assets for the tool
jsonSerialize ( ) : mixed	Convert the object into something JSON serializable.

AbstractTool constructor.

public __construct ( string $instanceId )
$instanceId	string	Instance identifier

Compile the raw content to be useful

abstract public compile ( string $content ) : string
$content	string	content
return	string

Indicates if usable the tool

public enable ( ) : boolean
return	boolean

Get the tool's symbol

abstract public getIcon ( ) : array
return	array	['normal' => '...', 'large' => '...']

Get uri string for tool setting by instance identifier

public static getInstanceSettingURI ( string $instanceId ) : string \| null
$instanceId	string	instance identifier
return	string \| null

Get options for the tool

public getOptions ( ) : array
return	array

Initialize assets for the tool

abstract public initAssets ( ) : void
return	void

Convert the object into something JSON serializable.

public jsonSerialize ( ) : mixed
return	mixed	data which can be serialized by json_encode

Instance identifier

protected string $instanceId
return	string