1. class
  2. Xpressengine
  3. ToggleMenu
  4. AbstractToggleMenu

AbstractToggleMenu

abstract class AbstractToggleMenu implements ComponentInterface

Xpressengine plugin 의 toggle menu base class 정의

Traits

Xpressengine\Plugin\ComponentTrait
ComponentInterface를 구현한 Trait

Constants

MENUTYPE_EXEC

MENUTYPE_LINK

MENUTYPE_RAW

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 $componentType
protected string $instanceId
protected string $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

static null|string
getSettingsURI()

return settings manage uri

from ComponentTrait
static mixed
getTitle()

getTitle

static mixed
getDescription()

getDescription

static mixed
getScreenshot()

getScreenshot

void
setArguments(string $componentType, string $instanceId, string $identifier)

Set basic arguments

string
getText()

메뉴에서 보여질 문자열

string
getType()

메뉴의 타입 'exec' or 'link' or 'raw' 중에 하나

string
getAction()

실행되기 위한 js 문자열 타입이 'raw' 인 경우에는 html

string|null
getScript()

별도의 js 파일을 load 해야 하는 경우 해당 파일의 경로 없는 경우 null 반환

string|null
getIcon()

아이콘을 표시하기 위한 문자 todo: class 명, 이미지 경로 등을 지원 할 예정

bool
allows()

메뉴에 표시여부 반환 표실 할 경우 true 반환

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 105
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 60
static mixed getTitle()

getTitle

Return Value

mixed

at line 70
static mixed getDescription()

getDescription

Return Value

mixed

at line 80
static mixed getScreenshot()

getScreenshot

Return Value

mixed

at line 93
void setArguments(string $componentType, string $instanceId, string $identifier)

Set basic arguments

Parameters

string $componentType target type, component id
string $instanceId instance id
string $identifier target identifier

Return Value

void

at line 115
abstract string getText()

메뉴에서 보여질 문자열

Return Value

string

at line 123
abstract string getType()

메뉴의 타입 'exec' or 'link' or 'raw' 중에 하나

Return Value

string

at line 131
abstract string getAction()

실행되기 위한 js 문자열 타입이 'raw' 인 경우에는 html

Return Value

string

at line 139
abstract string|null getScript()

별도의 js 파일을 load 해야 하는 경우 해당 파일의 경로 없는 경우 null 반환

Return Value

string|null

at line 147
string|null getIcon()

아이콘을 표시하기 위한 문자 todo: class 명, 이미지 경로 등을 지원 할 예정

Return Value

string|null

at line 158
bool allows()

메뉴에 표시여부 반환 표실 할 경우 true 반환

Return Value

bool