Itstructure\MultiLevelMenu\MenuWidget

Complexity

Total Complexity

24

Size/Duplication

Total Lines	201
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	run()	0	10	1
A	setDataProvider()	0	4	1
B	groupLevels()	0	24	6
D	renderItems()	0	29	10
B	checkConfiguration()	0	14	6

<?php

namespace Itstructure\MultiLevelMenu;

use yii\db\ActiveRecord;
use yii\helpers\{Html, ArrayHelper};
use yii\base\{Widget, InvalidConfigException};
use yii\data\ActiveDataProvider;

/**
 * Class MenuWidget.
 * Multilevel menu widget.
 *
 * @property string $primaryKeyName Primary key name.
 * @property string $parentKeyName Relation key name.
 * @property string $mainContainerTag Main container html tag.
 * @property array $mainContainerOptions Main container html options.
 * @property string $subMainContainerTag Sub main container html tag.
 * @property array $subMainContainerOptions Sub main container html options.
 * @property string $itemContainerTag Item container html tag.
 * @property array $itemContainerOptions Item container html options.
 * @property string $subItemContainerTag Sub item container html tag.
 * @property array $subItemContainerOptions Sub item container html options.
 * @property string $itemTemplate Item template to display widget elements.
 * @property array $itemTemplateParams Addition item template params.
 * @property string $subItemTemplate Sub item template to display widget elements.
 * @property array $subItemTemplateParams Addition sub item template params.
 * @property ActiveDataProvider $dataProvider Data provider records.
 *
 * @package Itstructure\MultiLevelMenu
 *
 * @author Andrey Girnik <girnikandrey@gmail.com>
 */
class MenuWidget extends Widget
{
    /**
     * Primary key name.
     * @var string
     */
    public $primaryKeyName = 'id';

    /**
     * Relation key name.
     * @var string
     */
    public $parentKeyName = 'parentId';

    /**
     * Main container html tag.
     * @var string
     */
    public $mainContainerTag = 'ul';

    /**
     * Main container html options.
     * @var array
     */
    public $mainContainerOptions = [];

    /**
     * Sub main container html tag.
     * @var string
     */
    public $subMainContainerTag = 'ul';

    /**
     * Sub main container html options.
     * @var array
     */
    public $subMainContainerOptions = [];

    /**
     * Item container html tag.
     * @var string
     */
    public $itemContainerTag = 'li';

    /**
     * Item container html options.
     * @var array
     */
    public $itemContainerOptions = [];

    /**
     * Sub item container html tag.
     * @var string
     */
    public $subItemContainerTag = 'li';

    /**
     * Sub item container html options.
     * @var array
     */
    public $subItemContainerOptions = [];

    /**
     * Item template to display widget elements.
     * @var string
     */
    public $itemTemplate;

    /**
     * Addition item template params.
     * @var array
     */
    public $itemTemplateParams = [];

    /**
     * Sub item template to display widget elements.
     * @var string
     */
    public $subItemTemplate;

    /**
     * Addition sub item template params.
     * @var array
     */
    public $subItemTemplateParams = [];

    /**
     * Data provider records.
     * @var ActiveDataProvider
     */
    private $dataProvider;

    /**
     * Starts the output widget of the multi level view records according with the menu type.
     * @throws InvalidConfigException
     */
    public function run()
    {
        $this->checkConfiguration();

        /** @var ActiveRecord[] $models */
        $models = array_values($this->dataProvider->getModels());
        $models = $this->groupLevels($models);

        return $this->renderItems($models);
    }

    /**
     * Set data provider.
     * @param ActiveDataProvider $dataProvider
     */
    public function setDataProvider(ActiveDataProvider $dataProvider): void
    {
        $this->dataProvider = $dataProvider;
    }

    /**
     * Group records in to sub levels according with the relation to parent records.
     * @param array $models
     * @return array
     */
    private function groupLevels(array $models): array
    {
        if (count($models) == 0){
            return [];
        }

        $items = [];

        /** @var ActiveRecord $item */
        $modelsCount = count($models);
        for ($i=0; $i < $modelsCount; $i++) {
            $item = $models[$i];
            $items[$item->{$this->primaryKeyName}]['data'] = $item;
        }

        /** @var ActiveRecord $data */
        foreach($items as $row) {
            $data = $row['data'];
            $parentKey = !isset($data->{$this->parentKeyName}) || empty($data->{$this->parentKeyName}) ? 0 : $data->{$this->parentKeyName};
            $items[$parentKey]['items'][$data->{$this->primaryKeyName}] = &$items[$data->{$this->primaryKeyName}];
        }

        return $items[0]['items'];
    }

    /**
     * Base render.
     * @param array $items
     * @param bool $isSubLevel
     * @return string
     */
    private function renderItems(array $items, bool $isSubLevel = false): string
    {
        if (count($items) == 0){
            return '';
        }

        $itemTemplate         = $isSubLevel ? $this->subItemTemplate         : $this->itemTemplate;
        $itemTemplateParams   = $isSubLevel ? $this->subItemTemplateParams   : $this->itemTemplateParams;
        $mainContainerTag     = $isSubLevel ? $this->subMainContainerTag     : $this->mainContainerTag;
        $mainContainerOptions = $isSubLevel ? $this->subMainContainerOptions : $this->mainContainerOptions;
        $itemContainerTag     = $isSubLevel ? $this->subItemContainerTag     : $this->itemContainerTag;
        $itemContainerOptions = $isSubLevel ? $this->subItemContainerOptions : $this->itemContainerOptions;

        $outPut = '';

        /** @var array $item */
        foreach ($items as $item) {
            $contentLi = $this->render($itemTemplate, ArrayHelper::merge([
                'data' => $item['data']
            ], $itemTemplateParams));

            if (isset($item['items'])){
                $contentLi .= $this->renderItems($item['items']);
            }
            $outPut .= Html::tag($itemContainerTag, $contentLi, $itemContainerOptions);
        }

        return Html::tag($mainContainerTag, $outPut, $mainContainerOptions);
    }

    /**
     * Check for configure.
     * @throws InvalidConfigException
     */
    private function checkConfiguration()
    {
        if (null === $this->dataProvider){
            throw  new InvalidConfigException('Parameter dataProvider is not defined.');
        }

        if (null === $this->itemTemplate || !is_string($this->itemTemplate)){
            throw  new InvalidConfigException('Item template is not defined.');
        }

        if (null === $this->subItemTemplate || !is_string($this->subItemTemplate)){
            $this->subItemTemplate = $this->itemTemplate;
        }
    }
}