You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
85 lines
2.6 KiB
85 lines
2.6 KiB
9 years ago
|
KnpMenu
|
||
|
|
=======
|
||
|
|
|
||
|
|
The KnpMenu library provides object oriented menus for PHP 5.3.
|
||
|
|
It is used by the [KnpMenuBundle](https://github.com/KnpLabs/KnpMenuBundle) for Symfony2
|
||
|
|
but can now be used stand-alone.
|
||
|
|
|
||
|
|
[](http://travis-ci.org/KnpLabs/KnpMenu)
|
||
|
|
[](https://packagist.org/packages/knplabs/knp-menu)
|
||
|
|
[](https://packagist.org/packages/knplabs/knp-menu)
|
||
|
|
[](https://gitter.im/KnpLabs/KnpMenu)
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
KnpMenu uses Composer, please checkout the [composer website](http://getcomposer.org) for more information.
|
||
|
|
|
||
|
|
The simple following command will install `knp-menu` into your project. It also add a new
|
||
|
|
entry in your `composer.json` and update the `composer.lock` as well.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ composer require knplabs/knp-menu
|
||
|
|
```
|
||
|
|
|
||
|
|
> KnpMenu follows the PSR-0 convention names for its classes, which means you can easily integrate `knp-menu` classes loading in your own autoloader.
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
```php
|
||
|
|
<?php
|
||
|
|
|
||
|
|
// Include dependencies installed with composer
|
||
|
|
require 'vendor/autoload.php';
|
||
|
|
|
||
|
|
use Knp\Menu\MenuFactory;
|
||
|
|
use Knp\Menu\Renderer\ListRenderer;
|
||
|
|
|
||
|
|
$factory = new MenuFactory();
|
||
|
|
$menu = $factory->createItem('My menu');
|
||
|
|
$menu->addChild('Home', array('uri' => '/'));
|
||
|
|
$menu->addChild('Comments', array('uri' => '#comments'));
|
||
|
|
$menu->addChild('Symfony2', array('uri' => 'http://symfony-reloaded.org/'));
|
||
|
|
$menu->addChild('Coming soon');
|
||
|
|
|
||
|
|
$renderer = new ListRenderer(new \Knp\Menu\Matcher\Matcher());
|
||
|
|
echo $renderer->render($menu);
|
||
|
|
```
|
||
|
|
|
||
|
|
The above menu would render the following HTML:
|
||
|
|
|
||
|
|
```html
|
||
|
|
<ul>
|
||
|
|
<li class="first">
|
||
|
|
<a href="/">Home</a>
|
||
|
|
</li>
|
||
|
|
<li class="current">
|
||
|
|
<a href="#comments">Comments</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="http://symfony-reloaded.org/">Symfony2</a>
|
||
|
|
</li>
|
||
|
|
<li class="last">
|
||
|
|
<span>Coming soon</span>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
```
|
||
|
|
|
||
|
|
This way you can finally avoid writing an ugly template to show the selected item,
|
||
|
|
the first and last items, submenus, ...
|
||
|
|
|
||
|
|
> The bulk of the documentation can be found in the `doc` directory.
|
||
|
|
|
||
|
|
## What now?
|
||
|
|
|
||
|
|
Follow the tutorial in [`doc/01-Basic-Menus.markdown`][0] and [`doc/02-Twig-Integration.markdown`][1]
|
||
|
|
to discover how KnpMenu will rock your world!
|
||
|
|
|
||
|
|
## Credits
|
||
|
|
|
||
|
|
This bundle was originally ported from [ioMenuPlugin](http://github.com/weaverryan/ioMenuPlugin),
|
||
|
|
a menu plugin for symfony1. It has since been developed by [KnpLabs](http://www.knplabs.com) and
|
||
|
|
the Symfony community.
|
||
|
|
|
||
|
|
[0]: doc/01-Basic-Menus.markdown
|
||
|
|
[1]: doc/02-Twig-Integration.markdown
|