PHP 클래스 Xpressengine\Editor\AbstractTool

저자: XE Developers ([email protected])
상속: implements Xpressengine\Plugin\ComponentInterface, implements JsonSerializable, use trait Xpressengine\Plugin\ComponentTrait
파일 보기 프로젝트 열기: xpressengine/xpressengine

보호된 프로퍼티들

프로퍼티 타입 설명
$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