PHPPgAdmin\XHtml\HTMLNavbarController

Complexity

Total Complexity

85

Size/Duplication

Total Lines	560
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
B	printNavLinks()	0	21	5
D	printTrail()	0	60	11
B	printLinksList()	0	17	5
C	printTabs()	0	53	14
A	getHREFSubject()	0	5	1
D	printTopbar()	0	156	9
A	getLastTabURL()	0	14	4
F	getTrail()	0	171	36

<?php

Missing file doc comment

namespace PHPPgAdmin\XHtml;

/**
 * Class to render tables. Formerly part of Misc.php
 *
 */

Additional blank lines found at end of doc comment

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class HTMLNavbarController extends HTMLController
{
    public $_name = 'HTMLNavbarController';

Public member variable "_name" must not be prefixed with an underscore

    /**
     * Display a bread crumb trail.
     * @param  $do_print true to echo, false to return html

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public function printTrail($trail = [], $do_print = true, $from = null)
    {
        if ($from === null) {
            $from = __METHOD__;
        }
        $lang = $this->lang;
        $misc = $this->misc;

        $trail_html = $this->printTopbar(false, $from);

        if (is_string($trail)) {
            $trail = $this->getTrail($trail);
        }

        //$this->prtrace($trail);

        $trail_html .= '<div class="trail" data-controller="' . $this->controller_name . '"><table><tr>';

        foreach ($trail as $crumb) {
            $trail_html .= '<td class="crumb">';
            $crumblink = '<a';

            if (isset($crumb['url'])) {
                $crumblink .= " href=\"{$crumb['url']}\"";
                //$this->prtrace('crumb_url', $crumb['url']);
            }

            if (isset($crumb['title'])) {
                $crumblink .= " title=\"{$crumb['title']}\"";
            }

            $crumblink .= '>';

            if (isset($crumb['title'])) {
                $iconalt = $crumb['title'];
            } else {
                $iconalt = 'Database Root';
            }

            if (isset($crumb['icon']) && $icon = $misc->icon($crumb['icon'])) {
                $crumblink .= "<span class=\"icon\"><img src=\"{$icon}\" alt=\"{$iconalt}\" /></span>";
            }

            $crumblink .= '<span class="label">' . htmlspecialchars($crumb['text']) . '</span></a>';

            if (isset($crumb['help'])) {
                $trail_html .= $this->misc->printHelp($crumblink, $crumb['help'], false);
            } else {
                $trail_html .= $crumblink;
            }

            $trail_html .= "{$lang['strseparator']}";
            $trail_html .= '</td>';
        }

        $trail_html .= "</tr></table></div>\n";
        if ($do_print) {
            echo $trail_html;
        } else {
            return $trail_html;
        }
    }

    /**
     * Display the navlinks
     *
     * @param $navlinks - An array with the the attributes and values that will be shown. See printLinksList for array format.
     * @param $place - Place where the $navlinks are displayed. Like 'display-browse', where 'display' is the file (display.php)

Expected 51 spaces after parameter type; 1 found

Doc comment for parameter $navlinks does not match actual variable name $place

     * @param $env - Associative array of defined variables in the scope of the caller.
     *               Allows to give some environnement details to plugins.
     * and 'browse' is the place inside that code (doBrowse).
     * @param bool $do_print if true, print html, if false, return html

Expected 70 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

The doc comment - at position 0 could not be parsed: Unknown type name '-' at position 0 in -.

    public function printNavLinks($navlinks, $place, $env = [], $do_print = true, $from)

Parameters which have default values should be placed at the end.

    {
        if ($from === null || $from === false) {
            $from = __METHOD__;
        }
        //$this->prtrace($navlinks);
        $plugin_manager = $this->plugin_manager;

        // Navlinks hook's place
        $plugin_functions_parameters = [
            'navlinks' => &$navlinks,
            'place'    => $place,
            'env'      => $env,
        ];
        $plugin_manager->do_hook('navlinks', $plugin_functions_parameters);

        if (count($navlinks) > 0) {
            if ($do_print) {
                $this->printLinksList($navlinks, 'navlink', true, $from);
            } else {
                return $this->printLinksList($navlinks, 'navlink', false, $from);
            }
        }
    }

    /**
     * Display navigation tabs
     * @param $tabs The name of current section (Ex: intro, server, ...), or an array with tabs (Ex: sqledit.php doFind function)

There must be exactly one blank line before the tags in a doc comment

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

     * @param $activetab The name of the tab to be highlighted.
     * @param  $print if false, return html

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

     */

Missing @return tag in function comment

    public function printTabs($alltabs, $activetab, $do_print = true, $from = null)
    {
        if ($from === null || $from === false) {
            $from = __METHOD__;
        }

        $lang = $this->lang;

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

        $misc = $this->misc;
        $data = $misc->getDatabaseAccessor();

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

        if (is_string($alltabs)) {
            $_SESSION['webdbLastTab'][$alltabs] = $activetab;
            $alltabs                            = $misc->getNavTabs($alltabs);
        }
        //$this->prtrace($tabs);
        $tabs_html = '';

        //Getting only visible tabs
        $tabs = [];
        if (count($alltabs) > 0) {
            foreach ($alltabs as $tab_id => $tab) {
                if (!isset($tab['hide']) || $tab['hide'] !== true) {
                    $tabs[$tab_id]            = $tab;
                    $tabs[$tab_id]['active']  = $active  = ($tab_id == $activetab) ? ' active' : '';

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

                    $tabs[$tab_id]['tablink'] = str_replace(['&', '.php'], ['&', ''], htmlentities($this->getActionUrl($tab, $_REQUEST, $from)));
                    if (isset($tab['icon']) && $icon = $misc->icon($tab['icon'])) {
                        $tabs[$tab_id]['iconurl'] = $icon;
                    }
                    if (isset($tab['help'])) {
                        $tabs[$tab_id]['helpurl'] = str_replace('&', '&', $this->misc->getHelpLink($tab['help']));
                    }
                }
            }
        }

        //$this->prtrace($tabs);

        if (count($tabs) > 0) {
            $width = (int) (100 / count($tabs)) . '%';

            $viewVars = [
                'width'           => $width,
                'tabs'            => $tabs,
                'controller_name' => $this->controller_name,
            ];

            $tabs_html = $this->getContainer()->view->fetch('components/tabs.twig', $viewVars);
        }

        if ($do_print) {
            echo $tabs_html;
        } else {
            return $tabs_html;
        }
    }

    /**
     * Get the URL for the last active tab of a particular tab bar.
     */

Missing @return tag in function comment

    public function getLastTabURL($section)
    {
        $lang = $this->lang;

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

        $misc = $this->misc;

        $tabs = $misc->getNavTabs($section);

        if (isset($_SESSION['webdbLastTab'][$section]) && isset($tabs[$_SESSION['webdbLastTab'][$section]])) {
            $tab = $tabs[$_SESSION['webdbLastTab'][$section]];
        } else {
            $tab = reset($tabs);
        }
        $this->prtrace(['section' => $section, 'tabs' => $tabs, 'tab' => $tab], 'getLastTabURL');
        return isset($tab['url']) ? $tab : null;
    }

    /**
     * [printTopbar description]
     * @param  bool $do_print true to print, false to return html

There must be exactly one blank line before the tags in a doc comment

     * @return string

Tag cannot be grouped with parameter tags in a doc comment

     */
    private function printTopbar($do_print = true, $from = null)

Private method name "HTMLNavbarController::printTopbar" must be prefixed with an underscore

    {
        if ($from === null || $from === false) {
            $from = __METHOD__;
        }

        $lang           = $this->lang;
        $plugin_manager = $this->plugin_manager;
        $misc           = $this->misc;
        $appName        = $misc->appName;
        $appVersion     = $misc->appVersion;
        $appLangFiles   = $misc->appLangFiles;

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

        $server_info = $misc->getServerInfo();
        $server_id   = $misc->getServerId();
        $reqvars     = $misc->getRequestVars('table');

        $topbar_html = '<div class="topbar" data-controller="' . $this->controller_name . '"><table style="width: 100%"><tr><td>';

        if ($server_info && isset($server_info['platform']) && isset($server_info['username'])) {
            /* top left informations when connected */
            $topbar_html .= sprintf($lang['strtopbar'],

The opening parenthesis of a multi-line function call should be the last content on the line.

                '<span class="platform">' . htmlspecialchars($server_info['platform']) . '</span>',
                '<span class="host">' . htmlspecialchars((empty($server_info['host'])) ? 'localhost' : $server_info['host']) . '</span>',
                '<span class="port">' . htmlspecialchars($server_info['port']) . '</span>',
                '<span class="username">' . htmlspecialchars($server_info['username']) . '</span>');

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

For multi-line function calls, the closing parenthesis should be on a new line.

            $topbar_html .= '</td>';

            /* top right informations when connected */

            $toplinks = [
                'sql'     => [
                    'attr'    => [
                        'href'   => [
                            'url'     => SUBFOLDER . '/src/views/sqledit',
                            'urlvars' => array_merge($reqvars, [

The opening parenthesis of a multi-line function call should be the last content on the line.

                                'action' => 'sql',
                            ]),

For multi-line function calls, the closing parenthesis should be on a new line.

                        ],
                        'target' => 'sqledit',
                        'id'     => 'toplink_sql',
                    ],
                    'content' => $lang['strsql'],
                ],
                'history' => [
                    'attr'    => [
                        'href' => [
                            'url'     => SUBFOLDER . '/src/views/history',
                            'urlvars' => array_merge($reqvars, [

The opening parenthesis of a multi-line function call should be the last content on the line.

                                'action' => 'pophistory',
                            ]),

For multi-line function calls, the closing parenthesis should be on a new line.

                        ],
                        'id'   => 'toplink_history',
                    ],
                    'content' => $lang['strhistory'],
                ],
                'find'    => [
                    'attr'    => [
                        'href'   => [
                            'url'     => SUBFOLDER . '/src/views/sqledit',
                            'urlvars' => array_merge($reqvars, [

The opening parenthesis of a multi-line function call should be the last content on the line.

                                'action' => 'find',
                            ]),

For multi-line function calls, the closing parenthesis should be on a new line.

                        ],
                        'target' => 'sqledit',
                        'id'     => 'toplink_find',
                    ],
                    'content' => $lang['strfind'],
                ],
                'logout'  => [
                    'attr'    => [
                        'href' => [
                            'url'     => SUBFOLDER . '/src/views/servers',
                            'urlvars' => [
                                'action'       => 'logout',
                                'logoutServer' => "{$server_info['host']}:{$server_info['port']}:{$server_info['sslmode']}",
                            ],
                        ],
                        'id'   => 'toplink_logout',
                    ],
                    'content' => $lang['strlogout'],
                ],
            ];

            // Toplink hook's place
            $plugin_functions_parameters = [
                'toplinks' => &$toplinks,
            ];

            $plugin_manager->do_hook('toplinks', $plugin_functions_parameters);

            $topbar_html .= '<td style="text-align: right">';

            $topbar_html .= $this->printLinksList($toplinks, 'toplink', [], false, $from);

array() of type array is incompatible with the type boolean expected by parameter $do_print of PHPPgAdmin\XHtml\HTMLNavbarController::printLinksList().

The call to PHPPgAdmin\XHtml\HTMLNavbarController::printLinksList() has too many arguments starting with $from.

            $topbar_html .= '</td>';

            $sql_window_id     = htmlentities('sqledit:' . $server_id);
            $history_window_id = htmlentities('history:' . $server_id);

            $topbar_html .= "<script type=\"text/javascript\">
						$('#toplink_sql').click(function() {
							window.open($(this).attr('href'),'{$sql_window_id}','toolbar=no,width=750,height=520,resizable=yes,scrollbars=yes').focus();
							return false;
						});

						$('#toplink_history').click(function() {
							window.open($(this).attr('href'),'{$history_window_id}','toolbar=no,width=700,height=500,resizable=yes,scrollbars=yes').focus();
							return false;
						});

						$('#toplink_find').click(function() {
							window.open($(this).attr('href'),'{$sql_window_id}','toolbar=no,width=750,height=520,resizable=yes,scrollbars=yes').focus();
							return false;
						});
						";

            if (isset($_SESSION['sharedUsername'])) {
                $topbar_html .= sprintf("

The opening parenthesis of a multi-line function call should be the last content on the line.

						$('#toplink_logout').click(function() {
							return confirm('%s');
						});", str_replace("'", "\'", $lang['strconfdropcred']));

For multi-line function calls, the closing parenthesis should be on a new line.

            }

            $topbar_html .= '
				</script>';
        } else {
            $topbar_html .= "<span class=\"appname\">{$appName}</span> <span class=\"version\">{$appVersion}</span>";
        }
        /*
        echo "<td style=\"text-align: right; width: 1%\">";

        echo "<form method=\"get\"><select name=\"language\" onchange=\"this.form.submit()\">\n";
        $language = isset($_SESSION['webdbLanguage']) ? $_SESSION['webdbLanguage'] : 'english';
        foreach ($appLangFiles as $k => $v) {
        echo "<option value=\"{$k}\"",
        ($k == $language) ? ' selected="selected"' : '',
        ">{$v}</option>\n";
        }
        echo "</select>\n";
        echo "<noscript><input type=\"submit\" value=\"Set Language\"></noscript>\n";
        foreach ($_GET as $key => $val) {
        if ($key == 'language') continue;
        echo "<input type=\"hidden\" name=\"$key\" value=\"", htmlspecialchars($val), "\" />\n";
        }
        echo "</form>\n";

        echo "</td>";
         */
        $topbar_html .= "</tr></table></div>\n";

        if ($do_print) {
            echo $topbar_html;
        } else {
            return $topbar_html;
        }
    }

    private function getHREFSubject($subject)

Private method name "HTMLNavbarController::getHREFSubject" must be prefixed with an underscore

Missing function doc comment

    {
        $vars = $this->misc->getSubjectParams($subject);
        ksort($vars['params']);
        return "{$vars['url']}?" . http_build_query($vars['params'], '', '&');
    }

    /**
     * Create a bread crumb trail of the object hierarchy.
     * @param $object The type of object at the end of the trail.

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    private function getTrail($subject = null)

Private method name "HTMLNavbarController::getTrail" must be prefixed with an underscore

    {
        $lang           = $this->lang;
        $plugin_manager = $this->plugin_manager;
        $misc           = $this->misc;
        $appName        = $misc->appName;

        $data = $misc->getDatabaseAccessor();

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

        $trail = [];
        $vars  = '';

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

        $done  = false;

        $trail['root'] = [
            'text' => $appName,
            'url'  => SUBFOLDER . '/src/views/servers',
            'icon' => 'Introduction',
        ];

        if ($subject == 'root') {
            $done = true;
        }

        if (!$done) {
            $server_info     = $misc->getServerInfo();
            $trail['server'] = [
                'title' => $lang['strserver'],
                'text'  => $server_info['desc'],
                'url'   => $this->getHREFSubject('server'),
                'help'  => 'pg.server',
                'icon'  => 'Server',
            ];
        }
        if ($subject == 'server') {
            $done = true;
        }

        if (isset($_REQUEST['database']) && !$done) {
            $trail['database'] = [
                'title' => $lang['strdatabase'],
                'text'  => $_REQUEST['database'],
                'url'   => $this->getHREFSubject('database'),
                'help'  => 'pg.database',
                'icon'  => 'Database',
            ];
        } elseif (isset($_REQUEST['rolename']) && !$done) {
            $trail['role'] = [
                'title' => $lang['strrole'],
                'text'  => $_REQUEST['rolename'],
                'url'   => $this->getHREFSubject('role'),
                'help'  => 'pg.role',
                'icon'  => 'Roles',
            ];
        }
        if ($subject == 'database' || $subject == 'role') {
            $done = true;
        }

        if (isset($_REQUEST['schema']) && !$done) {
            $trail['schema'] = [
                'title' => $lang['strschema'],
                'text'  => $_REQUEST['schema'],
                'url'   => $this->getHREFSubject('schema'),
                'help'  => 'pg.schema',
                'icon'  => 'Schema',
            ];
        }
        if ($subject == 'schema') {
            $done = true;
        }

        if (isset($_REQUEST['table']) && !$done) {
            $trail['table'] = [
                'title' => $lang['strtable'],
                'text'  => $_REQUEST['table'],
                'url'   => $this->getHREFSubject('table'),
                'help'  => 'pg.table',
                'icon'  => 'Table',
            ];
        } elseif (isset($_REQUEST['view']) && !$done) {
            $trail['view'] = [
                'title' => $lang['strview'],
                'text'  => $_REQUEST['view'],
                'url'   => $this->getHREFSubject('view'),
                'help'  => 'pg.view',
                'icon'  => 'View',
            ];
        } elseif (isset($_REQUEST['matview']) && !$done) {
            $trail['matview'] = [
                'title' => 'M' . $lang['strview'],
                'text'  => $_REQUEST['matview'],
                'url'   => $this->getHREFSubject('matview'),
                'help'  => 'pg.matview',
                'icon'  => 'MViews',
            ];
        } elseif (isset($_REQUEST['ftscfg']) && !$done) {
            $trail['ftscfg'] = [
                'title' => $lang['strftsconfig'],
                'text'  => $_REQUEST['ftscfg'],
                'url'   => $this->getHREFSubject('ftscfg'),
                'help'  => 'pg.ftscfg.example',
                'icon'  => 'Fts',
            ];
        }
        if ($subject == 'table' || $subject == 'view' || $subject == 'matview' || $subject == 'ftscfg') {
            $done = true;
        }

        if (!$done && !is_null($subject)) {
            switch ($subject) {
                case 'function':
                    $trail[$subject] = [
                        'title' => $lang['str' . $subject],
                        'text'  => $_REQUEST[$subject],
                        'url'   => $this->getHREFSubject('function'),
                        'help'  => 'pg.function',
                        'icon'  => 'Function',
                    ];
                    break;
                case 'aggregate':
                    $trail[$subject] = [
                        'title' => $lang['straggregate'],
                        'text'  => $_REQUEST['aggrname'],
                        'url'   => $this->getHREFSubject('aggregate'),
                        'help'  => 'pg.aggregate',
                        'icon'  => 'Aggregate',
                    ];
                    break;
                case 'column':
                    $trail['column'] = [
                        'title' => $lang['strcolumn'],
                        'text'  => $_REQUEST['column'],
                        'icon'  => 'Column',
                        'url'   => $this->getHREFSubject('column'),
                    ];
                    break;
                default:
                    if (isset($_REQUEST[$subject])) {
                        switch ($subject) {
                            case 'domain':$icon = 'Domain';
                                break;
                            case 'sequence':$icon = 'Sequence';
                                break;
                            case 'type':$icon = 'Type';
                                break;
                            case 'operator':$icon = 'Operator';
                                break;
                            default:$icon = null;
                                break;
                        }
                        $trail[$subject] = [
                            'title' => array_key_exists('str' . $subject, $lang) ? $lang['str' . $subject] : $subject,
                            'text'  => $_REQUEST[$subject],
                            'help'  => 'pg.' . $subject,
                            'icon'  => $icon,
                        ];
                    }
            }
        }

        // Trail hook's place
        $plugin_functions_parameters = [
            'trail'   => &$trail,
            'section' => $subject,
        ];

        $plugin_manager->do_hook('trail', $plugin_functions_parameters);

        //$this->prtrace($trail);

        return $trail;
    }

    /**
     * Display a list of links
     * @param $links An associative array of links to print. See printLink function for

There must be exactly one blank line before the tags in a doc comment

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

     *               the links array format.
     * @param $class An optional class or list of classes seprated by a space
     *   WARNING: This field is NOT escaped! No user should be able to inject something here, use with care.
     * @param  boolean $do_print true to echo, false to return

Expected 56 spaces after parameter type; 1 found

     */

Missing @return tag in function comment

    private function printLinksList($links, $class = '', $do_print = true, $from = null)

Private method name "HTMLNavbarController::printLinksList" must be prefixed with an underscore

    {
        if ($from === null || $from === false) {
            $from = __METHOD__;
        }
        $misc      = $this->misc;

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

        $list_html = "<ul class=\"{$class}\">\n";
        foreach ($links as $link) {
            $list_html .= "\t<li>";
            $list_html .= str_replace('.php', '', $this->printLink($link, false, $from));
            $list_html .= "</li>\n";
        }
        $list_html .= "</ul>\n";
        if ($do_print) {
            echo $list_html;
        } else {
            return $list_html;
        }
    }
}