README

Dynamic Navigation System for Zend Framework 2.

Introduction

The navigation component of Zend Framework 2 has a simple approach. It either uses config files with Array definition of menus or XML files with similar data to render or generate the menu. However, the most popular way in the web is to generate or get the menu items from db and manage them through a manageable interface. All popular CMS's like Wordpress, Joomla have this feature but building such menu with complex hierarchy is a huge performance load on any application. Zend Framework 2's Navigation component uses static definition of link for this very reasons.

Most of the solutions on the internet provide you with a way to get the list of menu menu at start-up but as I mentioned earlier it comes in the cost of huge performance load. This library however gives you the option to have a database managed Navigation System as well as remove the performance load by generating the navigation configuration file with a click of a button.

Requirements

ZfcBase (latest master).
nGenZfc (latest master)
[nGenZf2Entity] (https://github.com/nGen/Zf2Entity) (latest master)
TwbBundle (latest master)

Features

Create new navigation containers without having to create a Navigation Factory file every-time new menu should be created.
Navigation Management system with various features to create new containers as "Navigation Menus" and add various pages or link on them dynamically.
Three modes of every menu: Menu, Breadcrumbs and Site-map. You can choose to select which link to appear where as required.
Create Navigation Page on simple mode providing directly only the link or go to advanced mode and add all sorts of technical details like route and its parameters, target, position etc.
Management system of these menus and links with full functional CRUD features including enabling and disabling them.
Mock-up configuration to directly embed the navigation system within the admin route. It is totally optional.
Generates the Navigation Factory and Navigation Config for all the menu.
Full functional DB tables that supports all properties of ZF2's NavigationPage Object.

Installation

Main Setup

With composer

Add this project and ZfcBase in your composer.json:

"require": {
    "ngen/zf2navigation": "dev-master",
}

Now tell composer to download ZfcUser by running the command:
```
$ php composer.phar update
```

By cloning project

Install the ZF2Navigation ZF2 module by cloning it into ./vendor/.
Clone this project into your ./vendor/ directory.

Post installation

Enabling it in your application.config.phpfile.

<?php
return array(
    'modules' => array(
        // ...
        'ZfcBase',
        'nGen\Zfc',
		'nGen\Zf2Entity',
        'nGen\Zf2Navigation',
	    'TwbBundle',
    ),
    // ...
);

Then Import the SQL schema located in ./vendor/ngen/zf2navigation/data/schema.sql (if you installed using the Composer) or in ./vendor/zf2navigation/data/schema.sql.
Copy the nav.global.php and navigation folder from the ./vendor/ngen/zf2navigation/config directory into config/autoload directory and give it 777 permission.
Copy either zf2navigation.default.global.php.dist or zf2navigation.admin.global.php.dist from the ./vendor/ngen/zf2navigation/config directory into config/autoload directory and remove the .dist at the end of the file.
- zf2navigation.admin.global.php.dist: It contains route configuration with which you can directly embed the navigation management system into the admin route.
- zf2navigation.admin.global.php.dist: It contains default route configuration.
Lastly, it should have a working db connection to start creating and adding menus. Go ahead and configure DB Adapter for that.
We are all set, navigation to project/path/navigation or /project/path/admin/navigation depending on with configuration you used.

Author

Starx

Project Site

ngen / zf2navigation

Maintainers

Details