Iatstuti\SimpleMenu\Menu

Complexity

Total Complexity

9

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	7
Bugs	0	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	label()	0	4	1
A	link()	0	8	1
A	items()	0	6	1
A	sortItems()	0	6	1
A	subMenu()	0	6	1
A	render()	0	8	2
A	__toString()	0	4	1

<?php

namespace Iatstuti\SimpleMenu;

use Iatstuti\SimpleMenu\Presenters\MenuPresenter;
use Iatstuti\SimpleMenu\Presenters\UnorderedListPresenter;
use Iatstuti\SimpleMenu\Traits\FetchesWeight;
use Iatstuti\SimpleMenu\Traits\ObjectOptions;
use Iatstuti\Support\Traits\MethodPropertyAccess;
use Illuminate\Support\Collection;

/**
 * POPO object to wrap a menu collection.
 *
 * @package    Iatstuti\SimpleMenu
 * @copyright  2016 IATSTUTI
 * @author     Michael Dyrynda <michael@iatstuti.net>
 *
 * @property   string $label The menu label
 * @property   array $options The menu options
 */
class Menu
{

    use MethodPropertyAccess, ObjectOptions, FetchesWeight;

    /**
     * Store the menu items.
     *
     * @var \Illuminate\Support\Collection
     */
    protected $items;

    /**
     * Store the menu label.
     *
     * @var null|string
     */
    protected $label;

    /**
     * @var array
     */
    private $options;


    /**
     * Menu constructor.
     *
     * @param  string|null $label
     * @param  array $options
     */
    public function __construct($label = null, array $options = [ ])
    {
        $this->label   = $label;
        $this->items   = new Collection();
        $this->options = array_merge([ 'weight' => 0, ], $options);
    }


    /**
     * Return this menu's label.
     *
     * @return null|string
     */
    public function label()
    {
        return $this->label;
    }


    /**
     * Add a new link to the menu.
     *
     * @param  string $item
     * @param  string $link
     * @param  array $options
     *
     * @return \Iatstuti\SimpleMenu\MenuItem
     */
    public function link($item, $link, array $options = [ ])
    {
        $item = new MenuItem($item, $link, $options);

        $this->items()->push($item);

        return $item;
    }


    /**
     * Return this menu's items.
     *
     * @return \Illuminate\Support\Collection
     */
    public function items()
    {
        $this->sortItems();

        return $this->items;
    }


    /**
     * Sort the menu items by their weight.
     *
     * @return void
     */
    private function sortItems()
    {
        $this->items = $this->items->sortBy(function ($item) {
            return $item->weight;
        });
    }


    /**
     * Add a new sub menu item to the menu.
     *
     * @param  \Iatstuti\SimpleMenu\Menu $menu
     *
     * @return \Iatstuti\SimpleMenu\Menu
     */
    public function subMenu(Menu $menu)
    {
        $this->items->push($menu);

        return $menu;
    }


    /**
     * Render the menu using the given presenter,
     * or the default UnorderedListPresenter.
     *
     * @param  \Iatstuti\SimpleMenu\Presenters\MenuPresenter|null $presenter
     *
     * @return string
     */
    public function render(MenuPresenter $presenter = null)
    {
        $this->sortItems();

        $presenter = $presenter ?: new UnorderedListPresenter($this);

        return $presenter->render();
    }


    /**
     * Overload the __toString method to be able to
     * print this object using the render method.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->render();
    }
}