Ibexa >
Contracts >
AdminUi >
Menu >
AbstractFormContextMenuBuilder

AbstractFormContextMenuBuilder

AbstractFormContextMenuBuilder.php : 15 Copy path

Extends AbstractBuilder

Base builder for extendable AdminUI menus.

Properties¶

$eventDispatcher ¶

AbstractBuilder.php : 25 Copy path

protected EventDispatcherInterface $eventDispatcher

$factory ¶

AbstractBuilder.php : 22 Copy path

protected MenuItemFactoryInterface $factory

Methods¶

__construct() ¶

AbstractFormContextMenuBuilder.php : 19 Copy path

public __construct(MenuItemFactoryInterface $factory, EventDispatcherInterface $eventDispatcher, string $formName)

Parameters

Name	Type	Default value	Description
$factory	MenuItemFactoryInterface	-	-
$eventDispatcher	EventDispatcherInterface	-	-
$formName	string	-	-

build() ¶

AbstractBuilder.php : 72 Copy path

public build(array<string|int, mixed> $options) : ItemInterface

Parameters

Name	Type	Default value	Description
$options	array<string\|int, mixed>	-	-

Return values

ItemInterface

getTranslationMessages() ¶

AbstractFormContextMenuBuilder.php : 98 Copy path

public static getTranslationMessages() : array<string|int, Message>

Return values

array<string|int, Message>

createConfigureMenuEvent() ¶

AbstractBuilder.php : 62 Copy path

    
                        protected createConfigureMenuEvent(ItemInterface $menu[, array<string|int, mixed> $options = [] ]) : ConfigureMenuEvent

Parameters

Name	Type	Default value	Description
$menu	ItemInterface	-	-
$options	array<string\|int, mixed>	[]	-

Return values

ConfigureMenuEvent

createMenuItem() ¶

AbstractBuilder.php : 43 Copy path

    
                        protected createMenuItem(string $id[, array<string|int, mixed> $options = [] ]) : ItemInterface

Parameters

Name	Type	Default value	Description
$id	string	-	-
$options	array<string\|int, mixed>	[]	-

Return values

ItemInterface

createStructure() ¶

AbstractFormContextMenuBuilder.php : 51 Copy path

protected createStructure(array<string, mixed> $options) : ItemInterface

Parameters

Name	Type	Default value	Description
$options	array<string, mixed>	-	-

Return values

ItemInterface

dispatchMenuEvent() ¶

AbstractBuilder.php : 52 Copy path

protected dispatchMenuEvent(string $name, Event $event) : void

Parameters

Name	Type	Default value	Description
$name	string	-	-
$event	Event	-	-

getConfigureEventName() ¶

AbstractFormContextMenuBuilder.php : 39 Copy path

protected getConfigureEventName() : string

Return values

string

getSidebarActionMessage() ¶

AbstractFormContextMenuBuilder.php : 34 Copy path

protected static getSidebarActionMessage() : string

Return values

string

getSidebarType() ¶

AbstractFormContextMenuBuilder.php : 32 Copy path

protected abstract static getSidebarType() : string

Return values

string

should be lowercase alphanumeric + underscore (a-zA-Z0-9_) string