PHPPgAdmin\XHtml\TreeController

Complexity

Total Complexity

30

Size/Duplication

Total Lines	238
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	2
B	printTree()	0	26	4
B	printTreeXML()	0	53	7
C	printTreeJSON()	0	66	11
B	adjustTabsForTree()	0	9	6

<?php

/**
 * PHPPgAdmin v6.0.0-beta.33
 */

namespace PHPPgAdmin\XHtml;

use PHPPgAdmin\Decorators\Decorator;

/**
 * Base TreeController controller class.
 */
class TreeController
{
    use \PHPPgAdmin\HelperTrait;

The trait PHPPgAdmin\HelperTrait requires some properties which are not provided by PHPPgAdmin\XHtml\TreeController: $responseobj, $requestobj

    protected $container;
    public $form             = '';
    public $href             = '';
    public $lang             = [];
    public $action           = '';
    public $controller_name  = 'TreeController';
    public $controller_title = 'base';

    // Constructor
    public function __construct(\Slim\Container $container, $controller_name = null)

You must use "/**" style comments for a function comment

    {
        $this->container = $container;
        $this->lang      = $container->get('lang');
        //$this->conf           = $container->get('conf');
        $this->view           = $container->get('view');
        $this->plugin_manager = $container->get('plugin_manager');
        $this->appName        = $container->get('settings')['appName'];
        $this->appVersion     = $container->get('settings')['appVersion'];
        $this->appLangFiles   = $container->get('appLangFiles');
        $this->misc           = $container->get('misc');
        $this->conf           = $this->misc->getConf();
        $this->appThemes      = $container->get('appThemes');
        $this->action         = $container->get('action');
        if (null !== $controller_name) {
            $this->controller_name = $controller_name;
        }
        //\PC::debug($this->controller_name, 'instanced controller');
    }

    /** Produce XML data for the browser tree

The open comment tag must be the only content on the line

Doc comment short description must be on the first line

The type PHPPgAdmin\XHtml\a was not found. Did you mean a? If so, make sure to prefix the type with \.

     * @param $treedata a set of records to populate the tree
     * @param $attrs Attributes for tree items

The type PHPPgAdmin\XHtml\Attributes was not found. Maybe you did not declare it correctly or list all dependencies?

     *        'text' - the text for the tree node
     *        'icon' - an icon for node
     *        'openIcon' - an alternative icon when the node is expanded
     *        'toolTip' - tool tip text for the node
     *        'action' - URL to visit when single clicking the node
     *        'iconAction' - URL to visit when single clicking the icon node
     *        'branch' - URL for child nodes (tree XML)
     *        'expand' - the action to return XML for the subtree
     *        'nodata' - message to display when node has no children
     * @param $section The section where the branch is linked in the tree

The type PHPPgAdmin\XHtml\The was not found. Maybe you did not declare it correctly or list all dependencies?

     * @param mixed $print
     */
    public function printTree(&$_treedata, &$attrs, $section, $print = true)
    {
        $plugin_manager = $this->plugin_manager;

        $treedata = [];

        if ($_treedata->recordCount() > 0) {
            while (!$_treedata->EOF) {
                $treedata[] = $_treedata->fields;
                $_treedata->moveNext();
            }
        }

        $tree_params = [
            'treedata' => &$treedata,
            'attrs'    => &$attrs,
            'section'  => $section,
        ];

        $plugin_manager->do_hook('tree', $tree_params);

        if (isset($_REQUEST['json'])) {
            return $this->printTreeJSON($treedata, $attrs, $print);
        }

        return $this->printTreeXML($treedata, $attrs, $print);
    }

    /** Produce XML data for the browser tree

The open comment tag must be the only content on the line

Doc comment short description must be on the first line

     * @param $treedata a set of records to populate the tree
     * @param $attrs Attributes for tree items
     *        'text' - the text for the tree node
     *        'icon' - an icon for node
     *        'openIcon' - an alternative icon when the node is expanded
     *        'toolTip' - tool tip text for the node
     *        'action' - URL to visit when single clicking the node
     *        'iconAction' - URL to visit when single clicking the icon node
     *        'branch' - URL for child nodes (tree XML)
     *        'expand' - the action to return XML for the subtree
     *        'nodata' - message to display when node has no children
     * @param mixed $print
     */
    private function printTreeXML(&$treedata, &$attrs, $print = true)

Private method name "TreeController::printTreeXML" must be prefixed with an underscore

    {
        $lang = $this->lang;

        $tree_xml = '<?xml version="1.0" encoding="UTF-8"?><tree>';

        if (count($treedata) > 0) {
            foreach ($treedata as $rec) {
                $icon = $this->misc->icon(Decorator::get_sanitized_value($attrs['icon'], $rec));
                if (!empty($attrs['openicon'])) {
                    $icon = $this->misc->icon(Decorator::get_sanitized_value($attrs['openIcon'], $rec));
                }
                $tree_xml .= '<tree>';

                $text_xml       = Decorator::value_xml_attr_tag('text', $attrs['text'], $rec);
                $action_xml     = Decorator::value_xml_attr_tag('action', $attrs['action'], $rec);
                $src_xml        = Decorator::value_xml_attr_tag('src', $attrs['branch'], $rec);
                $icon_xml       = Decorator::value_xml_attr_tag('icon', $icon, $rec);
                $iconaction_xml = Decorator::value_xml_attr_tag('iconaction', $attrs['iconAction'], $rec);
                $openicon_xml   = Decorator::value_xml_attr_tag('openicon', $icon, $rec);
                $tooltip_xml    = Decorator::value_xml_attr_tag('tooltip', $attrs['toolTip'], $rec);

                $tree_xml .= $text_xml;
                $tree_xml .= $action_xml;
                $tree_xml .= $src_xml;
                $tree_xml .= $icon_xml;
                $tree_xml .= $iconaction_xml;
                $tree_xml .= $openicon_xml;
                $tree_xml .= $tooltip_xml;

                $tree_xml .= '</tree>';
            }
        } else {
            $msg = isset($attrs['nodata']) ? $attrs['nodata'] : $lang['strnoobjects'];
            $tree_xml .= "<tree text=\"{$msg}\" onaction=\"tree.getSelected().getParent().reload()\" icon=\"" . $this->misc->icon('ObjectNotFound') . '" />' . "\n";
        }

        $tree_xml .= '</tree>';
        if (true === $print) {
            if (null === $this->container->requestobj->getAttribute('route')) {
                header('Content-Type: text/xml; charset=UTF-8');
                header('Cache-Control: no-cache');
                echo $tree_xml;
            } else {
                return $this
                    ->container
                    ->responseobj
                    ->withStatus(200)
                    ->withHeader('Content-Type', 'text/xml; charset=UTF-8')
                    ->write($tree_xml);
            }
        } else {
            return $tree_xml;
        }
    }

    /** Produce XML data for the browser tree

The open comment tag must be the only content on the line

Doc comment short description must be on the first line

     * @param $treedata a set of records to populate the tree
     * @param $attrs Attributes for tree items
     *        'text' - the text for the tree node
     *        'icon' - an icon for node
     *        'openIcon' - an alternative icon when the node is expanded
     *        'toolTip' - tool tip text for the node
     *        'action' - URL to visit when single clicking the node
     *        'iconAction' - URL to visit when single clicking the icon node
     *        'branch' - URL for child nodes (tree XML)
     *        'expand' - the action to return XML for the subtree
     *        'nodata' - message to display when node has no children
     * @param mixed $print
     */
    private function printTreeJSON(&$treedata, &$attrs, $print = true)

Private method name "TreeController::printTreeJSON" must be prefixed with an underscore

    {
        $lang = $this->lang;

The assignment to $lang is dead and can be removed.

        $parent = [];

        if (isset($attrs['is_root'])) {
            $parent = [
                'id'       => 'root',
                'children' => true,
                'icon'     => \SUBFOLDER . '/images/themes/default/Servers.png',
                'state'    => ['opened' => true],
                'url'      => str_replace('//', '/', \SUBFOLDER . '/src/views/servers?action=tree'),
                'text'     => '<a href="' . str_replace('//', '/', \SUBFOLDER . '/src/views/servers') . '" target="detail">Servers</a>',
            ];
        } elseif (count($treedata) > 0) {
            foreach ($treedata as $rec) {
                $icon = $this->misc->icon(Decorator::get_sanitized_value($attrs['icon'], $rec));
                if (!empty($attrs['openicon'])) {
                    $icon = $this->misc->icon(Decorator::get_sanitized_value($attrs['openIcon'], $rec));
                }

                $tree = [
                    'text'       => Decorator::get_sanitized_value($attrs['text'], $rec),
                    'id'         => Decorator::get_sanitized_value($attrs['action'], $rec),
                    'icon'       => Decorator::get_sanitized_value($icon, $rec),
                    'iconaction' => Decorator::get_sanitized_value($attrs['iconAction'], $rec),
                    'openicon'   => Decorator::get_sanitized_value($icon, $rec),
                    'tooltip'    => Decorator::get_sanitized_value($attrs['toolTip'], $rec),
                    'children'   => false,
                ];
                $url = Decorator::get_sanitized_value($attrs['branch'], $rec);
                if ($url && strpos($url, '/src/views') === false) {
                    $url = str_replace('//', '/', \SUBFOLDER . '/src/views/' . $url);
                }
                if ($url) {
                    $tree['url']      = $url;
                    $tree['children'] = true;
                }

                $tree['text'] = '<a href="' . $tree['id'] . '" target="detail">' . $tree['text'] . '</a>';

                $parent[] = $tree;
            }
        } else {
            $parent = ['children' => false];
        }

        if (true === $print) {
            if (null === $this->container->requestobj->getAttribute('route')) {
                header('Content-Type: text/xml; charset=UTF-8');
                header('Cache-Control: no-cache');
                echo $tree_xml;

The variable $tree_xml seems to be never defined.

            } else {
                if (isset($_REQUEST['children'])) {
                    $children = $parent;
                    $parent   = ['children' => $children];
                }
                return $this
                    ->container
                    ->responseobj
                    ->withStatus(200)
                    ->withJson($parent);
            }
        } else {
            return $tree_xml;
        }
    }

    public function adjustTabsForTree(&$tabs)
    {
        foreach ($tabs as $i => $tab) {
            if ((isset($tab['hide']) && true === $tab['hide']) || (isset($tab['tree']) && false === $tab['tree'])) {
                unset($tabs[$i]);
            }
        }

        return new \PHPPgAdmin\ArrayRecordSet($tabs);
    }
}