midgard_admin_asgard_stylehelper

Complexity

Total Complexity

25

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Test Coverage

Coverage

13.58%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	render_help()	0	16	7
A	_get_help_element()	0	29	6
A	_get_nodes_inheriting_style()	0	14	2
A	_get_style_elements_and_nodes()	0	26	3
A	_get_component_default_elements()	0	17	3
A	_get_nodes_using_style()	0	17	3

<?php
/**
 * @package midgard.admin.asgard
 * @author The Midgard Project, http://www.midgard-project.org
 * @copyright The Midgard Project, http://www.midgard-project.org
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
 */

/**
 * Style helper methods
 *
 * @package midgard.admin.asgard
 */
class midgard_admin_asgard_stylehelper
{
    /**
     * The current request data
     */
    private array $_data;

    public function __construct(array &$data)
    {
        $this->_data =& $data;
        midcom::get()->head->enable_jquery_ui(['accordion']);
    }

    public function render_help()
    {
        if (empty($this->_data['object'])) {
            return;
        }

        if (   midcom::get()->dbfactory->is_a($this->_data['object'], 'midgard_style')
            && (   $this->_data['handler_id'] !== 'object_create'
                || $this->_data['current_type'] == 'midgard_element')) {
            // Suggest element names to create under a style
            $this->_data['help_style_elementnames'] = $this->_get_style_elements_and_nodes($this->_data['object']->id);
            midcom_show_style('midgard_admin_asgard_stylehelper_elementnames');

        } elseif (   midcom::get()->dbfactory->is_a($this->_data['object'], 'midgard_element')
                  && $this->_get_help_element()) {
            midcom_show_style('midgard_admin_asgard_stylehelper_element');
        }
    }

    private function _get_help_element() : bool
    {
        if (   empty($this->_data['object']->name)
            || empty($this->_data['object']->style)) {
            // We cannot help with empty elements
            return false;
        }

        if ($this->_data['object']->name == 'ROOT') {
            $this->_data['help_style_element'] = [
                'component' => 'midcom',
                'default'   => file_get_contents(MIDCOM_ROOT . '/midcom/style/ROOT.php'),
            ];
            return true;
        }

        // Find the element we're looking for
        $style_elements = $this->_get_style_elements_and_nodes($this->_data['object']->style);
        foreach ($style_elements['elements'] as $component => $elements) {
            if (!empty($elements[$this->_data['object']->name])) {
                $element_path = $elements[$this->_data['object']->name];
                $this->_data['help_style_element'] = [
                    'component' => $component,
                    'default'   => file_get_contents($element_path),
                ];
                return true;
            }
        }
        return false;
    }

    private function _get_style_elements_and_nodes(int $style_id) : array
    {
        $results = [
            'elements' => [
                'midcom' => [
                    'style-init' => '',
                    'style-finish' => '',
                 ]
            ],
            'nodes' => [],
        ];

        if (!$style_id) {
            return $results;
        }
        $style_path = midcom_db_style::path_from_id($style_id);
        $style_nodes = $this->_get_nodes_using_style($style_path);

        foreach ($style_nodes as $node) {
            // Get the list of style elements for the component
            $results['elements'][$node->component] ??= $this->_get_component_default_elements($node->component);

            $results['nodes'][$node->component][] = $node;
        }

        return $results;
    }

    /**
     * Get list of topics using a particular style
     *
     * @return midcom_db_topic[] List of folders
     */
    private function _get_nodes_using_style(string $style) : array
    {
        $style_nodes = [];
        // Get topics directly using the style
        $qb = midcom_db_topic::new_query_builder();
        $qb->add_constraint('style', '=', $style);

        foreach ($qb->execute() as $node) {
            $style_nodes[] = $node;

            if ($node->styleInherit) {
                $child_nodes = $this->_get_nodes_inheriting_style($node);
                $style_nodes = array_merge($style_nodes, $child_nodes);
            }
        }

        return $style_nodes;
    }

    private function _get_nodes_inheriting_style(midcom_db_topic $node) : array
    {
        $nodes = [];
        $qb = midcom_db_topic::new_query_builder();
        $qb->add_constraint('up', '=', $node->id);
        $qb->add_constraint('style', '=', '');

        foreach ($qb->execute() as $child_node) {
            $nodes[] = $child_node;
            $subnodes = $this->_get_nodes_inheriting_style($child_node);
            $nodes = array_merge($nodes, $subnodes);
        }

        return $nodes;
    }

    /**
     * List the default template elements shipped with a component
     *
     * @return array List of elements found indexed by the element name
     */
    private function _get_component_default_elements(string $component) : array
    {
        $elements = [];

        // Path to the file system
        $path = midcom::get()->componentloader->path_to_snippetpath($component) . '/style';

        if (!is_dir($path)) {
            debug_add("Directory {$path} not found.");
            return $elements;
        }

        foreach (glob($path . '/*.php') as $filepath) {
            $elements[basename($filepath, '.php')] = $filepath;
        }

        return $elements;
    }
}