NavBar.php

<?php
/**
 * @link https://github.com/MacGyer/yii2-materializecss
 * @copyright Copyright (c) 2016 ... MacGyer for pluspunkt coding
 * @license https://github.com/MacGyer/yii2-materializecss/blob/master/LICENSE
 */

namespace macgyer\yii2materializecss\widgets\navigation;

use macgyer\yii2materializecss\assets\MaterializePluginAsset;
use macgyer\yii2materializecss\lib\BaseWidget;
use macgyer\yii2materializecss\lib\Html;
use macgyer\yii2materializecss\widgets\Button;
use macgyer\yii2materializecss\widgets\Icon;
use Yii;
use yii\helpers\ArrayHelper;

/**
 * NavBar renders a navbar HTML component.
 *
 * Any content enclosed between the [\yii\base\Widget::begin()](http://www.yiiframework.com/doc-2.0/yii-base-widget.html#begin()-detail)
 * and [\yii\base\Widget::end()](http://www.yiiframework.com/doc-2.0/yii-base-widget.html#end()-detail) calls of NavBar
 * is treated as the content of the navbar. You may use widgets such as [[Nav|Nav]]
 * or [\yii\widgets\Menu](http://www.yiiframework.com/doc-2.0/yii-widgets-menu.html) to build up such content. For example,
 *
 * ```php
 * use macgyer\yii2materializecss\widgets\navigation\NavBar;
 * use macgyer\yii2materializecss\widgets\navigation\Nav;
 *
 * NavBar::begin(['brandLabel' => 'NavBar Test']);
 * echo Nav::widget([
 *     'items' => [
 *         ['label' => 'Home', 'url' => ['/site/index']],
 *         ['label' => 'About', 'url' => ['/site/about']],
 *     ],
 * ]);
 * NavBar::end();
 * ```
 * @author Christoph Erdmann <yii2-materializecss@pluspunkt-coding.de>
 * @see https://materializecss.github.io/materialize/navbar.html
 * @package widgets
 * @subpackage navigation
 */
class NavBar extends BaseWidget
{
    /**
     * @var array the HTML attributes for the widget container tag. The following special options are recognized:
     *
     * - tag: string, defaults to "nav", the name of the container tag.
     *
     * @see [\yii\helpers\Html::renderTagAttributes()](http://www.yiiframework.com/doc-2.0/yii-helpers-basehtml.html#renderTagAttributes()-detail) for details on how attributes are being rendered.
     */
    public $options = [];

    /**
     * @var string|boolean the text of the brand or false if it's not used. Note that this is not HTML-encoded.
     * @see https://materializecss.github.io/materialize/navbar.html
     */
    public $brandLabel = false;

    /**
     * @var boolean whether the navbar content should be included in an inner div container which by default
     * adds left and right padding. Set this to false for a 100% width navbar.
     */
    public $fixed = false;

    /**
     * @var array|string|boolean $url the URL for the brand's hyperlink tag. This parameter will be processed by
     * [\yii\helpers\Url::to()](http://www.yiiframework.com/doc-2.0/yii-helpers-baseurl.html#to()-detail)
     * and will be used for the "href" attribute of the brand link. Default value is false that means
     * [\yii\web\Application::homeUrl](http://www.yiiframework.com/doc-2.0/yii-web-application.html#$homeUrl-detail) will be used.
     * You may set it to `null` if you want to have no link at all.
     */
    public $brandUrl = false;

    /**
     * @var array the HTML attributes of the brand link.
     * @see [\yii\helpers\Html::renderTagAttributes()](http://www.yiiframework.com/doc-2.0/yii-helpers-basehtml.html#renderTagAttributes()-detail) for details on how attributes are being rendered.
     */
    public $brandOptions = [];

    /**
     * @var string text to show for screen readers for the button to toggle the navbar.
     */
    public $screenReaderToggleText = 'Toggle navigation';

    /**
     * @var array the HTML attributes of the fixed container.
     * @see [\yii\helpers\Html::renderTagAttributes()](http://www.yiiframework.com/doc-2.0/yii-helpers-basehtml.html#renderTagAttributes()-detail) for details on how attributes are being rendered.
     */
    public $fixedContainerOptions = [];

    /**
     * @var array the HTML attributes of the inner container.
     * @see [\yii\helpers\Html::renderTagAttributes()](http://www.yiiframework.com/doc-2.0/yii-helpers-basehtml.html#renderTagAttributes()-detail) for details on how attributes are being rendered.
     */
    public $containerOptions = [];

    /**
     * @var array the HTML attributes of the navigation wrapper container.
     * @see [\yii\helpers\Html::renderTagAttributes()](http://www.yiiframework.com/doc-2.0/yii-helpers-basehtml.html#renderTagAttributes()-detail) for details on how attributes are being rendered.
     */
    public $wrapperOptions = [];

    /**
     * @var array the side nav configuration options.
     * See SideNav|SideNav for details.
     */
    public $sidenavOptions = [];

    /**
     * @var bool whether the side nav shall be rendered.
     */
    public $renderSidenav = true;

    /**
     * @var array the options for the underlying JS sideNav() plugin.
     * @see https://materializecss.com/sidenav.html#options
     */
    public $sidenavClientOptions = [];

    /**
     * @var array the configuration options for the toggle button.
     * The toggle button is rendered by the [[\macgyer\yii2materializecss\widgets\Button|Button]] widget. See the docs for all available options.
     *
     * @see \macgyer\yii2materializecss\widgets\Button|Button
     */
    public $sidenavToggleButtonOptions = [];

    /**
     * @var array list of items in the nav widget. Each array element represents a single
     * menu item which can be either a string or an array with the following structure:
     *
     * - label: string, required, the nav item label.
     * - url: optional, the item's URL. Defaults to "#".
     * - visible: boolean, optional, whether this menu item is visible. Defaults to true.
     * - linkOptions: array, optional, the HTML attributes of the item's link.
     * - options: array, optional, the HTML attributes of the item container (LI).
     * - active: boolean, optional, whether the item should be on active state or not.
     * - dropDownOptions: array, optional, the HTML options that will passed to the [[Dropdown]] widget.
     * - items: array|string, optional, the configuration array for creating a [[Dropdown]] widget,
     *   or a string representing the dropdown menu. Note that Bootstrap does not support sub-dropdown menus.
     * - encode: boolean, optional, whether the label will be HTML-encoded. If set, supersedes the $encodeLabels option for only this item.
     *
     * If a menu item is a string, it will be rendered directly without HTML encoding.
     */
    public $sidenavItems = [];

    /**
     * Initializes the widget.
     */
    public function init()
    {
        parent::init();
        $html = [];

        if (empty($this->options['role'])) {
            $this->options['role'] = 'navigation';
        }

        if ($this->fixed) {
            Html::addCssClass($this->fixedContainerOptions, 'navbar-fixed');
            $html[] = Html::beginTag('div', $this->fixedContainerOptions);
        }

        $html[] = Html::beginTag('nav', $this->options);

        Html::addCssClass($this->wrapperOptions, 'nav-wrapper');
        $html[] = Html::beginTag('div', $this->wrapperOptions);

        if ($this->brandLabel !== false) {
            Html::addCssClass($this->brandOptions, ['widget' => 'brand-logo']);
            $html[] = Html::a($this->brandLabel, $this->brandUrl === false ? Yii::$app->homeUrl : $this->brandUrl, $this->brandOptions);
        }

        if (!isset($this->containerOptions['id'])) {
            $this->containerOptions['id'] = "{$this->id}-collapse";
        }
        $html[] = Html::beginTag('div', $this->containerOptions);

        echo implode("\n", $html);
    }

    /**
     * Renders the widget.
     */
    public function run()
    {
        if ($this->renderSidenav) {
            $sidenavId = $this->getUniqueId('sidenav_');
            $this->initSidenav($sidenavId);
        }

        $html = [];
        $html[] = Html::endTag('div'); // container

        if ($this->renderSidenav) {
            $html[] = $this->renderSidenavToggleButton();
        }

        $html[] = Html::endTag('div'); // nav-wrapper

        $html[] = Html::endTag('nav');

        if ($this->fixed) {
            $html[] = Html::endTag('div');
        }

        if ($this->renderSidenav) {
            $html[] = $this->renderSidenav($sidenavId);
        }

        return implode("\n", $html);
    }

    /**
     * Initializes the side nav options.
     *
     * @param string $sidenavId the side nav element's HTML id attribute.
     */
    protected function initSidenav($sidenavId)
    {
        $this->sidenavToggleButtonOptions = ArrayHelper::merge([
            'label' => false,
            'icon' => [
                'name' => 'menu'
            ],
            'type' => Button::TYPE_FLAT,
        ], $this->sidenavToggleButtonOptions);

        if (!isset($this->sidenavToggleButtonOptions['options']['data-target'])) {
            $this->sidenavToggleButtonOptions['options']['data-target'] = $sidenavId;
        }

        Html::addCssClass($this->sidenavToggleButtonOptions['options'], ['trigger' => 'sidenav-trigger']);
    }

    /**
     * Renders the side navigation and corresponding toggle button.
     * @param $sidenavId
     * @return string the rendered side navigation markup.
     * @throws \Exception
     */
    protected function renderSidenav($sidenavId)
    {
        return SideNav::widget([
            'items' => $this->sidenavItems,
            'renderToggleButton' => false,
            'clientOptions' => $this->sidenavClientOptions,
            'options' => ['id' => $sidenavId],
        ]);
    }

    /**
     * Renders the side nav toggle button.
     *
     * @return string the button markup.
     * @throws \Exception
     */
    protected function renderSidenavToggleButton()
    {
        return Button::widget($this->sidenavToggleButtonOptions);
    }
}