PHP Class Xpressengine\ToggleMenu\AbstractToggleMenu

Author: XE Developers ([email protected])
Inheritance: implements Xpressengine\Plugin\ComponentInterface, use trait Xpressengine\Plugin\ComponentTrait
Show file Open project: xpressengine/xpressengine

Protected Properties

Property Type Description
$componentType string
$identifier string
$instanceId string

Public Methods

Method Description
allows ( ) : boolean 메뉴에 표시여부 반환 표실 할 경우 true 반환
boot ( ) : void boot
getAction ( ) : string 실행되기 위한 js 문자열 타입이 'raw' 인 경우에는 html
getDescription ( ) : mixed getDescription
getIcon ( ) : string | null 아이콘을 표시하기 위한 문자 todo: class 명, 이미지 경로 등을 지원 할 예정
getScreenshot ( ) : mixed getScreenshot
getScript ( ) : string | null 별도의 js 파일을 load 해야 하는 경우 해당 파일의 경로 없는 경우 null 반환
getText ( ) : string 메뉴에서 보여질 문자열
getTitle ( ) : mixed getTitle
getType ( ) : string 메뉴의 타입 'exec' or 'link' or 'raw' 중에 하나
setArguments ( string $componentType, string $instanceId, string $identifier ) : void Set basic arguments

Method Details

allows() public method

메뉴에 표시여부 반환 표실 할 경우 true 반환
public allows ( ) : boolean
return boolean

boot() public static method

boot
public static boot ( ) : void
return void

getAction() abstract public method

실행되기 위한 js 문자열 타입이 'raw' 인 경우에는 html
abstract public getAction ( ) : string
return string

getDescription() public static method

getDescription
public static getDescription ( ) : mixed
return mixed

getIcon() public method

아이콘을 표시하기 위한 문자 todo: class 명, 이미지 경로 등을 지원 할 예정
public getIcon ( ) : string | null
return string | null

getScreenshot() public static method

getScreenshot
public static getScreenshot ( ) : mixed
return mixed

getScript() abstract public method

별도의 js 파일을 load 해야 하는 경우 해당 파일의 경로 없는 경우 null 반환
abstract public getScript ( ) : string | null
return string | null

getText() abstract public method

메뉴에서 보여질 문자열
abstract public getText ( ) : string
return string

getTitle() public static method

getTitle
public static getTitle ( ) : mixed
return mixed

getType() abstract public method

메뉴의 타입 'exec' or 'link' or 'raw' 중에 하나
abstract public getType ( ) : string
return string

setArguments() public method

Set basic arguments
public setArguments ( string $componentType, string $instanceId, string $identifier ) : void
$componentType string target type, component id
$instanceId string instance id
$identifier string target identifier
return void

Property Details

$componentType protected property

protected string $componentType
return string

$identifier protected property

protected string $identifier
return string

$instanceId protected property

protected string $instanceId
return string