How to override Navigation or Menu View Helper Plugin

Questions Components & MVC
,
9

To be clear in this case: there is only one proxy helper and this is Laminas\View\Helper\Navigation. This helper creates no output, it is the interface to concrete navigation helpers Breadcrumbs, Menu, Links and Sitemap.

This proxy helper uses internally a plugin manager to hold the concrete helpers. If you want to override or to add new helpers to this proxy helper, then these custom helpers must be set to the plugin manager.
The proxy helper will find the helper via the internal plugin manager and you can work with them.

Example

Custom helper

module/Application/src/Navigation/CustomMenuHelper.php:

namespace Application\Navigation;

use Laminas\View\Helper\Navigation\Menu;

class CustomMenuHelper extends Menu
{
    public function renderMenu($container = null, array $options = []): string
    {
        var_dump('Custom');
        
        return parent::renderMenu(
            $container,
            $options
        );
    }
}

Delegator

module/Application/src/Navigation/NavigationHelperDelegator.php:

namespace Application\Navigation;

use Laminas\View\Helper\Navigation as NavigationHelper;
use Laminas\View\Helper\Navigation\Menu;
use Psr\Container\ContainerInterface;

class NavigationHelperDelegator
{
    public function __invoke(
        ContainerInterface $container,
        string $name,
        callable $callback,
        array $options = null
    ): NavigationHelper {
        /** @var NavigationHelper $helper */
        $helper = $callback();

        // Override existing menu helper
        $helper->getPluginManager()->setInvokableClass(
            Menu::class,
            CustomMenuHelper::class
        );

        // Add new helper
        $helper->getPluginManager()->setInvokableClass(
            CustomMenuHelper::class,
            CustomMenuHelper::class
        );
        $helper->getPluginManager()->setAlias(
            'customMenu',
            CustomMenuHelper::class
        );

        return $helper;
    }
}

Layout Script

module/Application/view/layout/layout.phtml:

<?= $this->navigation()->menu() ?>

<?= $this->navigation()->customMenu() ?>

This produces the same output.

I hope the example is not so abstract this time. :wink: