BaseController::printNavLinks() - Code Metrics - Inspection of "Tag v 6.0.0-beta.34" - HuasoFoundries/phpPgAdmin6 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2856b4...cf0423 )

by Felipe

created 2018-04-16 16:05 UTC

BaseController::printNavLinks() A

↳ Parent: BaseController

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	4
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php

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

namespace PHPPgAdmin\Controller;

/**
 * Base controller class.
 *
 * @package PHPPgAdmin
 */
class BaseController
{
    use \PHPPgAdmin\HelperTrait;


    protected $container;
    protected $_connection;

    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  = 'BaseController';
    public $controller_title = 'base';
    protected $table_controller;
    protected $trail_controller;
    protected $tree_controller;
    protected $footer_controller;
    protected $header_controller;
    protected $scripts = '';
    public $msg        = '';
    public $view;
    public $plugin_manager;
    public $misc;
    public $conf;
    public $phpMinVer;

    /**
     * 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, $no_db_connection = false)
    {
        $this->container = $container;
        $this->lang      = $container->get('lang');

        $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 === $no_db_connection) {
            $this->misc->setNoDBConnection(true);
        }

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

                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, true);

                return $servers_controller->render();
            }
        }

        //\PC::debug(['name' => $this->controller_name, 'no_db_connection' => $this->misc->getNoDBConnection()], 'instanced controller');
    }

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

        $this->printHeader($lang[$this->controller_title]);
        $this->printBody();

        switch ($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;
    }

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

    private function getTableController()

    {
        if (null === $this->table_controller) {
            $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->footer_controller = new \PHPPgAdmin\XHtml\HTMLFooterController($this->getContainer(), $this->controller_name);
        }

        return $this->footer_controller;
    }

    private function getHeaderController()

    {
        if (null === $this->header_controller) {
            $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->trail_controller = new \PHPPgAdmin\XHtml\HTMLNavbarController($this->getContainer(), $this->controller_name);
        }

        return $this->trail_controller;
    }

    private function getTreeController()

    {
        if (null === $this->tree_controller) {
            $this->tree_controller = new \PHPPgAdmin\XHtml\TreeController($this->getContainer(), $this->controller_name);
        }

        return $this->tree_controller;
    }

    /**
     * Instances an HTMLTable and returns its html content.
     *
     * @param [type] &$tabledata [description]

     * @param [type] &$columns   [description]

     * @param [type] &$actions   [description]

     * @param [type] $place      [description]
     * @param [type] $nodata     [description]
     * @param [type] $pre_fn     [description]
     *
     * @return [type] [description]

     */
    public function printTable(&$tabledata, &$columns, &$actions, $place, $nodata = null, $pre_fn = null)
    {
        $html_table = $this->getTableController();

        return $html_table->printTable($tabledata, $columns, $actions, $place, $nodata, $pre_fn);
    }

    public function adjustTabsForTree($tabs)
    {
        $tree = $this->getTreeController();

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

    public function printTree(&$_treedata, &$attrs, $section, $print = true)
    {
        $tree = $this->getTreeController();

        return $tree->printTree($_treedata, $attrs, $section, $print);
    }

    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__;
        $html_trail = $this->getNavbarController();

        return $html_trail->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 getLastTabURL($section)
    {
        $html_trail = $this->getNavbarController();

        return $html_trail->getLastTabURL($section);
    }

    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);
    }

    public function printFooter($doBody = true, $template = 'footer.twig')
    {
        $footer_controller = $this->getFooterController();

        return $footer_controller->printFooter($doBody, $template);
    }

    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')
    {
        $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\HelperTrait::br2ln($msg));
        if ('' != $msg) {
            $html .= '<p class="message">' . nl2br($msg) . '</p>' . "\n";
        }
        if ($do_print) {
            echo $html;

            return $html;
        }

        return $html;
    }
}


1			<?php
2
3			/**
4			* PHPPgAdmin v6.0.0-beta.33
5			*/
6
7			namespace PHPPgAdmin\Controller;
8
9			/**
10			* Base controller class.
11			*
12			* @package PHPPgAdmin
13			*/
14			class BaseController
15			{
16			use \PHPPgAdmin\HelperTrait;
			1 ignored issue – show introduced 2018-03-23 22:32 UTC by Report Bug Copy Issue Report The trait `PHPPgAdmin\HelperTrait` requires some properties which are not provided by `PHPPgAdmin\Controller\BaseController`: `$responseobj`, `$requestobj` Loading history...
17
18			protected $container;
19			protected $_connection;
			1 ignored issue – show Coding Style introduced 2018-02-15 15:30 UTC by Report Bug Copy Issue Report Protected member variable `_connection` must not be prefixed with an underscore as per coding-style. Loading history...
20			protected $app;
21			protected $data;
22			protected $database;
23			protected $server_id;
24			public $appLangFiles = [];
25			public $appThemes = [];
26			public $appName = '';
27			public $appVersion = '';
28			public $form = '';
29			public $href = '';
30			public $lang = [];
31			public $action = '';
32			public $controller_name = 'BaseController';
33			public $controller_title = 'base';
34			protected $table_controller;
35			protected $trail_controller;
36			protected $tree_controller;
37			protected $footer_controller;
38			protected $header_controller;
39			protected $scripts = '';
40			public $msg = '';
41			public $view;
42			public $plugin_manager;
43			public $misc;
44			public $conf;
45			public $phpMinVer;
46
47			/**
48			* Constructs the base controller (common for almost all controllers).
49			*
50			* @param \Slim\Container $container the $app container
51			* @param bool $no_db_connection [optional] if true, sets $this->misc->setNoDBConnection(true);
52			*/
53			public function __construct(\Slim\Container $container, $no_db_connection = false)
54			{
55			$this->container = $container;
56			$this->lang = $container->get('lang');
57
58			$this->view = $container->get('view');
59			$this->plugin_manager = $container->get('plugin_manager');
60			$this->msg = $container->get('msg');
61			$this->appLangFiles = $container->get('appLangFiles');
62
63			$this->misc = $container->get('misc');
64			$this->conf = $this->misc->getConf();
65
66			$this->appThemes = $container->get('appThemes');
67			$this->action = $container->get('action');
68
69			$this->appName = $container->get('settings')['appName'];
70			$this->appVersion = $container->get('settings')['appVersion'];
71			$this->postgresqlMinVer = $container->get('settings')['postgresqlMinVer'];
72			$this->phpMinVer = $container->get('settings')['phpMinVer'];
73
74			$msg = $container->get('msg');
			1 ignored issue – show Unused Code introduced 2018-01-10 08:54 UTC by Report Bug Copy Issue Report The assignment to `$msg` is dead and can be removed. Loading history...
75
76			if (true === $no_db_connection) {
77			$this->misc->setNoDBConnection(true);
78			}
79
80			if (false === $this->misc->getNoDBConnection()) {
81			if (null === $this->misc->getServerId()) {
82			$servers_controller = new \PHPPgAdmin\Controller\ServersController($container, true);
83
84			return $servers_controller->render();
85			}
86			$_server_info = $this->misc->getServerInfo();
87			// Redirect to the login form if not logged in
88			if (!isset($_server_info['username'])) {
89			$msg = sprintf($this->lang['strlogoutmsg'], $_server_info['desc']);
90
91			$servers_controller = new \PHPPgAdmin\Controller\ServersController($container, true);
92
93			return $servers_controller->render();
94			}
95			}
96
97			//\PC::debug(['name' => $this->controller_name, 'no_db_connection' => $this->misc->getNoDBConnection()], 'instanced controller');
98			}
99
100			/**
101			* Default method to render the controller according to the action parameter.
102			*/
103			public function render()
104			{
105			$this->misc = $this->misc;
106			$lang = $this->lang;
107			$action = $this->action;
108
109			$this->printHeader($lang[$this->controller_title]);
110			$this->printBody();
111
112			switch ($action) {
113			default:
114			$this->doDefault();
115
116			break;
117			}
118
119			$this->printFooter();
120			}
121
122			public function doDefault()
123			{
124			$html = '<div><h2>Section title</h2> <p>Main content</p></div>';
125			echo $html;
126
127			return $html;
128			}
129
130			public function getContainer()
131			{
132			return $this->container;
133			}
134
135			private function getTableController()
			1 ignored issue – show Coding Style introduced 2017-10-08 18:23 UTC by Report Bug Copy Issue Report Private method name "BaseController::getTableController" must be prefixed with an underscore Loading history...
136			{
137			if (null === $this->table_controller) {
138			$this->table_controller = new \PHPPgAdmin\XHtml\HTMLTableController($this->getContainer(), $this->controller_name);
139			}
140
141			return $this->table_controller;
142			}
143
144			private function getFooterController()
			1 ignored issue – show Coding Style introduced 2017-10-08 18:23 UTC by Report Bug Copy Issue Report Private method name "BaseController::getFooterController" must be prefixed with an underscore Loading history...
145			{
146			if (null === $this->footer_controller) {
147			$this->footer_controller = new \PHPPgAdmin\XHtml\HTMLFooterController($this->getContainer(), $this->controller_name);
148			}
149
150			return $this->footer_controller;
151			}
152
153			private function getHeaderController()
			1 ignored issue – show Coding Style introduced 2017-10-08 18:23 UTC by Report Bug Copy Issue Report Private method name "BaseController::getHeaderController" must be prefixed with an underscore Loading history...
154			{
155			if (null === $this->header_controller) {
156			$this->header_controller = new \PHPPgAdmin\XHtml\HTMLHeaderController($this->getContainer(), $this->controller_name);
157			}
158
159			return $this->header_controller;
160			}
161
162			private function getNavbarController()
			1 ignored issue – show Coding Style introduced 2017-10-08 18:23 UTC by Report Bug Copy Issue Report Private method name "BaseController::getNavbarController" must be prefixed with an underscore Loading history...
163			{
164			if (null === $this->trail_controller) {
165			$this->trail_controller = new \PHPPgAdmin\XHtml\HTMLNavbarController($this->getContainer(), $this->controller_name);
166			}
167
168			return $this->trail_controller;
169			}
170
171			private function getTreeController()
			1 ignored issue – show Coding Style introduced 2017-10-08 18:23 UTC by Report Bug Copy Issue Report Private method name "BaseController::getTreeController" must be prefixed with an underscore Loading history...
172			{
173			if (null === $this->tree_controller) {
174			$this->tree_controller = new \PHPPgAdmin\XHtml\TreeController($this->getContainer(), $this->controller_name);
175			}
176
177			return $this->tree_controller;
178			}
179
180			/**
181			* Instances an HTMLTable and returns its html content.
182			*
183			* @param [type] &$tabledata [description]
			0 ignored issues – show Coding Style introduced 2017-10-08 18:23 UTC by Report Bug Copy Issue Report Doc comment for parameter &$tabledata does not match actual variable name $tabledata Loading history... Documentation Bug introduced 2018-04-16 16:10 UTC by Report Bug Copy Issue Report The doc comment `[type]` at position `0` could not be parsed: Unknown type name '[' at position 0 in [type]. Loading history...
184			* @param [type] &$columns [description]
			0 ignored issues – show Coding Style introduced 2017-10-08 18:23 UTC by Report Bug Copy Issue Report Doc comment for parameter &$columns does not match actual variable name $columns Loading history...
185			* @param [type] &$actions [description]
			0 ignored issues – show Coding Style introduced 2017-10-08 18:23 UTC by Report Bug Copy Issue Report Doc comment for parameter &$actions does not match actual variable name $actions Loading history...
186			* @param [type] $place [description]
187			* @param [type] $nodata [description]
188			* @param [type] $pre_fn [description]
189			*
190			* @return [type] [description]
			0 ignored issues – show Documentation Bug introduced 2018-04-16 16:10 UTC by Report Bug Copy Issue Report The doc comment `[type]` at position `0` could not be parsed: Unknown type name '[' at position 0 in [type]. Loading history...
191			*/
192			public function printTable(&$tabledata, &$columns, &$actions, $place, $nodata = null, $pre_fn = null)
193			{
194			$html_table = $this->getTableController();
195
196			return $html_table->printTable($tabledata, $columns, $actions, $place, $nodata, $pre_fn);
197			}
198
199			public function adjustTabsForTree($tabs)
200			{
201			$tree = $this->getTreeController();
202
203			return $tree->adjustTabsForTree($tabs);
204			}
205
206			public function printTree(&$_treedata, &$attrs, $section, $print = true)
207			{
208			$tree = $this->getTreeController();
209
210			return $tree->printTree($_treedata, $attrs, $section, $print);
211			}
212
213			public function printTrail($trail = [], $do_print = true)
214			{
215			$from = __METHOD__;
216			$html_trail = $this->getNavbarController();
217
218			return $html_trail->printTrail($trail, $do_print, $from);
219			}
220
221			public function printNavLinks($navlinks, $place, $env = [], $do_print = true)
222			{
223			$from = __METHOD__;
224			$html_trail = $this->getNavbarController();
225
226			return $html_trail->printNavLinks($navlinks, $place, $env, $do_print, $from);
227			}
228
229			public function printTabs($tabs, $activetab, $do_print = true)
230			{
231			$from = __METHOD__;
232			$html_trail = $this->getNavbarController();
233
234			return $html_trail->printTabs($tabs, $activetab, $do_print, $from);
235			}
236
237			public function getLastTabURL($section)
238			{
239			$html_trail = $this->getNavbarController();
240
241			return $html_trail->getLastTabURL($section);
242			}
243
244			public function printLink($link, $do_print = true, $from = null)
245			{
246			if (null === $from) {
247			$from = __METHOD__;
248			}
249
250			$html_trail = $this->getNavbarController();
251
252			return $html_trail->printLink($link, $do_print, $from);
253			}
254
255			public function setReloadDropDatabase($flag)
256			{
257			$footer_controller = $this->getFooterController();
258
259			return $footer_controller->setReloadDropDatabase($flag);
260			}
261
262			public function setNoBottomLink($flag)
263			{
264			$footer_controller = $this->getFooterController();
265
266			return $footer_controller->setNoBottomLink($flag);
267			}
268
269			public function printFooter($doBody = true, $template = 'footer.twig')
270			{
271			$footer_controller = $this->getFooterController();
272
273			return $footer_controller->printFooter($doBody, $template);
274			}
275
276			public function printReload($database, $do_print = true)
277			{
278			$footer_controller = $this->getFooterController();
279
280			return $footer_controller->printReload($database, $do_print);
281			}
282
283			/**
284			* Outputs JavaScript to set default focus.
285			*
286			* @param mixed $object eg. forms[0].username
287			*/
288			public function setFocus($object)
289			{
290			$footer_controller = $this->getFooterController();
291
292			return $footer_controller->setFocus($object);
293			}
294
295			/**
296			* Outputs JavaScript to set the name of the browser window.
297			*
298			* @param string $name the window name
299			* @param bool $addServer if true (default) then the server id is
300			* attached to the name
301			*/
302			public function setWindowName($name, $addServer = true)
303			{
304			$footer_controller = $this->getFooterController();
305
306			return $footer_controller->setWindowName($name, $addServer);
307			}
308
309			public function setNoOutput($flag)
310			{
311			$header_controller = $this->getHeaderController();
312
313			return $header_controller->setNoOutput((bool) $flag);
314			}
315
316			public function printHeader($title = '', $script = null, $do_print = true, $template = 'header.twig')
317			{
318			$header_controller = $this->getHeaderController();
319
320			return $header_controller->printHeader($title, $script, $do_print, $template);
321			}
322
323			public function printBody($doBody = true, $bodyClass = 'detailbody', $onloadInit = false)
324			{
325			$header_controller = $this->getHeaderController();
326
327			return $header_controller->printBody($doBody, $bodyClass, $onloadInit);
328			}
329
330			public function printTitle($title, $help = null, $do_print = true)
331			{
332			$header_controller = $this->getHeaderController();
333
334			return $header_controller->printTitle($title, $help, $do_print);
335			}
336
337			public function getRequestParam($key, $default = null)
338			{
339			return $this->container->requestobj->getParam($key, $default);
340			}
341
342			public function getPostParam($key, $default = null)
343			{
344			return $this->container->requestobj->getParsedBodyParam($key, $default);
345			}
346
347			public function getQueryParam($key, $default = null)
348			{
349			return $this->container->requestobj->getQueryParam($key, $default);
350			}
351
352			/**
353			* Print out a message.
354			*
355			* @param string $msg The message
356			* @param bool $do_print if true, print the message. Return the string otherwise
357			*
358			* @return string a paragraph containing the message, whose linebreaks are replaced by <br> elements
359			*/
360			public function printMsg($msg, $do_print = true)
361			{
362			$html = '';
363			$msg = htmlspecialchars(\PHPPgAdmin\HelperTrait::br2ln($msg));
364			if ('' != $msg) {
365			$html .= '<p class="message">' . nl2br($msg) . '</p>' . "\n";
366			}
367			if ($do_print) {
368			echo $html;
369
370			return $html;
371			}
372
373			return $html;
374			}
375			}
376

HuasoFoundries / phpPgAdmin6

Push — master ( 2856b4...cf0423 )

BaseController::printNavLinks() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like