PHP Interface Xpressengine\Menu\MenuType\MenuTypeInterface

See link: https://xpressengine.io
Deprecation: remove
Author: XE Developers ([email protected])
Show file Open project: xpressengine/xpressengine

Public Methods

Method Description
createMenuForm ( ) : mixed Return Create Form View
deleteMenu ( string $instanceId ) : mixed Process to delete
editMenuForm ( string $instanceId ) : mixed Return Edit Form View
getInstanceSettingURI ( string $instanceId ) : mixed Return URL about module's detail setting getInstanceSettingURI
getTypeItem ( string $id ) : mixed Get menu type's item object
isRouteAble ( ) : mixed Return this module is route able or unable isRouteAble
storeMenu ( string $instanceId, array $menuTypeParams, array $itemParams ) : mixed Process to Store
summary ( string $instanceId ) : string displayed message when menu is deleted.
updateMenu ( string $instanceId, array $menuTypeParams, array $itemParams ) : mixed Process to Update

Method Details

createMenuForm() public method

Return Create Form View
public createMenuForm ( ) : mixed
return mixed

deleteMenu() public method

Process to delete
public deleteMenu ( string $instanceId ) : mixed
$instanceId string to delete instance id
return mixed

editMenuForm() public method

Return Edit Form View
public editMenuForm ( string $instanceId ) : mixed
$instanceId string to edit instance id
return mixed

getInstanceSettingURI() public static method

Return URL about module's detail setting getInstanceSettingURI
public static getInstanceSettingURI ( string $instanceId ) : mixed
$instanceId string instance id
return mixed

getTypeItem() public method

Get menu type's item object
public getTypeItem ( string $id ) : mixed
$id string item id of menu type
return mixed

isRouteAble() public static method

Return this module is route able or unable isRouteAble
public static isRouteAble ( ) : mixed
return mixed

storeMenu() public method

Process to Store
public storeMenu ( string $instanceId, array $menuTypeParams, array $itemParams ) : mixed
$instanceId string to store instance id
$menuTypeParams array for menu type store param array
$itemParams array except menu type param array
return mixed

summary() public method

displayed message when menu is deleted.
public summary ( string $instanceId ) : string
$instanceId string to summary before deletion instance id
return string

updateMenu() public method

Process to Update
public updateMenu ( string $instanceId, array $menuTypeParams, array $itemParams ) : mixed
$instanceId string to update instance id
$menuTypeParams array for menu type update param array
$itemParams array except menu type param array
return mixed