HuasoFoundries / phpPgAdmin6

src/xhtml/HTMLFooterController.php

<?php

/**
 * PHPPgAdmin 6.1.3
 */

namespace PHPPgAdmin\XHtml;

/**
 * Class to render tables. Formerly part of Misc.php.
 */
class HTMLFooterController extends HTMLController
{
    public $controller_name = 'HTMLFooterController';

    private $_reload_drop_database = false;

    private $_no_bottom_link = false;

    /**
     * Sets the value of $_reload_drop_database which in turn will trigger a reload in the browser frame.
     *
     * @param bool $flag sets internal $_reload_drop_database var which will be passed to the footer methods
     *
     * @return HTMLFooterController $this the instance of this class
     */
    public function setReloadDropDatabase($flag)
    {
        $this->_reload_drop_database = (bool) $flag;

        return $this;
    }

    /**
     * Sets $_no_bottom_link boolean value.
     *
     * @param bool $flag [description]
     *
     * @return HTMLFooterController $this the instance of this class
     */
    public function setNoBottomLink($flag)
    {
        $this->_no_bottom_link = (bool) $flag;

        return $this;
    }

    /**
     * Prints the page footer.
     *
     * @param bool  $doBody   True to output body tag, false to return the html
     * @param mixed $template
     */
    public function printFooter($doBody = true, $template = 'footer.twig')
    {
        $reload_param = 'none';

        if ($this->view->getReloadBrowser()) {
            $reload_param = 'other';
        } elseif ($this->_reload_drop_database) {
            $reload_param = 'database';
        }

        $this->view->offsetSet('script_footer', '');
        $this->view->offsetSet('reload', $reload_param);
        $this->view->offsetSet('footer_template', $template);
        $this->view->offsetSet('print_bottom_link', !$this->_no_bottom_link);

        $footer_html = $this->view->fetch($template);

        if ($doBody) {
            echo $footer_html;
        } else {
            return $footer_html;
        }
    }

    /**
     * Outputs JavaScript to set default focus.
     *
     * @param string $object eg. forms[0].username
     */
    public function setFocus($object): void
    {
        echo '<script type="text/javascript">' . \PHP_EOL;
        echo "   document.{$object}.focus();\n";
        echo '</script>' . \PHP_EOL;
    }

    /**
     * Outputs JavaScript to set the name of the browser window.
     *
     * @param string $name      the window name
     * @param bool   $addServer if true (default) then the server id is
     *                          attached to the name
     */
    public function setWindowName($name, $addServer = true): void
    {
        echo '<script type="text/javascript">' . \PHP_EOL;
        echo "//<![CDATA[\n";
        echo "   window.name = '{$name}", ($addServer ? ':' . \htmlspecialchars($this->misc->getServerId()) : ''), "';\n";
        echo '//]]>' . \PHP_EOL;
        echo '</script>' . \PHP_EOL;
    }

    /**
     * Display the navlinks, below the table results.
     *
     * @param array  $navlinks An array with the the attributes and values that will be shown.
     *                         See printLinksList for array format.
     * @param string $place    Place where the $navlinks are displayed. Like 'display-browse',
     *                         where 'display' is the file (display) and 'browse' is the action
     * @param array  $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
     * @param mixed  $from     can either be null, false or the method calling this one
     */
    public function printNavLinks($navlinks, $place, $env, $do_print, $from)
    {
        if (null === $from || false === $from) {
            $from = __METHOD__;
        }

        // Navlinks hook's place
        $plugin_functions_parameters = [

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

            'navlinks' => &$navlinks,
            'place' => $place,
            'env' => $env,
        ];

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