PHP Класс Xpressengine\Editor\AbstractTool

Автор: XE Developers ([email protected])
Наследование: implements Xpressengine\Plugin\ComponentInterface, implements JsonSerializable, use trait Xpressengine\Plugin\ComponentTrait
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$instanceId string Instance identifier

Открытые методы

Метод Описание
__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.

Описание методов

__construct() публичный Метод

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

compile() абстрактный публичный Метод

Compile the raw content to be useful
abstract public compile ( string $content ) : string
$content string content
Результат string

enable() публичный Метод

Indicates if usable the tool
public enable ( ) : boolean
Результат boolean

getIcon() абстрактный публичный Метод

Get the tool's symbol
abstract public getIcon ( ) : array
Результат array ['normal' => '...', 'large' => '...']

getInstanceSettingURI() публичный статический Метод

Get uri string for tool setting by instance identifier
public static getInstanceSettingURI ( string $instanceId ) : string | null
$instanceId string instance identifier
Результат string | null

getOptions() публичный Метод

Get options for the tool
public getOptions ( ) : array
Результат array

initAssets() абстрактный публичный Метод

Initialize assets for the tool
abstract public initAssets ( ) : void
Результат void

jsonSerialize() публичный Метод

Convert the object into something JSON serializable.
public jsonSerialize ( ) : mixed
Результат mixed data which can be serialized by json_encode

Описание свойств

$instanceId защищенное свойство

Instance identifier
protected string $instanceId
Результат string