Skip to content
  • Documentation >
  • Administration >
  • Back office >
  • Integrated help >
  • Customize integrated help

Customize integrated help

The integrated help menu is part of the Integrated help introduced as an LTS Update. By default, it provides editors and developers with convenient access to documentation, training and other resources directly from the back office.

You can extend or modify the integrated menu in two ways:

  • by modifying a link to user documentation in a yaml file
  • by subscribing to the ibexa_integrated_help.menu_configure.help_menu event

Ibexa DXP provides a comfortable method for replacing a link to user documentation, when you do not want to modify the rest of the integrated help menu. This way you can direct application users such as editors or store managers to specific guidelines in force at your organization, without having to resort to development.

To do in, in config/packages create the ibexa_integrated_help.yaml file, with the following configuration:

1
2
ibexa_integrated_help:
    user_documentation: <https://custom.user.documentation.address>

Intercept and modify event

Ibexa DXP uses KnpMenuBundle to build its backend menus. When it builds the integrated help menu, it dispatches the ibexa_integrated_help.menu_configure.help_menu event to pass information about the contents of the help menu to the front end.

You can intercept this event, and change its contents by creating a subscriber. With that subscriber, you can access the menu object, which is an instance of the Knp\Menu\MenuItem, and all the options passed by this object, and modify them. This way you can adjust menu sections that are reproduced by the front end as tabs, add new items, or integrate custom links into the help system.

The default menu object is structured as follows. Recreate this pattern when modifying an existing event with an intention to send it to the front end.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
root (MenuItem)
│
├── help__general // ("General" section)
│   ├── help__user_documentation // (User docs, highlighted menu option)
│   │   (...)
│   └── help__submit_idea // (Submit idea, regular option)
│
└── help__developers // (conditional "Developers" section)
    ├── help__developer_documentation // (Developer docs, highlighted)
    │   (...)
    └── help__support_portal

help_general and help_developers are menu sections, or tabs. Sections consist of entries, and each entry carries the following information:

  • label - a name of the help menu item
  • uri - an external link to the resource
  • isHighlighted - a Boolean switch that decides whether the menu item should be placed at the top of the tab
  • icon - a link to a graphic file to accompany the menu item
  • description - a summary of what users can expect after clicking the menu item

Create a subscriber

Build a subscriber that intercepts the event and modifies it. In this example, it removes a product roadmap entry from the menu and adds a help menu tab with links to product videos. The tab is displayed in a production environment only.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<?php

declare(strict_types=1);

namespace App\EventSubscriber;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Contracts\EventDispatcher\Event;

final class HelpMenuSubscriber implements EventSubscriberInterface
{
    public function __construct(
        private readonly bool $kernelDebug
    ) {
    }

    public static function getSubscribedEvents(): array
    {
        return [
            'ibexa_integrated_help.menu_configure.help_menu' => 'onHelpMenuConfigure',
        ];
    }

    public function onHelpMenuConfigure(Event $event): void
    {
        $menu = $event->getMenu();

        // Remove roadmap menu item
        if ($menu->getChild('help__general')) {
            $generalSection = $menu->getChild('help__general');
            if ($generalSection->getChild('help__product_roadmap')) {
                $generalSection->removeChild('help__product_roadmap');
            }
        }

        // Add videos tab, shown only in production
        if ($this->kernelDebug === false) {
            $resourcesSection = $menu->addChild('help__videos', [
                'label' => 'Product videos',
            ]);

            $resourcesSection->addChild('help__webinar_v5', [
                'label' => 'Webinar: Introducing Ibexa DXP v5',
                'uri' => 'https://www.youtube.com/watch?v=qWaBHG2LRm8',
                'extras' => [
                    'isHighlighted' => false,
                    'icon' => 'https://doc.ibexa.co/en/5.0/templating/twig_function_reference/img/icons/video.svg.png',
                    'description' => 'Discover new features and improvements brought by Ibexa DXP v5.',
                ],
            ]);
        }
    }
}

Tip

If autoconfigure is enabled, the event subscriber is registered as a service by default. If not, register it as a service and tag with kernel.event.subscriber.

1
2
3
4
5
6
services:
    App\EventSubscriber\HelpMenuSubscriber:
        arguments:
            $kernelDebug: '%kernel.debug%'
        tags:
            - { name: kernel.event_subscriber }

For more ideas on how you can extend the help menu, see Back office menus.