[ { "path": ".gitignore", "content": ".DS_Store\nvendor\ndata\n" }, { "path": ".travis.yml", "content": "language: php\n\nphp:\n - 5.4\n - 5.5\n - 5.6\n - hhvm\n\nsudo: false\n\nbefore_script:\n - composer update\n" }, { "path": "README.md", "content": "# Menu\n\n[![Build Status](https://secure.travis-ci.org/vespakoen/menu.png?branch=master)](http://travis-ci.org/vespakoen/menu)\n[![Total Downloads](https://poser.pugx.org/vespakoen/menu/d/total.svg)](https://packagist.org/packages/vespakoen/menu)\n[![Latest Stable Version](https://poser.pugx.org/vespakoen/menu/v/stable.svg)](https://packagist.org/packages/vespakoen/menu)\n[![Latest Unstable Version](https://poser.pugx.org/vespakoen/menu/v/unstable.svg)](https://packagist.org/packages/vespakoen/menu)\n[![License](https://poser.pugx.org/vespakoen/menu/license.svg)](https://packagist.org/packages/vespakoen/menu)\n\n[API Docs](http://vespakoen.github.io/menu/)\n\nAre you the type of person that writes menus by hand in view files or do you find yourself looking for the best place to store links to pages on your website? then Menu is for you!\n\n# Quick overview example\n\n```php\n$menu = Menu::handler('mailbox'); \n\n// items\n$menu\n ->add('contacts', 'Contacts')\n ->add('inbox', 'Inbox')\n ->raw(null, null, ['class' => 'divider'])\n ->add('folders', 'Folders', Menu::items() \n ->prefixParents() \n ->add('urgent', 'Urgent') // with prefix: /folders/urgent\n ->add('sent', 'Sent')\n ->add('deleted', 'Deleted')\n );\n\n// styling\n$menu\n ->addClass('nav navbar-nav')\n ->getItemsByContentType(Menu\\Items\\Contents\\Link::class)\n ->map(function($item) {\n if ( $item->isActive() ) {\n $item->addClass('active');\n }\n });\n```\n\n`{!! $menu !!}` will output:\n\n```html\n\n```\n\n# Key concepts\n\n## Item lists\nAn item list is what a menu is all about and it should be pretty self explanatory because it simply stores a list of items.\nthere are some configurations available for an item list.\nYou can, for example set the HMTL element that will be used to render the list, prefix every item in the list with all the parent's url segments, and a lot more. We will explore these options later.\n\n## Menu handlers\nMenu handlers allow us to create and interact with item lists and act as a place to store and retrieve our menus.\nBecause we are able to interact with multiple item lists at the same time some interesting possibilities become available to us.\n\n## Items\nThe Menu package has 2 types of items available out of the box.\n\n- Link\n For creating links to other pages\n- Raw\n Be free to add anything you like in the item.\n This type is usually used for dividers, titles etc.\n\nThe HTML element and attributes for the item can also be changed, more on this topic later.\n\n# Installing\n\n## Laravel 3\n\nInstall Menu via the artisan command line tool. Open the terminal and navigate to your Laravel project's root.\nNow type the following command :\n\n```shell\nphp artisan bundle:install menu\n```\n\nTo let Laravel know the Laravel Menu package should be started, open up `application/packages.php` and add the following lines to the packages array.\n\n```php\n'menu' => array('auto' => true),\n```\n\n## Laravel 4\n\nAdd this to your `composer.json` file's `\"require\"` :\n\n```json\n\"vespakoen/menu\": \"2.*\"\n```\n\nAnd add the following to your `app/config/app.php` file :\n\n- In the Service Providers array : `'Menu\\MenuServiceProvider',`\n- In the aliases array : `'Menu' => 'Menu\\Menu',`\n\n## Laravel 5\n\nAdd this to your `composer.json` file's `\"require\"` :\n\n```json\n\"vespakoen/menu\": \"3.*\"\n```\n\nAnd add the following to your `config/app.php` file :\n\n- In the Service Providers array : `'Menu\\MenuServiceProvider',`\n- In the aliases array : `'Menu' => 'Menu\\Menu',`\n\nLastly, run the following from your project's root dir:\n\n```\nphp artisan vendor:publish\n```\n\n# Basic usage\n\nFirst, let's load some pages into the menu.\nWe will do this by utilising the `hydrate` method.\n\n\n```php\nMenu::handler('main')->hydrate(function()\n {\n return Page::with('translation')\n ->where('group', '=', 'main')\n ->get();\n },\n function($children, $item)\n {\n $children->add($item->translation->slug, $item->translation->name, Menu::items($item->as));\n });\n\n/* the hydrate method takes these arguments\n $resolver Closure A callback to resolve results\n $decorator Closure A callback that gets called for every result fetched from the resolver with the corresponding ItemList and result as the arguments\n $idField integer (default = 'id') the property on the result that contains the id\n $parentIdField integer (default = 'parent_id') the property on the result that contains the parent id\n $parentId integer (default = 0) the parentId to start hydrating from\n*/\n```\n\nNow that we have loaded our pages into the menu, and even identified every menu item with a name (via `Menu::items($item->as)`) a lot of options are available to us.\n\nFind a node by it's name and add a subitem.\n```php\nMenu::find('users')\n ->add('users/create', 'Create new user');\n```\n\nAdd some properties to the root node\n```php\nMenu::handler('main')\n ->addClass('nav navbar-nav');\n```\n\nGet all `ItemList`s at a certain depth and add a class\n```php\nMenu::handler('main')\n ->getItemListsAtDepth(0)\n ->addClass('level-1');\n```\n\nGet all `ItemList`s at a depth range and change the element\n```php\nMenu::handler('main')\n ->getItemListsAtDepthRange(0,2)\n ->setElement('div');\n```\n\nGet all `Item`s at a certain depth and add a class\n```php\nMenu::handler('main')\n ->getItemsAtDepth(0)\n ->addClass('level-1');\n```\n\nGet `Item`s by it's content type and use the map function to walk over the results and perform actions based on gathered information\n```php\nMenu::handler('main')\n ->getItemsByContentType('Menu\\Items\\Contents\\Link')\n ->map(function($item)\n {\n if($item->isActive() && $item->hasChildren())\n {\n $item->addClass('is-active-link-with-children');\n }\n\n if($item->getContent()->getUrl() == 'home')\n {\n $item->addClass('is-home');\n }\n });\n```\n\nGet all `ItemList`s and add a class to them if they have children\n```php\nMenu::handler('main')\n ->getAllItemLists()\n ->map(function($itemList)\n {\n if($itemList->hasChildren())\n {\n $itemList->addClass('has-children');\n }\n });\n```\n\n# Breadcrumbs\n\nBreadcrumb hell is a thing of the past.\n\nBootstrap ready breadcrums are as easy as this\n```php\nMenu::handler('main')\n ->breadcrumbs()\n ->setElement('ol')\n ->addClass('breadcrumb');\n```\n\nThe breadcrumbs method searches all handlers and returns a plain old ItemList, that you can manipulate.\nIf you call the breadcrumbs method directly on the Menu class, it will search all your handlers for breadcrumbs, and by default will return the first match.\nHowever, there might be cases where you want to choose the breadcrumbs out of the ones it found, for this you can provide a callback method as the first argument.\n\nAnd example is shown below:\n```php\nMenu::breadcrumbs(function($itemLists)\n {\n return $itemLists[0]; // returns first match\n })\n ->setElement('ol')\n ->addClass('breadcrumb');\n```\n\n# Diving deeper\n\nThe Laravel Menu packages consists of a couple of classes, but you can interact with all of them via the _Menu_ class.\nLet's take a look at the **handler** method. it takes a string or an array as the only argument, the string(s) given are the names for the item lists we want to retrieve.\nIf an itemlist we asked for didn't exist yet, it will create it for us.\nAfter the menu class has found and created the item lists we want, it will hand back a menuhandler that handles the item lists we asked for.\n\n```php\n// Get a MenuHandler instance that handles an ItemList named \"main\"\nMenu::handler('main');\n```\n\nWhen we call a method on this menu handler, it will simply forward the call to all the item lists that it handles.\nIn order to find out what we can do now that we have a handler, we need to take a look at the methods on the ItemList class.\n\nThe _ItemList_ class has a method called **add** that you are probably going to use a lot. It adds an _Item_ of type \"link\" to the _ItemList_.\n\n```php\nMenu::handler('main')->add('home', 'Homepage');\n\n/* The add method takes these arguments\n $url string The URL to another page\n $title string The visible string on the link\n $children (default = null) ItemList (optional) The children of this page\n $link_attributes (default = array()) array (optional) HTML attributes for the element\n $item_attributes (default = array()) array (optional) HTML attributes for the list element (usually
  • )\n $item_element (default = 'li') string (optional) The type of the list element\n*/\n```\n\nLet's take a look at the **raw** method, for adding \"anything\" to the list.\n\n```php\nMenu::handler('main')->raw('');\n\n/* The raw method takes these arguments\n $html string The contents of the item\n $children (default = null) ItemList (optional) The children of this item\n $item_attributes (default = array()) array (optional) HTML attributes for the list element (usually
  • )\n $item_element (default = 'li') string (optional) The type of the list element\n*/\n```\n\nGreat! Now that we have learned how to add items to an item list, let's have a look at how we add children to a item.\nEvery item can have children, the children object is just another _ItemList_. As we have seen before, we can create item lists via the **handler** method, but this method returns a _MenuHandler_, making it unusable for item children.\nSo what do we use? the **items** method returns a fresh _ItemList_ object. Let's have a look.\n\n```php\nMenu::handler('main')\n ->add('home', 'Homepage', Menu::items()\n ->add('sub-of-home', 'Sub of homepage'));\n\n/* The items method takes these arguments\n $name (default = null) string (optional) The name (=identifier) of this ItemList\n $attributes (default = array()) array (optional) HTML attributes for the ItemList element (usually