1. class
  2. Xpressengine
  3. Editor
  4. AbstractTool

AbstractTool

abstract class AbstractTool implements ComponentInterface, JsonSerializable

Class AbstractTool

Traits

Xpressengine\Plugin\ComponentTrait
ComponentInterface를 구현한 Trait

Properties

static private array $id Component id, 만약 이 trait을 사용한 클래스를 상속한 클래스가 id를 지정하지 않았다면, 그 클래스의 id는 이 trait에서 가지고 있는 id에 저장된다. from ComponentTrait
static private array $componentInfo Component Informations, 만약 이 trait을 사용한 클래스를 상속한 클래스가 componentInfo를 지정하지 않았다면, 그 클래스의 infomation은 이 trait에서 가지고 있는 componentInfo에 저장된다. from ComponentTrait
protected string $instanceId Instance identifier

Methods

static string
getId()

component의 id를 반환한다.

from ComponentTrait
static void
setId(string $id)

component의 id를 지정한다.

from ComponentTrait
static mixed
getComponentInfo(string $key = null)

information을 검색한다.

from ComponentTrait
static void
setComponentInfo(string $key, mixed $value = null)

information을 추가하거나 수정한다.

from ComponentTrait
static void
boot()

boot

from ComponentTrait
static null|string
getSettingsURI()

return settings manage uri

from ComponentTrait
__construct(string $instanceId)

AbstractTool constructor.

void
initAssets()

Initialize assets for the tool

array
getIcon()

Get the tool's symbol

array
getOptions()

Get options for the tool

bool
enable()

Indicates if usable the tool

static string|null
getInstanceSettingURI(string $instanceId)

Get uri string for tool setting by instance identifier

string
compile(string $content)

Compile the raw content to be useful

mixed
jsonSerialize()

Convert the object into something JSON serializable.

Details

in ComponentTrait at line 51
static string getId()

component의 id를 반환한다.

Return Value

string

in ComponentTrait at line 67
static void setId(string $id)

component의 id를 지정한다.

Parameters

string $id 지정할 id

Return Value

void

in ComponentTrait at line 83
static mixed getComponentInfo(string $key = null)

information을 검색한다.

Parameters

string $key 검색할 information의 키

Return Value

mixed 검색된 information를 반환함.

in ComponentTrait at line 99
static void setComponentInfo(string $key, mixed $value = null)

information을 추가하거나 수정한다.

Parameters

string $key 추가하거나 수정할 information의 key
mixed $value 추가하거나 수정할 information의 value

Return Value

void

in ComponentTrait at line 119
static void boot()

boot

Return Value

void

in ComponentTrait at line 129
static null|string getSettingsURI()

return settings manage uri

Return Value

null|string

at line 45
__construct(string $instanceId)

AbstractTool constructor.

Parameters

string $instanceId Instance identifier

at line 55
abstract void initAssets()

Initialize assets for the tool

Return Value

void

at line 62
abstract array getIcon()

Get the tool's symbol

Return Value

array ['normal' => '...', 'large' => '...']

at line 69
array getOptions()

Get options for the tool

Return Value

array

at line 79
bool enable()

Indicates if usable the tool

Return Value

bool

at line 90
static string|null getInstanceSettingURI(string $instanceId)

Get uri string for tool setting by instance identifier

Parameters

string $instanceId instance identifier

Return Value

string|null

at line 101
abstract string compile(string $content)

Compile the raw content to be useful

Parameters

string $content content

Return Value

string

at line 108
mixed jsonSerialize()

Convert the object into something JSON serializable.

Return Value

mixed data which can be serialized by json_encode