Installation

Standard Installation

To install the library use Composer:

$ composer require laminas/laminas-navigation

Installation for a Mezzio or laminas-mvc Application

Installation and Automated Configuration

The laminas-component-installer is the recommended installation method when using in a Mezzio-based or a laminas-mvc-based application. It will automatically inject the config-provider or the module in the configuration during the installation process.

Installation Requirements

The following descriptions depends on the laminas-component-installer component, so be sure to have it installed before getting started.

Global Installation

With a global installation of laminas-component-installer it can be used for all projects without a reinstallation.

$ composer global require laminas/laminas-component-installer

As Development Dependency

$ composer require --dev laminas/laminas-component-installer

Install laminas-navigation and Inject Configuration

To install the library use Composer:

$ composer require laminas/laminas-navigation

This will install an initial set of dependencies and it will also prompt to inject the component configuration.

  • For a Mezzio application, choose config/config.php.
  • For a laminas-mvc application, choose either modules.config.php or application.config.php.

If additional dependencies are to be installed, the option for other packages can be remembered.

Installation and Manual Configuration

If the installer is not used, the manual configuration is needed to add the component to the application.

Install laminas-navigation

To install the library use Composer:

$ composer require laminas/laminas-navigation

Manual Configuration for a Mezzio-based Application

Add the configuration provider of laminas-navigation to the configuration file, e.g. config/config.php:


$aggregator = new Laminas\ConfigAggregator\ConfigAggregator([
    // …
    Mezzio\ConfigProvider::class,
    Mezzio\Router\ConfigProvider::class,
    Laminas\Navigation\ConfigProvider, // Add this line
    // …
]);

Manual Configuration for a laminas-mvc-based Application

Add laminas-navigation as component at the top of the configuration file for modules, e.g. config/modules.config.php:


return [
    'Laminas\Navigation\Module', // Add this line
    'Laminas\Router',
    'Laminas\Session',
    'Laminas\Validator',
    'Application',
];

Found a mistake or want to contribute to the documentation? Edit this page on GitHub!