PHPPgAdmin\Controller\BaseController

Complexity

Total Complexity

50

Size/Duplication

Total Lines	462
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

32 Methods

Rating	Name	Duplication	Size	Complexity
A	doDefault()	0	6	1
A	printTrail()	0	6	1
A	_getHeaderController()	0	11	2
A	printHeader()	0	6	2
A	printTitle()	0	5	1
A	_getTreeController()	0	6	1
A	setFocus()	0	5	1
A	headerTitle()	0	5	3
A	setReloadDropDatabase()	0	5	1
A	printTabs()	0	6	1
A	setNoOutput()	0	5	1
A	printMsg()	0	14	3
A	getContainer()	0	3	1
A	printTree()	0	15	3
A	getQueryParam()	0	3	1
A	_getFooterController()	0	11	2
A	printTable()	0	7	1
A	setWindowName()	0	5	1
A	_getTableController()	0	11	2
A	adjustTabsForTree()	0	6	1
A	printLink()	0	9	2
A	render()	0	15	1
A	setNoBottomLink()	0	5	1
A	printReload()	0	5	1
A	_getTreeInstance()	0	10	2
A	printFooter()	0	9	2
A	printBody()	0	5	1
A	getPostParam()	0	3	1
A	printNavLinks()	0	6	1
A	__construct()	0	45	5
A	getRequestParam()	0	3	1
A	_getNavbarController()	0	11	2

<?php

/**
 * PHPPgAdmin v6.0.0-RC1.
 */

namespace PHPPgAdmin\Controller;

ini_set('display_errors', 1);
/**
 * Base controller class.
 */
class BaseController
{
    use \PHPPgAdmin\Traits\HelperTrait;

    protected $container;
    protected $app;
    protected $data;
    protected $database;
    protected $server_id;
    public $appLangFiles = [];
    public $appThemes    = [];
    public $appName      = '';
    public $appVersion   = '';
    public $form         = '';
    public $href         = '';
    public $lang         = [];
    public $action       = '';
    public $controller_name;

    /**
     * Used.
     *
     * @var string
     */
    public $view_name;
    /**
     * Used to print the title passing its value to $lang.
     *
     * @var string
     */
    public $controller_title = 'base';
    protected $table_controller;
    protected $trail_controller;
    private static $_tree_controller = null;

    protected $footer_controller;
    protected $header_controller;
    protected $scripts = '';
    public $msg        = '';
    public $view;
    public $plugin_manager;
    public $misc;
    public $conf;
    public $phpMinVer;
    protected $no_db_connection = false;

    /**
     * Constructs the base controller (common for almost all controllers).
     *
     * @param \Slim\Container $container        the $app container
     * @param bool            $no_db_connection [optional] if true, sets  $this->misc->setNoDBConnection(true);
     */
    public function __construct(\Slim\Container $container)
    {
        $this->container = $container;
        $this->lang      = $container->get('lang');

        $this->controller_name = str_replace(__NAMESPACE__ . '\\', '', get_class($this));
        $this->view_name       = str_replace('controller', '', strtolower($this->controller_name));
        $this->script          = $this->view_name;

        $this->view           = $container->get('view');
        $this->plugin_manager = $container->get('plugin_manager');
        $this->msg            = $container->get('msg');
        $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');

        $this->appName          = $container->get('settings')['appName'];
        $this->appVersion       = $container->get('settings')['appVersion'];
        $this->postgresqlMinVer = $container->get('settings')['postgresqlMinVer'];
        $this->phpMinVer        = $container->get('settings')['phpMinVer'];

        $msg = $container->get('msg');

        if (true === $this->no_db_connection) {
            $this->misc->setNoDBConnection(true);
        }

        if (false === $this->misc->getNoDBConnection()) {
            if (null === $this->misc->getServerId()) {
                $servers_controller = new \PHPPgAdmin\Controller\ServersController($container);

                return $servers_controller->render();
            }
            $_server_info = $this->misc->getServerInfo();
            // Redirect to the login form if not logged in
            if (!isset($_server_info['username'])) {
                $msg = sprintf($this->lang['strlogoutmsg'], $_server_info['desc']);

                $servers_controller = new \PHPPgAdmin\Controller\ServersController($container);

                return $servers_controller->render();
            }
        }
    }

    /**
     * Default method to render the controller according to the action parameter.
     */
    public function render()
    {
        $this->misc = $this->misc;

        $this->printHeader();
        $this->printBody();

        switch ($this->action) {
            default:
                $this->doDefault();

                break;
        }

        $this->printFooter();
    }

    public function doDefault()
    {
        $html = '<div><h2>Section title</h2> <p>Main content</p></div>';
        echo $html;

        return $html;
    }

    /**
     * Returns the page title for each controller.
     *
     * @param string $title  The title
     * @param string $prefix The prefix
     * @param string $suffix The suffix
     *
     * @return string the page title
     */
    public function headerTitle($title = '', $prefix = '', $suffix = '')
    {
        $title = $title ? $title : $this->controller_title;

        return $prefix . $this->lang[$title] . ($suffix ? ': ' . $suffix : '');
    }

    public function getContainer()
    {
        return $this->container;
    }

    private function _getTableController()
    {
        if (null === $this->table_controller) {
            $this->prtrace(__METHOD__);
            $this->table_controller = new \PHPPgAdmin\XHtml\HTMLTableController(
                $this->getContainer(),
                $this->controller_name
            );
        }

        return $this->table_controller;
    }

    private function _getFooterController()
    {
        if (null === $this->footer_controller) {
            $this->prtrace(__METHOD__);
            $this->footer_controller = new \PHPPgAdmin\XHtml\HTMLFooterController(
                $this->getContainer(),
                $this->controller_name
            );
        }

        return $this->footer_controller;
    }

    private function _getHeaderController()
    {
        if (null === $this->header_controller) {
            $this->prtrace(__METHOD__);
            $this->header_controller = new \PHPPgAdmin\XHtml\HTMLHeaderController(
                $this->getContainer(),
                $this->controller_name
            );
        }

        return $this->header_controller;
    }

    private function _getNavbarController()
    {
        if (null === $this->trail_controller) {
            $this->prtrace(__METHOD__);
            $this->trail_controller = new \PHPPgAdmin\XHtml\HTMLNavbarController(
                $this->getContainer(),
                $this->controller_name
            );
        }

        return $this->trail_controller;
    }

    /**
     * Gets the tree instance.
     *
     * @param \Slim\Container $container        the $app container
     * @param <type>  $controller_name  The controller name

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

     *
     * @return \PHPPgAdmin\XHtml\TreeController The tree controller instance.
     */
    private static function _getTreeInstance($container, $controller_name)

The method _getTreeInstance() is not used, and could be removed.

    {
        if (null === self::$_tree_controller) {
            self::$_tree_controller = new \PHPPgAdmin\XHtml\TreeController(
                $container,
                $controller_name
            );
        }

        return self::$_tree_controller;
    }

    /**
     * Gets the tree controller.
     *
     * @param string  $from  From where is this method being called, for debug purposes
     *
     * @return \PHPPgAdmin\XHtml\TreeController  The tree controller.
     */
    private function _getTreeController($from)

The parameter $from is not used and could be removed.

    {
        //$tree = self::_getTreeInstance($this->getContainer(), $this->controller_name);
        $tree = new \PHPPgAdmin\XHtml\TreeController($this->getContainer(), $this->controller_name);
        $this->prtrace(__METHOD__);
        return $tree;

    }

    /**
     * Display a table of data.
     *
     * @param \PHPPgAdmin\ADORecordSet|\PHPPgAdmin\ArrayRecordSet $tabledata a set of data to be formatted
     * @param array                                               $columns   An associative array of columns to be displayed:
     * @param array                                               $actions   Actions that can be performed on each object:
     * @param string                                              $place     Place where the $actions are displayed. Like 'display-browse',
     * @param string                                              $nodata    (optional) Message to display if data set is empty
     * @param callable                                            $pre_fn    (optional) callback closure for each row
     *
     * @return string the html of the table
     */
    public function printTable(&$tabledata, &$columns, &$actions, $place, $nodata = '', $pre_fn = null)
    {
        $html_table = $this->_getTableController();

        $html_table->initialize($tabledata, $columns, $actions, $place, $nodata, $pre_fn);

        return $html_table->printTable();
    }

    public function adjustTabsForTree($tabs)
    {
        //$tree = self::_getTreeInstance($this->getContainer(), $this->controller_name);
        $tree = $this->_getTreeController(__METHOD__);

        return $tree->adjustTabsForTree($tabs);
    }

    /**
     * Produce JSON data for the browser tree.
     *
     * @param \PHPPgAdmin\ArrayRecordSet $_treedata a set of records to populate the tree
     * @param array                      $attrs     Attributes for tree items
     * @param string                     $section   The section where the branch is linked in the tree
     *
     * @return string the json rendered tree
     */
    public function printTree(&$_treedata, &$attrs, $section)
    {

        $tree = $this->_getTreeController(__METHOD__);

        $treedata = [];

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

        return $tree->printTreeJSON($treedata, $attrs, $section);
    }

    public function printTrail($trail = [], $do_print = true)
    {
        $from       = __METHOD__;
        $html_trail = $this->_getNavbarController();

        return $html_trail->printTrail($trail, $do_print, $from);
    }

    public function printNavLinks($navlinks, $place, $env = [], $do_print = true)
    {
        $from              = __METHOD__;
        $footer_controller = $this->_getFooterController();

        return $footer_controller->printNavLinks($navlinks, $place, $env, $do_print, $from);
    }

    public function printTabs($tabs, $activetab, $do_print = true)
    {
        $from       = __METHOD__;
        $html_trail = $this->_getNavbarController();

        return $html_trail->printTabs($tabs, $activetab, $do_print, $from);
    }

    public function printLink($link, $do_print = true, $from = null)
    {
        if (null === $from) {
            $from = __METHOD__;
        }

        $html_trail = $this->_getNavbarController();

        return $html_trail->printLink($link, $do_print, $from);
    }

    public function setReloadDropDatabase($flag)
    {
        $footer_controller = $this->_getFooterController();

        return $footer_controller->setReloadDropDatabase($flag);
    }

    public function setNoBottomLink($flag)
    {
        $footer_controller = $this->_getFooterController();

        return $footer_controller->setNoBottomLink($flag);
    }

    /**
     * Prints or returns the controller's footer
     *
     * @param boolean  $doBody      If false, return the body instead of print. Defaults to true
     * @param string   $template    The template to render
     * @param array    $viewParams  Optional - extra view parameters
     *
     * @return <type>  ( description_of_the_return_value )

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

     */
    public function printFooter($doBody = true, $template = 'footer.twig', $viewParams = [])
    {
        $footer_controller = $this->_getFooterController();

        $footer_html = $footer_controller->getFooter($template, $viewParams);
        if ($doBody) {
            echo $footer_html;
        } else {
            return $footer_html;
        }
    }

    public function printReload($database, $do_print = true)
    {
        $footer_controller = $this->_getFooterController();

        return $footer_controller->printReload($database, $do_print);
    }

    /**
     * Outputs JavaScript to set default focus.
     *
     * @param mixed $object eg. forms[0].username
     */
    public function setFocus($object)
    {
        $footer_controller = $this->_getFooterController();

        return $footer_controller->setFocus($object);
    }

    /**
     * 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)
    {
        $footer_controller = $this->_getFooterController();

        return $footer_controller->setWindowName($name, $addServer);
    }

    public function setNoOutput($flag)
    {
        $header_controller = $this->_getHeaderController();

        return $header_controller->setNoOutput((bool) $flag);
    }

    public function printHeader($title = '', $script = null, $do_print = true, $template = 'header.twig')
    {
        $title             = $title ? $title : $this->headerTitle();
        $header_controller = $this->_getHeaderController();

        return $header_controller->printHeader($title, $script, $do_print, $template);
    }

    public function printBody($doBody = true, $bodyClass = 'detailbody', $onloadInit = false)
    {
        $header_controller = $this->_getHeaderController();

        return $header_controller->printBody($doBody, $bodyClass, $onloadInit);
    }

    public function printTitle($title, $help = null, $do_print = true)
    {
        $header_controller = $this->_getHeaderController();

        return $header_controller->printTitle($title, $help, $do_print);
    }

    public function getRequestParam($key, $default = null)
    {
        return $this->container->requestobj->getParam($key, $default);
    }

    public function getPostParam($key, $default = null)
    {
        return $this->container->requestobj->getParsedBodyParam($key, $default);
    }

    public function getQueryParam($key, $default = null)
    {
        return $this->container->requestobj->getQueryParam($key, $default);
    }

    /**
     * Print out a message.
     *
     * @param string $msg      The message
     * @param bool   $do_print if true, print the message. Return the string otherwise
     *
     * @return string a paragraph containing the message, whose linebreaks are replaced by <br> elements
     */
    public function printMsg($msg, $do_print = true)
    {
        $html = '';
        $msg  = htmlspecialchars(\PHPPgAdmin\Traits\HelperTrait::br2ln($msg));
        if ('' != $msg) {
            $html .= '<p class="message">' . nl2br($msg) . '</p>' . PHP_EOL;
        }
        if ($do_print) {
            echo $html;

            return $html;
        }

        return $html;
    }
}