hiqdev / yii2-menus

src/Menu.php

<?php
/**
 * Menus for Yii2.
 *
 * @link      https://github.com/hiqdev/yii2-menus
 * @package   yii2-menus
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2016-2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\yii2\menus;

use hiqdev\yii2\menus\widgets\Menu as MenuWidget;
use ReflectionClass;
use Yii;
use yii\base\View;

/**
 * Menu is a manageable collection of child [[Menu]]s.
 *
 * @property array $add array of menus that will be added to the [[Menu]]
 * @property array $merge array of menus that will be merged into the [[Menu]]
 */
class Menu extends \hiqdev\yii2\collection\BaseObject implements \yii\base\ViewContextInterface
{
    /**
     * {@inheritdoc}
     */
    protected $_itemClass = self::class;

    public $label;
    public $url;
    public $icon;
    public $active;
    public $visible;
    public $options = [];

    /**
     * @var array
     */
    protected $_add;

    /**
     * @var array
     */
    protected $_merge;

    /**
     * @var string parent menu
     */
    public $_parent;

    /**
     * Getter for addTo.
     * @return string add to
     */
    public function getParent()
    {
        return $this->_parent;
    }

    /**
     * Adds $items to the Menu.
     *
     * @param array $items
     * @see addItems()
     */
    public function addMenus(array $items)
    {
        foreach ($items as $item) {
            /// XXX ugly crutch, but no better ideas for the moment
            $config = $item['menu'];
            if (is_array($config) && empty($config['class'])) {
                continue;
            }

            $menu = Yii::createObject($item['menu']);
            $this->addItems($menu->getItems(), isset($item['where']) ? $item['where'] : null);
        }
    }

    /**
     * Merges $items to the Menu.
     *
     * @param array $items
     * @see mergeItems()
     */
    public function mergeMenus(array $items)
    {
        foreach ($items as $item) {
            $menu = Yii::createObject($item['menu']);
            $this->mergeItems($menu->getItems());
        }
    }

    /**
     * Returns default items defined in class.
     * @return array
     */
    public function items()
    {
        return [];
    }

    /**
     * {@inheritdoc}
     * Implements adding and merging.
     */
    public function init()
    {
        parent::init();

        $this->addItems($this->items());

        if (($add = $this->getAdd()) !== null) {
            $this->addMenus($add);
        }

        if (($merge = $this->getMerge()) !== null) {
            $this->mergeMenus($merge);
        }
    }

    public $widgetConfig = [
        'class' => MenuWidget::class,
    ];

    public static function widget($menuConfig = [], $widgetConfig = [])
    {
        $menu = static::create($menuConfig);

        return $menu->run($widgetConfig);
    }

    /**
     * Renders menu widget with given config.
     * @param mixed $config
     * @return string rendered menu
     */
    public function run($config = [])
    {
        if (!is_array($config)) {
            $config = ['class' => $config];
        }
        $config = array_merge($this->widgetConfig, $config);
        if (!empty($config['options']) || !empty($this->options)) {
            $config['options'] = array_merge(
                isset($this->options) ? $this->options : [],
                isset($config['options']) ? $config['options'] : []
            );
        }
        $config['items'] = $this->getItems();

        return call_user_func([$config['class'], 'widget'], $config);
    }

    /**
     * Creates menu and sets $config.
     * @param array $config
     * @return static
     */
    public static function create(array $config = [])
    {
        $config['class'] = get_called_class();

        return Yii::createObject($config);
    }

    /**
     * Renders a view.
     * @param string $view the view name
     * @param array $params the parameters (name-value pairs) to be available in the view
     * @return string the rendering result
     */
    public function render($view, $params = [])
    {
        return $this->getView()->render($view, $params, $this);
    }

    /**
     * @var View the view object to be used to render views
     */
    private $_view;

    /**
     * Returns the view object to be used to render views or view files.
     * If not set, it will default to the "view" application component.
     * @return View|\yii\web\View the view object to be used to render views
     */
    public function getView()
    {
        if ($this->_view === null) {
            $this->_view = Yii::$app->getView();
        }
        return $this->_view;
    }

    /**
     * Sets the view object to be used by this menu.
     * @param View $view the view object to be used to render views
     */
    public function setView($view)
    {
        $this->_view = $view;
    }

    /**
     * @var string the root directory that contains view files for this menu
     */
    protected $_viewPath;

    /**
     * Sets the directory that contains the view files.
     * @param string $path the root directory of view files
     */
    public function setViewPath($path)
    {
        $this->_viewPath = Yii::getAlias($path);

It seems like \Yii::getAlias($path) can also be of type boolean. However, the property $_viewPath is declared as type string. Maybe add an additional type check?

    }

    /**
     * Returns the directory containing view files for this menu.
     * The default implementation returns `views/menus` in the current module.
     * @return string the directory containing the view files for this controller
     */
    public function getViewPath()
    {
        if ($this->_viewPath === null) {
            $ref = new ReflectionClass($this);
            $this->_viewPath = dirname(dirname($ref->getFileName())) . '/views/menus';
        }
        return $this->_viewPath;
    }

    /**
     * @return mixed
     */
    public function getAdd()
    {
        return $this->_add;
    }

    /**
     * @param mixed $add
     */
    public function setAdd($add)
    {
        $this->_add = $add;

It seems like $add of type * is incompatible with the declared type array of property $_add.

    }

    /**
     * @return mixed
     */
    public function getMerge()
    {
        return $this->_merge;
    }

    /**
     * @param mixed $merge
     */
    public function setMerge($merge)
    {
        $this->_merge = $merge;

It seems like $merge of type * is incompatible with the declared type array of property $_merge.

    }
}