dotkernel/dot-navigation

DotKernel navigation component

dot-navigation

, _(*1)

, _(*2)

, _(*3)

, _(*4)

Allows you to easily define and parse menus inside templates, configuration based approach., _(*5)

Installation

Run, _(*6)

composer require dotkernel/dot-navigation

Merge ConfigProvider to your application's configuration., _(*7)

The package uses dot-helpers package, please merge dot-helpers ConfigProvider to your application's configuration also, if it's not merged already!, _(*8)

Register NavigationMiddleware in your middleware pipe between the routing and the dispatching middleware., _(*9)

Configuration

Locate dot-navigation's distributable config file vendor/dotkernel/dot-navigation/config/autoload/navigation.global.php.dist and duplicate it in your project as config/autoload/navigation.global.php, _(*10)

Components

A menu, or navigation container, is a class implementing the \RecursiveIterator interface. It has a hierarchical structure, with nodes called pages(see the Page class) that may have children. It is basically a tree, _(*11)

A Page extends the NavigationContainer class. The NavigationContainer is the top most node which represents the entire menu. The children of this node are Page instances that defines each navigation item., _(*12)

A page has a reference to its parent, and can have options and attributes. There are no limitation on what is accepted as options or attributes., _(*13)

Options can be any piece of information that describes a page. Some predefined options exists, in order for the navigation module to work seamlessly with other dot modules., _(*14)

Attributes are key value pairs that defines the menu item. They are usually inserted as html attributes when parsing the menu, but of course, this is implementation specific., _(*15)

A NavigationService class, is the service that handles all defined menu container. It can fetch the container from its provider, check if a page is active or not and get the page's generated URI., _(*16)

Container providers

Each menu can be created from different sources. The responsibility of creating a menu container from the source falls on a container provider., _(*17)

Each provider must implement the interface ProviderInterface and be registered in the ProviderPluginManager., _(*18)

We offer just one provider for now, ArrayProvider, that is able to fetch and create a menu container from a php array that is defined in the configuration file., _(*19)

NavigationRenderer

Used to render the navigation container in a displayable format. It can render a simple HTML ul list or use a partial template, to render the menu in a template engine., _(*20)

The partial method is usually the more flexible one, custom rules can be defined and checked in the template., _(*21)

If you are using twig, there is already a twig extension provided in package dot-twigrenderer, that you can use to easily parse the menus inside your templates, _(*22)

When using the partial method, the template will receive as parameters the container, the navigation service and any extra parameters set by the developer., _(*23)

Navigation containers are referred, when parsed, by their name, as defined in the configuration file., _(*24)

Required page options and attributes

The following are options that each page should define in the configuration, _(*25)

• label - the text of the menu item
• route or uri - defines the route or link the menu item will have
• permission - can be used optionally, if authorization service is present, in order to omit menu items that are not authorized to visit.