abstract class AbstractModule implements ComponentInterface

Xpressengine plugin 의 Module base class 정의

Traits

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

Methods

static string
getId()

component의 id를 반환한다.

static void
setId(string $id)

component의 id를 지정한다.

static mixed
getComponentInfo(string $key = null)

information을 검색한다.

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

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

static void
boot()

boot

static null|string
getSettingsURI()

return settings manage uri

static mixed
getTitle()

getTitle

static mixed
getDescription()

getDescription

static mixed
getScreenshot()

getScreenshot

static boolean
isRouteAble()

Return this module is route able or unable isRouteAble

static mixed
getInstanceSettingURI(string $instanceId)

Return URL about module's detail setting getInstanceSettingURI

mixed
createMenuForm()

Return Create Form View

mixed
storeMenu(string $instanceId, array $menuTypeParams, array $itemParams)

Process to Store

mixed
editMenuForm(string $instanceId)

Return Edit Form View

mixed
updateMenu(string $instanceId, array $menuTypeParams, array $itemParams)

Process to Update

string
summary(string $instanceId)

displayed message when menu is deleted.

mixed
deleteMenu(string $instanceId)

Process to delete

mixed
getTypeItem(string $id)

Get menu type's item object

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

at line 69
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 39
static mixed getTitle()

getTitle

Return Value

mixed

at line 49
static mixed getDescription()

getDescription

Return Value

mixed

at line 59
static mixed getScreenshot()

getScreenshot

Return Value

mixed

at line 80
static boolean isRouteAble()

Return this module is route able or unable isRouteAble

Return Value

boolean

at line 93
static mixed getInstanceSettingURI(string $instanceId)

Return URL about module's detail setting getInstanceSettingURI

Parameters

string $instanceId instance id

Return Value

mixed

at line 102
abstract mixed createMenuForm()

Return Create Form View

Return Value

mixed

at line 115
abstract mixed storeMenu(string $instanceId, array $menuTypeParams, array $itemParams)

Process to Store

Parameters

string $instanceId to store instance id
array $menuTypeParams for menu type store param array
array $itemParams except menu type param array

Return Value

mixed

at line 124
abstract mixed editMenuForm(string $instanceId)

Return Edit Form View

Parameters

string $instanceId to edit instance id

Return Value

mixed

at line 137
abstract mixed updateMenu(string $instanceId, array $menuTypeParams, array $itemParams)

Process to Update

Parameters

string $instanceId to update instance id
array $menuTypeParams for menu type update param array
array $itemParams except menu type param array

Return Value

mixed

at line 146
abstract string summary(string $instanceId)

displayed message when menu is deleted.

Parameters

string $instanceId to summary before deletion instance id

Return Value

string

at line 155
abstract mixed deleteMenu(string $instanceId)

Process to delete

Parameters

string $instanceId to delete instance id

Return Value

mixed

at line 163
abstract mixed getTypeItem(string $id)

Get menu type's item object

Parameters

string $id item id of menu type

Return Value

mixed