PHP 클래스 Xpressengine\ToggleMenu\ToggleMenuHandler

### app binding : xe.toggleMenu 로 바인딩 되어 있음 XeToggleMenu Facade 로 접근 가능 ### Usage toggle menu 는 'PluginRegister' 를 통해 추가 됩니다. php app('xe.pluginRegister')->add(SampleItem::class); 위 예에서 SampleItemAbstractToggleMenu 상속받아 구현되어야 합니다. 등록되어진 후 설정을 통해 활성화된 아이템들을 반환 받아 사용할 수 있게 됩니다. php $menuItems = XeToggleMenu::getItems('pluginId'); 인스턴스로 구분되어지는 대상은 해당 인스턴스 아이디가 전달되어야 합니다. $menuItems = XeToggleMenu::getItems('pluginId', 'instanceId'); action 을 실행할 대상의 고유 아이디가 넘겨지면 각 아이템이 사용 가능하도록 객체 생성시 다시 전달 됩니다. $menuItems = XeToggleMenu::getItems('pluginId', 'instanceId', 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx');
저자: XE Developers ([email protected])
파일 보기 프로젝트 열기: xpressengine/xpressengine 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$cfg Xpressengine\Config\ConfigManager Xe config instance
$container Illuminate\Contracts\Container\Container Container instance
$register Xpressengine\Plugin\PluginRegister Register instance
$suffix string Type suffix for register

공개 메소드들

메소드 설명
__construct ( PluginRegister $register, ConfigManager $cfg, Illuminate\Contracts\Container\Container $container ) Constructor
all ( string $id ) : array type 에 해당하는 모든 메뉴 아이템목록을 반환
getActivated ( string $id, string | null $instanceId = null ) : array 활성화된 아이템 목록을 반환
getConfigKey ( string $id, string | null $instanceId ) : string config 에서 사용할 key 반환
getDeactivated ( string $id, string | null $instanceId = null ) : array 활성화 되지 않은 아이템 목록을 반환
getItems ( string $id, string $instanceId = null, string $identifier = null ) : AbstractToggleMenu[] 사용할 메뉴 아이템들을 반환
setActivates ( string $id, string | null $instanceId = null, array $keys = [] ) : ConfigEntity 사용할 아이템들을 설정에 저장

비공개 메소드들

메소드 설명
getTypeKey ( string $id ) : string register 에서 구분할 수 있는 type key 반환

메소드 상세

__construct() 공개 메소드

Constructor
public __construct ( PluginRegister $register, ConfigManager $cfg, Illuminate\Contracts\Container\Container $container )
$register Xpressengine\Plugin\PluginRegister Register instance
$cfg Xpressengine\Config\ConfigManager Xe config instance
$container Illuminate\Contracts\Container\Container Container instance

all() 공개 메소드

type 에 해당하는 모든 메뉴 아이템목록을 반환
public all ( string $id ) : array
$id string target plugin id
리턴 array

getActivated() 공개 메소드

활성화된 아이템 목록을 반환
public getActivated ( string $id, string | null $instanceId = null ) : array
$id string target plugin id
$instanceId string | null instance id
리턴 array

getConfigKey() 공개 메소드

config 에서 사용할 key 반환
public getConfigKey ( string $id, string | null $instanceId ) : string
$id string target plugin id
$instanceId string | null instance id
리턴 string

getDeactivated() 공개 메소드

활성화 되지 않은 아이템 목록을 반환
public getDeactivated ( string $id, string | null $instanceId = null ) : array
$id string target plugin id
$instanceId string | null instance id
리턴 array

getItems() 공개 메소드

사용할 메뉴 아이템들을 반환
public getItems ( string $id, string $instanceId = null, string $identifier = null ) : AbstractToggleMenu[]
$id string target plugin id
$instanceId string instance id
$identifier string target identifier
리턴 AbstractToggleMenu[]

setActivates() 공개 메소드

사용할 아이템들을 설정에 저장
public setActivates ( string $id, string | null $instanceId = null, array $keys = [] ) : ConfigEntity
$id string target plugin id
$instanceId string | null instance id
$keys array menu item keys
리턴 Xpressengine\Config\ConfigEntity

프로퍼티 상세

$cfg 보호되어 있는 프로퍼티

Xe config instance
protected ConfigManager,Xpressengine\Config $cfg
리턴 Xpressengine\Config\ConfigManager

$container 보호되어 있는 프로퍼티

Container instance
protected Container,Illuminate\Contracts\Container $container
리턴 Illuminate\Contracts\Container\Container

$register 보호되어 있는 프로퍼티

Register instance
protected PluginRegister,Xpressengine\Plugin $register
리턴 Xpressengine\Plugin\PluginRegister

$suffix 보호되어 있는 정적으로 프로퍼티

Type suffix for register
protected static string $suffix
리턴 string