itstructure / laravel-multi-menu

src/MultiMenuWidget.php

<?php

namespace Itstructure\MultiMenu;

use Exception;
use Illuminate\Database\Eloquent\{Model, Collection};

/**
 * Class MultiMenuWidget
 *
 * @package Itstructure\MultiMenu
 *
 * @author Andrey Girnik <girnikandrey@gmail.com>
 */
class MultiMenuWidget {

    /**
     * Primary key name.
     * @var string
     */
    private $primaryKeyName = 'id';

    /**
     * Relation key name.
     * @var string
     */
    private $parentKeyName = 'parent_id';

    /**
     * Main container template to display widget elements.
     * @var string|array
     */
    private $mainTemplate = 'main';

    /**
     * Item container template to display widget elements.
     * @var string|array
     */
    private $itemTemplate = 'item';

    /**
     * Addition cross cutting data.
     * @var array
     */
    private $additionData = [];

    /**
     * MultiMenuWidget constructor.
     * @param array $config
     */
    public function __construct(array $config)
    {
        $this->setAttributes($config);
    }

    /**
     * Starts the output widget of the multi level view records according with the menu type.
     * @param Collection $data
     * @param array $additionData
     * @return string
     */
    public function run(Collection $data, array $additionData = []): string
    {
        $this->additionData = $additionData;

        return $this->renderItems($this->groupLevels($data));
    }

    /**
     * Check whether a particular record can be used as a parent.
     * @param Model $mainModel
     * @param int $newParentId
     * @param string|null $primaryKeyName
     * @param string|null $parentKeyName
     * @return bool
     */
    public static function checkNewParentId(
        Model $mainModel,
        int $newParentId,
        string $primaryKeyName = null,
        string $parentKeyName = null
    ): bool {

        $primaryKeyName = empty($primaryKeyName) ? config('multimenu.primaryKeyName', 'id') : $primaryKeyName;
        $parentKeyName = empty($parentKeyName) ? config('multimenu.parentKeyName', 'parent_id') : $parentKeyName;

        $parentRecord = $mainModel::where($primaryKeyName, $newParentId)
            ->select($primaryKeyName, $parentKeyName)
            ->first();

        if ($mainModel->{$primaryKeyName} === $parentRecord->{$primaryKeyName}) {
            return false;
        }

        if (null === $parentRecord->{$parentKeyName}) {
            return true;
        }

        return static::checkNewParentId($mainModel, $parentRecord->{$parentKeyName}, $primaryKeyName, $parentKeyName);
    }

    /**
     * Reassigning child objects to their new parent after delete the main model record.
     * @param Model $mainModel
     * @param string|null $primaryKeyName
     * @param string|null $parentKeyName
     */
    public static function afterDeleteMainModel(
        Model $mainModel,
        string $primaryKeyName = null,
        string $parentKeyName = null
    ): void {

        $primaryKeyName = empty($primaryKeyName) ? config('multimenu.primaryKeyName', 'id') : $primaryKeyName;
        $parentKeyName = empty($parentKeyName) ? config('multimenu.parentKeyName', 'parent_id') : $parentKeyName;

        $mainModel::where($parentKeyName, $mainModel->{$primaryKeyName})
            ->update([
                $parentKeyName => $mainModel->{$parentKeyName}
            ]);
    }

    /**
     * @param array $config
     * @return void
     */
    private function setAttributes(array $config): void
    {
        foreach ($config as $key => $value) {
            $this->{$key} = $value;
        }
    }

    /**
     * Group records in to sub levels according with the relation to parent records.
     * @param Collection $models
     * @return array
     * @throws Exception
     */
    private function groupLevels(Collection $models): array
    {
        if (!is_string($this->parentKeyName) || empty($this->primaryKeyName)) {

The condition is_string($this->parentKeyName) is always true.

            throw new Exception('The parent key name is nod defined correctly.');
        }

        if (!is_string($this->primaryKeyName) || empty($this->primaryKeyName)) {

The condition is_string($this->primaryKeyName) is always true.

            throw new Exception('The primary key name is nod defined correctly.');
        }

        if ($models->count() == 0) {
            return [];
        }

        $items = [];

        foreach ($models as $model) {
            $items[$model->{$this->primaryKeyName}]['data'] = $model;
        }

        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 int $level
     * @return string
     */
    private function renderItems(array $items, int $level = 0): string
    {
        if (count($items) == 0) {
            return '';
        }

        $itemsContent = '';

        /** @var array $item */
        foreach ($items as $item) {

            $itemsContent .= view('multimenu::'.$this->levelAttributeValue($this->itemTemplate, $level),
                array_merge([
                    'data' => $item['data']
                ], $this->levelAttributeValue($this->additionData, $level))
            );

            if (isset($item['items'])) {
                $itemsContent .= $this->renderItems($item['items'], $level + 1);
            }
        }

        return view('multimenu::'.$this->levelAttributeValue($this->mainTemplate, $level), array_merge([
                'items' => $itemsContent,
                'level' => $level
            ], $this->levelAttributeValue($this->additionData, $level))
        );
    }

    /**
     * Get attribute values in current level.
     * @param $attributeValue
     * @param int $level
     * @return mixed
     * @throws Exception
     */
    private function levelAttributeValue($attributeValue, int $level)
    {
        if (is_string($attributeValue)) {
            return $attributeValue;
        }

        if (is_array($attributeValue) && !isset($attributeValue['levels'])) {
            return $attributeValue;
        }

        if (is_array($attributeValue) && isset($attributeValue['levels'])) {

            $countLevels = count($attributeValue['levels']);

            if ($countLevels == 0) {
                throw new Exception('Level values are not defined for attribute.');
            }

            if (isset($attributeValue['levels'][$level])) {
                return $attributeValue['levels'][$level];

            } else {
                $levelKeys = array_keys($attributeValue['levels']);
                return $attributeValue['levels'][$levelKeys[$countLevels-1]];
            }
        }

        throw new Exception('Attribute is not defined correctly.');
    }
}