PHP Class Xpressengine\Editor\AbstractTool

See link: https://xpressengine.io
Author: XE Developers ([email protected])
Inheritance: implements Xpressengine\Plugin\ComponentInterface, implements JsonSerializable, use trait Xpressengine\Plugin\ComponentTrait
Afficher le fichier Open project: xpressengine/xpressengine

Protected Properties

Свойство Type Description
$instanceId string Instance identifier

Méthodes publiques

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

Method Details

__construct() public méthode

AbstractTool constructor.
public __construct ( string $instanceId )
$instanceId string Instance identifier

compile() abstract public méthode

Compile the raw content to be useful
abstract public compile ( string $content ) : string
$content string content
Résultat string

enable() public méthode

Indicates if usable the tool
public enable ( ) : boolean
Résultat boolean

getIcon() abstract public méthode

Get the tool's symbol
abstract public getIcon ( ) : array
Résultat array ['normal' => '...', 'large' => '...']

getInstanceSettingURI() public static méthode

Get uri string for tool setting by instance identifier
public static getInstanceSettingURI ( string $instanceId ) : string | null
$instanceId string instance identifier
Résultat string | null

getOptions() public méthode

Get options for the tool
public getOptions ( ) : array
Résultat array

initAssets() abstract public méthode

Initialize assets for the tool
abstract public initAssets ( ) : void
Résultat void

jsonSerialize() public méthode

Convert the object into something JSON serializable.
public jsonSerialize ( ) : mixed
Résultat mixed data which can be serialized by json_encode

Property Details

$instanceId protected_oe property

Instance identifier
protected string $instanceId
Résultat string