AppBundle\Menu\MenuItem

Complexity

Total Complexity

23

Size/Duplication

Total Lines	257
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getName()	0	4	1
A	setName()	0	5	1
A	getCaption()	0	4	1
A	setCaption()	0	5	1
A	getDescription()	0	4	1
A	setDescription()	0	5	1
A	getRouteName()	0	4	1
A	setRouteName()	0	5	1
A	getRouteParams()	0	4	1
A	setRouteParams()	0	5	1
A	getIcon()	0	4	1
A	setIcon()	0	5	1
A	getColor()	0	4	1
A	setColor()	0	5	1
A	getChildren()	0	4	1
A	addChild()	0	11	2
A	removeChild()	0	7	1
A	getParent()	0	4	1
A	setParent()	0	5	1
A	getPath()	0	12	2

<?php
/*
  ÁTICA - Aplicación web para la gestión documental de centros educativos

  Copyright (C) 2015-2016: Luis Ramón López López

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU Affero General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU Affero General Public License for more details.

  You should have received a copy of the GNU Affero General Public License
  along with this program.  If not, see [http://www.gnu.org/licenses/].
*/

namespace AppBundle\Menu;

class MenuItem
{
    const AT_THE_BEGINNING = 1;
    const AT_THE_END = 2;

    /**
     * @var string
     */
    protected $name;

    /**
     * @var string
     */
    protected $caption;

    /**
     * @var string
     */
    protected $description;

    /**
     * @var string
     */
    protected $routeName;

    /**
     * @var array
     */
    protected $routeParams = [];

    /**
     * @var string
     */
    protected $icon;

    /**
     * @var string
     */
    protected $color;

    /**
     * @var MenuItem[]
     */
    protected $children;

    /**
     * @var MenuItem|null
     */
    protected $parent;

    /**
     * MenuItem constructor
     */
    public function __construct()
    {
        $this->children = [];
        $this->parent = null;
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @param string $name
     * @return MenuItem
     */
    public function setName($name)
    {
        $this->name = $name;
        return $this;
    }

    /**
     * @return string
     */
    public function getCaption()
    {
        return $this->caption;
    }

    /**
     * @param string $caption
     * @return MenuItem
     */
    public function setCaption($caption)
    {
        $this->caption = $caption;
        return $this;
    }

    /**
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * @param string $description
     * @return MenuItem
     */
    public function setDescription($description)
    {
        $this->description = $description;
        return $this;
    }

    /**
     * @return string
     */
    public function getRouteName()
    {
        return $this->routeName;
    }

    /**
     * @param string $routeName
     * @return MenuItem
     */
    public function setRouteName($routeName)
    {
        $this->routeName = $routeName;
        return $this;
    }

    /**
     * @return array
     */
    public function getRouteParams()
    {
        return $this->routeParams;
    }

    /**
     * @param array $routeParams
     * @return MenuItem
     */
    public function setRouteParams($routeParams)
    {
        $this->routeParams = $routeParams;
        return $this;
    }

    /**
     * @return string
     */
    public function getIcon()
    {
        return $this->icon;
    }

    /**
     * @param string $icon
     * @return MenuItem
     */
    public function setIcon($icon)
    {
        $this->icon = $icon;
        return $this;
    }

    /**
     * @return string
     */
    public function getColor()
    {
        return $this->color;
    }

    /**
     * @param string $color
     * @return MenuItem
     */
    public function setColor($color)
    {
        $this->color = $color;
        return $this;
    }

    /**
     * @return MenuItem[]
     */
    public function getChildren()
    {
        return $this->children;
    }

    /**
     * @param MenuItem $child
     * @return MenuItem
     */
    public function addChild(MenuItem $child, $where = self::AT_THE_END)
    {
        if ($where === self::AT_THE_END) {
            $this->children[] = $child;
        } else {
            array_unshift($this->children, $child);
        }

        $child->setParent($this);
        return $this;
    }

    /**
     * @param MenuItem $child
     * @return MenuItem
     */
    public function removeChild(MenuItem $child)
    {
        $this->children = array_filter($this->children, function(MenuItem $e) use ($child) {
            return $e !== $child;
        });
        return $this;
    }

    /**
     * @return MenuItem|null
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * @param MenuItem|null $parent
     * @return MenuItem
     */
    public function setParent(MenuItem $parent)
    {
        $this->parent = $parent;
        return $this;
    }

    /**
     * Devuelve la ruta del ítem hasta la raíz
     * 
     * @return MenuItem[]|null
     */
    public function getPath()
    {
        $path = [$this];
        $current = $this;

        while (null !== $current->getParent()) {
            array_unshift($path, $current->getParent());
            $current = $current->getParent();
        }

        return $path;
    }
}