PHP Class Xpressengine\ToggleMenu\ToggleMenuHandler

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

See link: https://xpressengine.io

Author: XE Developers ([email protected])

Show file Open project: xpressengine/xpressengine Class Usage Examples

Protected Properties

Property	Type	Description
$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

Public Methods

Method	Description
__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	사용할 아이템들을 설정에 저장

Private Methods

Method	Description
getTypeKey ( string $id ) : string	register 에서 구분할 수 있는 type key 반환

Method Details

__construct() public method

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() public method

type 에 해당하는 모든 메뉴 아이템목록을 반환

public all ( string $id ) : array
$id	string	target plugin id
return	array

getActivated() public method

활성화된 아이템 목록을 반환

public getActivated ( string $id, string \| null $instanceId = null ) : array
$id	string	target plugin id
$instanceId	string \| null	instance id
return	array

getConfigKey() public method

config 에서 사용할 key 반환

public getConfigKey ( string $id, string \| null $instanceId ) : string
$id	string	target plugin id
$instanceId	string \| null	instance id
return	string

getDeactivated() public method

활성화 되지 않은 아이템 목록을 반환

public getDeactivated ( string $id, string \| null $instanceId = null ) : array
$id	string	target plugin id
$instanceId	string \| null	instance id
return	array

getItems() public method

사용할 메뉴 아이템들을 반환

public getItems ( string $id, string $instanceId = null, string $identifier = null ) : AbstractToggleMenu[]
$id	string	target plugin id
$instanceId	string	instance id
$identifier	string	target identifier
return	AbstractToggleMenu[]

setActivates() public method

사용할 아이템들을 설정에 저장

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
return	Xpressengine\Config\ConfigEntity

Property Details

$cfg protected property

Xe config instance

protected ConfigManager,Xpressengine\Config $cfg
return	Xpressengine\Config\ConfigManager

$container protected property

Container instance

protected Container,Illuminate\Contracts\Container $container
return	Illuminate\Contracts\Container\Container

$register protected property

protected PluginRegister,Xpressengine\Plugin $register
return	Xpressengine\Plugin\PluginRegister

$suffix protected static property

Type suffix for register

protected static string $suffix
return	string