Intraface_Controller_Restricted - Code Metrics - intraface/intraface.dk - Measure and Improve Code Quality continuously with Scrutinizer

Intraface_Controller_Restricted B
last analyzed 2017-03-20 12:20 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	250
Duplicated Lines	12 %

Coupling/Cohesion

Components	1
Dependencies	10

Test Coverage

Coverage

Importance

Changes

Metric	Value
dl	30
loc	250
rs	8.3157
c	0
b	0
f	0
ccs	0
cts	189
cp	0
wmc	43
lcom	1
cbo	10

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	document()	0	4	1
A	map()	0	8	3
A	dispatch()	0	8	2
C	renderHtml()	0	56	11
A	wrapHtml()	0	10	2
A	execute()	0	4	1
A	getKernel()	0	11	3
A	getLastView()	0	6	1
A	getUserMenu()	4	16	2
A	getMenu()	0	18	3
D	getSubmenu()	26	43	10
A	getIntranetName()	0	5	1
A	getThemeKey()	0	4	1
A	getFontSize()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Intraface_Controller_Restricted often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Intraface_Controller_Restricted, and based on these observations, apply Extract Interface, too.

<?php
class Intraface_Controller_Restricted extends k_Component
{
    protected $mdb2;
    protected $db_sql;
    protected $kernel;
    protected $user_gateway;
    protected $kernel_gateway;
    protected $template;
    protected $cache;

    function __construct(Cache_Lite $cache, DB_Sql $db_sql, MDB2_Driver_Common $mdb2, Intraface_UserGateway $gateway, Intraface_KernelGateway $kernel_gateway, k_TemplateFactory $template)
    {
        $this->mdb2 = $mdb2; // this is here to make sure set names utf8 is run as the first thing in the app
        $this->db_sql = $db_sql;
        $this->user_gateway = $gateway;
        $this->kernel_gateway = $kernel_gateway;
        $this->template = $template;
        $this->cache = $cache;
    }

    function document()
    {
        return $this->document;
    }

    protected function map($name)
    {
        if ($name == 'switchintranet') {
            return 'Intraface_Controller_SwitchIntranet';
        } elseif ($name == 'module') {
            return 'Intraface_Controller_ModuleGatekeeper';
        }
    }

    function dispatch()
    {
        if ($this->identity()->anonymous()) {
            throw new k_NotAuthorized();
        }

        return parent::dispatch();
    }

    function renderHtml()
    {
        $this->document->setTitle('Dashboard');

        $_advice[] = array();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $_attention_needed[] = array();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        if (in_array($this->query('message'), array('hide'))) {
            $this->getKernel()->setting->set('user', 'homepage.message', 'hide');
        }

        $kernel = $this->getKernel();

        // getting stuff to show on the dashboard
        $modules = $this->getKernel()->getModules();

        foreach ($modules as $module) {
            if (!$this->getKernel()->intranet->hasModuleAccess(intval($module['id']))) {
                continue;
            }
            if (!$this->getKernel()->user->hasModuleAccess(intval($module['id']))) {
                continue;
            }

            $module = $this->getKernel()->useModule($module['name']);
            $frontpage_files = $module->getFrontpageFiles();

            if (!is_array($frontpage_files) or count($frontpage_files) == 0) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
                continue;
            }

            foreach ($frontpage_files as $file) {
                $file = PATH_INCLUDE_MODULE . $module->getName() . '/' .$file;
                if (file_exists($file)) {
                    include($file);
                }
            }
        }
        // Adds link for id user details is filled in. They are going to be in the top.
        if ($this->getKernel()->user->hasModuleAccess('controlpanel')) {
            if (!$this->getKernel()->user->isFilledIn()) {
                $_advice[] = array(
                    'msg' => 'all information about you has not been filled in',
                    'link' => $this->url('core/restricted/module/controlpanel/user', array('edit')),
                    'module' => 'dashboard'
                );
            }
        }

        $data = array(
            '_attention_needed' => $_attention_needed,
            '_advice' => $_advice
        );

        $smarty = $this->template->create(dirname(__FILE__) . '/templates/restricted');
        return $smarty->render($this, $data);
    }

    function wrapHtml($content)
    {
        if ($this->document()->title() == 'No Title') {
            $this->document->setTitle('Intraface.dk');
        }

        $tpl = $this->template->create(dirname(__FILE__) . '/templates/main');
        $content = $tpl->render($this, array('content' => $content));
        return new k_HttpResponse(200, $content);
    }

    function execute()
    {
        return $this->wrap(parent::execute());
    }

    /**
     * @todo Maybe move to a user object implementing getIntranet()
     * In $intranet we can have the transient gateways.
     *
     * class component_ShowProduct {
     *   protected $user_gateway;
     *   function __construct(UserGateway $user_gateway) {
     *     $this->user_gateway = $user_gateway;
     *   }
     *   function GET() {
     *     $user = $user_gateway->getByUsername($this->identity()->getUsername());
     *     return $this->render('product.tpl.php', array('product' => $user->getIntranet()->getProduct()));
     *   }
     * }
     *
     * http://pastie.org/683209
     *
     * @return object
     */
    function getKernel()
    {
        if (is_object($this->kernel)) {
            return $this->kernel;
        }
        try {
            return $this->kernel = $this->kernel_gateway->findByUserobject($this->user_gateway->findByUsername($this->identity()->user()));
        } catch (Exception $e) {
            return new k_SeeOther($this->url('/logout'));
        }
    }

    function getLastView()
    {
        $last_view = $this->getKernel()->setting->get('user', 'homepage.last_view');
        $this->getKernel()->setting->set('user', 'homepage.last_view', date('Y-m-d H:i:s'));
        return $last_view;
    }

    function getUserMenu()
    {
        $this->usermenu = array();
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->usermenu[0]['name'] = $this->t('Logout');
        $this->usermenu[0]['url'] = $this->url('/logout');
        if (count($this->getKernel()->user->getIntranetList()) > 1) {
            $this->usermenu[1]['name'] = $this->t('Switch intranet');
            $this->usermenu[1]['url'] = $this->url('/restricted/switchintranet');
        }
        $this->usermenu[2]['name'] = $this->t('Modules');
        $this->usermenu[2]['url'] = $this->url('/restricted/module');
        $this->usermenu[3]['name'] = $this->t('Control panel');
        $this->usermenu[3]['url'] = $this->url('/restricted/module/controlpanel');

        return $this->usermenu;
    }

    function getMenu()
    {
        $this->menu = array();
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $i = 0;
        $this->menu[$i]['name'] = $this->t('dashboard');
        $this->menu[$i]['url'] = $this->url('/restricted/');
        $i++;
        $this->db = new DB_Sql;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->db->query("SELECT name, menu_label, name FROM module WHERE active = 1 AND show_menu = 1 ORDER BY menu_index");
        while ($this->db->nextRecord()) {
            if ($this->getKernel()->user->hasModuleAccess($this->db->f('name'))) {
                $this->menu[$i]['name'] = $this->t($this->db->f('name'));
                $this->menu[$i]['url'] = $this->url('/restricted/module/' . $this->db->f("name"));
                $i++;
            }
        }
        return $this->menu;
    }

    function getSubmenu()
    {
        $this->primary_module = $this->kernel->getPrimaryModule();
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->submenu = array();
class MyClass { }

$x = new MyClass();
$x->foo = true;
        if (is_object($this->primary_module)) {
            $all_submenu = $this->primary_module->getSubmenu();
            if (count($all_submenu) > 0) { // added to avoid error messages
                $j = 0;
                for ($i = 0, $max = count($all_submenu); $i < $max; $i++) {
                    $access = false;
                    if ($all_submenu[$i]['sub_access'] != '') {
                        $sub = explode(":", $all_submenu[$i]['sub_access']);

                        switch ($sub[0]) {
                            case 'sub_access':
                                if ($this->getKernel()->user->hasSubAccess($this->primary_module->module_name, $sub[1])) {
                                    $access = true;
                                }
                                break;
                            case 'module':
                                if ($this->getKernel()->user->hasModuleAccess($sub[1])) {
                                    $access = true;
                                }
                                break;
                            default:
                                throw new Exception('Der er ikke angivet om submenu skal tjekke efter sub_access eller module adgang, for undermenupunktet i Page->start();');
                                break;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
                        }
                    } else {
                        $access = true;
                    }

                    if ($access) {
                        $this->submenu[$j]['name'] = $this->t($all_submenu[$i]['label']);
                        $this->submenu[$j]['url'] = $this->primary_module->getPath(). $all_submenu[$i]['url'];
                        $j++;
                    }
                }
            }
        }

        return $this->submenu;
    }

    function getIntranetName()
    {
        return $this->getKernel()->intranet->get('name');
        ;
    }
    
    function getThemeKey()
    {
        return $this->getKernel()->setting->get('user', 'theme');
    }

    function getFontSize()
    {
         return $this->getKernel()->setting->get('user', 'ptextsize');
    }
}


intraface / intraface.dk

Intraface_Controller_Restricted B last analyzed 2017-03-20 12:20 UTC