App\View\Helper\CategoriesHelper

Complexity

Total Complexity

26

Size/Duplication

Total Lines	183
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	node()	0	9	2
A	html()	0	10	2
A	control()	0	12	2
A	sortRoots()	0	5	1
B	tree()	0	41	9
A	isTree()	0	14	4
A	controlOptions()	0	21	6

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2021 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */
namespace App\View\Helper;

use Cake\Utility\Hash;
use Cake\View\Helper;

/**
 * Categories helper
 *
 * @property \Cake\View\Helper\FormHelper $Form
 * @property \App\View\Helper\PropertyHelper $Property
 */
class CategoriesHelper extends Helper
{
    public $helpers = ['Form', 'Property'];

    /**
     * Control for categories
     *
     * @param string $name The name
     * @param mixed|null $value The value
     * @return string
     */
    public function control(string $name, $value): string
    {
        $options = ['label' => false];
        if (!$this->isTree()) {
            return sprintf(
                '<div class="categories"><h3>%s</h3>%s</div>',
                __('Global'),
                $this->Property->control($name, $value, $options)
            );
        }

        return $this->html($name, $value, $options);
    }

    /**
     * Html for categories tree
     *
     * @param string $name The name
     * @param mixed|null $value The value
     * @param array $options The options
     * @return string
     */
    public function html(string $name, $value, array $options): string
    {
        $html = '';
        $tree = $this->tree();
        $hiddenField = true; // hiddenField false on all controls except the first
        foreach ($tree as $node) {
            $html .= $this->node($node, $name, $value, $options, $hiddenField);
        }

        return $html;
    }

    /**
     * Html for single node of categories tree
     *
     * @param array $node The category node
     * @param string $name The name
     * @param mixed|null $value The value
     * @param array $options The options
     * @param bool $hiddenField The hiddenField flag
     * @return string
     */
    public function node(array $node, string $name, $value, array $options, bool &$hiddenField): string
    {
        $title = sprintf('<h3>%s</h3>', $node['label'] = $node['label'] ?: $node['name']);
        $controlOptions = $this->controlOptions($node, $value, $options, $hiddenField);

        return sprintf(
            '<div class="categories">%s%s</div>',
            $title,
            $this->Form->control($name, $controlOptions)
        );
    }

    /**
     * Control options for category node.
     *
     * @param array $node The category node
     * @param mixed|null $value The value
     * @param array $options The options
     * @param bool $hiddenField The hiddenField flag
     * @return array
     */
    public function controlOptions(array $node, $value, array $options, bool &$hiddenField): array
    {
        $controlOptions = $options + [
            'type' => 'select',
            'multiple' => 'checkbox',
            'value' => (array)Hash::extract((array)$value, '{n}.name'),
            'hiddenField' => $hiddenField,
        ];
        $hiddenField = false;
        if (empty($node['children'])) {
            $controlOptions['options'][0] = ['value' => $node['name'], 'text' => $node['label'] = $node['label'] ?: $node['name']];

            return $controlOptions;
        }
        foreach ($node['children'] as $key => $child) {
            if ((bool)Hash::get($child, 'enabled', true)) {
                $controlOptions['options'][$key] = ['value' => $child['name'], 'text' => $child['label'] = $child['label'] ?: $child['name']];
            }
        }

        return $controlOptions;
    }

    /**
     * Categories tree.
     * Return roots with children in 'children'.
     *
     * @return array
     */
    public function tree(): array
    {
        $schema = (array)$this->_View->get('schema');
        $categories = (array)Hash::get($schema, 'categories');
        if (empty($categories)) {
            return [];
        }

        $globalCategories = [];
        $roots = [];
        foreach ($categories as $category) {
            if (empty($category['parent_id'])) { // root
                $roots[$category['id']] = array_merge($category, (array)Hash::get($roots, $category['id']));
            } else { // child
                $roots[$category['parent_id']]['children'][] = $category;
            }
        }

        foreach ($roots as $key => &$root) {
            if (!empty($root['children'])) {
                usort($root['children'], [$this, 'sortRoots']);
            }
            if (empty($root['parent_id']) && empty($root['children'])) {
                $globalCategories[] = $root;
                unset($roots[$key]);
            }
        }

        if (!empty($globalCategories)) {
            array_unshift($roots, [
                'id' => '0',
                'name' => '_',
                'label' => __('Global'),
                'parent_id' => null,
                'children' => $globalCategories,
            ]);
        }

        usort($roots, [$this, 'sortRoots']);

        return $roots;
    }

    /**
     * Sort roots. Global first.
     *
     * @param array $a The first node
     * @param array $b The second node
     * @return int
     */
    public function sortRoots(array $a, array $b): int
    {
        return strcmp(
            strtolower((string)Hash::get($a, 'name')),
            strtolower((string)Hash::get($b, 'name'))
        );
    }

    /**
     * Return true when a category parent id is not null, among schema.categories.
     * False otherwise.
     *
     * @return bool
     */
    public function isTree(): bool
    {
        $schema = (array)$this->_View->get('schema');
        $categories = (array)Hash::get($schema, 'categories');
        if (empty($categories)) {
            return false;
        }
        foreach ($categories as $category) {
            if (!empty($category['parent_id'])) {
                return true;
            }
        }

        return false;
    }
}