category.php ➔ displayCategory() - Code Metrics - Inspection of "updates" - mambax7/smartfaq - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (c92e39)

by Michael

created 2017-02-26 23:33 UTC

category.php ➔ displayCategory() B

↳ Parent: Project

Complexity

Conditions	6
Paths	12

Size

Total Lines	62
Code Lines	53

Duplication

Lines	5
Ratio	8.06 %

Importance

Changes

Metric	Value
cc	6
eloc	53
nc	12
nop	2
dl	5
loc	62
rs	8.6652
c	0
b	0
f	0

How to fix Long Method

<?php


/**
 * Module: SmartFAQ
 * Author: The SmartFactory <www.smartfactory.ca>
 * Licence: GNU
 */

require_once __DIR__ . '/admin_header.php';

// Creating the category handler object
$categoryHandler = sf_gethandler('category');

$op = '';

if (isset($_GET['op'])) {
    $op = $_GET['op'];
}
if (isset($_POST['op'])) {
    $op = $_POST['op'];
}

// Where do we start?
$startcategory = isset($_GET['startcategory']) ? (int)$_GET['startcategory'] : 0;

/**
 * @param     $categoryObj
 * @param int $level
 */
function displayCategory($categoryObj, $level = 0)
{
    global $xoopsModule, $categoryHandler, $pathIcon16;
function myFunction($a, $b) {
    // Do something
}
    $description = $categoryObj->description();
    if (!XOOPS_USE_MULTIBYTES) {

        if (strlen($description) >= 100) {
            $description = substr($description, 0, 100 - 1) . '...';
        }
    }
    $modify = "<a href='category.php?op=mod&categoryid="
              . $categoryObj->categoryid()
              . "'><img src='"
              . $pathIcon16
              . '/edit.png'
              . "' title='"
              . _AM_SF_EDITCOL
              . "' alt='"
              . _AM_SF_EDITCOL
              . "' /></a>";
    $delete = "<a href='category.php?op=del&categoryid="
              . $categoryObj->categoryid()
              . "'><img src='"
              . $pathIcon16
              . '/delete.png'
              . "' title='"
              . _AM_SF_DELETECOL
              . "' alt='"
              . _AM_SF_DELETECOL
              . "' /></a>";

    $spaces = '';
    for ($j = 0; $j < $level; ++$j) {
        $spaces .= '&nbsp;&nbsp;&nbsp;';
    }

    echo '<tr>';
    echo "<td class='even' align='lefet'>"
         . $spaces
         . "<a href='"
         . XOOPS_URL
         . '/modules/'
         . $xoopsModule->dirname()
         . '/category.php?categoryid='
         . $categoryObj->categoryid()
         . "'><img src='"
         . XOOPS_URL
         . "/modules/smartfaq/assets/images/icon/subcat.gif' alt='' />&nbsp;"
         . $categoryObj->name()
         . '</a></td>';
    echo "<td class='even' align='left'>" . $description . '</td>';
    echo "<td class='even' align='center'>" . $categoryObj->weight() . '</td>';
    echo "<td class='even' align='center'> $modify $delete </td>";
    echo '</tr>';
    $subCategoriesObj = $categoryHandler->getCategories(0, 0, $categoryObj->categoryid());
    if (count($subCategoriesObj) > 0) {
        ++$level;
        foreach ($subCategoriesObj as $key => $thiscat) {
            displayCategory($thiscat, $level);
        }
    }
    unset($categoryObj);
}

/**
 * @param bool $showmenu
 * @param int  $categoryid
 */
function editcat($showmenu = false, $categoryid = 0)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
{
    //$moderators = array(); // just to define the variable

    //$allmods = array();

    $startfaq = isset($_GET['startfaq']) ? (int)$_GET['startfaq'] : 0;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
    global $categoryHandler, $xoopsUser, $xoopsUser, $myts, $xoopsConfig, $xoopsDB, $modify, $xoopsModuleConfig, $xoopsModule, $_GET;
function myFunction($a, $b) {
    // Do something
}
    include_once XOOPS_ROOT_PATH . '/class/xoopsformloader.php';

    // Creating the faq handler object
    $faqHandler = sf_gethandler('faq');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

    echo '<script type="text/javascript" src="funcs.js"></script>';
    echo '<style>';
    echo '<!-- ';
    echo 'select { width: 130px; }';
    echo '-->';
    echo '</style>';
    // If there is a parameter, and the id exists, retrieve data: we're editing a category
    if ($categoryid != 0) {

        // Creating the category object for the selected category
        $categoryObj = new sfCategory($categoryid);

        echo "<br>\n";
        if ($categoryObj->notLoaded()) {
            redirect_header('category.php', 1, _AM_SF_NOCOLTOEDIT);
        }
        sf_collapsableBar('bottomtable', 'bottomtableicon');
        echo "<img id='bottomtableicon' src=" . XOOPS_URL . '/modules/' . $xoopsModule->dirname() . "/assets/images/icon/close12.gif alt='' /></a>&nbsp;" . _AM_SF_EDITCOL . '</h3>';
        echo "<div id='bottomtable'>";
    } else {
        $categoryObj = $categoryHandler->create();
        echo "<br>\n";
        sf_collapsableBar('bottomtable', 'bottomtableicon');
        echo "<img id='bottomtableicon' src=" . XOOPS_URL . '/modules/' . $xoopsModule->dirname() . "/assets/images/icon/close12.gif alt='' /></a>&nbsp;" . _AM_SF_CATEGORY_CREATE . '</h3>';
        echo "<div id='bottomtable'>";
    }
    // Start category form
    $sform = new XoopsThemeForm(_AM_SF_CATEGORY, 'op', xoops_getenv('PHP_SELF'));
    $sform->setExtra('enctype="multipart/form-data"');

    // Name
    $sform->addElement(new XoopsFormText(_AM_SF_CATEGORY, 'name', 50, 255, $categoryObj->name('e')), true);

    // Parent Category
    $mytree = new XoopsTree($xoopsDB->prefix('smartfaq_categories'), 'categoryid', 'parentid');
    ob_start();
    $mytree->makeMySelBox('name', 'weight', $categoryObj->parentid(), 1, 'parentid');

    //makeMySelBox($title,$order="",$preset_id=0, $none=0, $sel_name="", $onchange="")

    $sform->addElement(new XoopsFormLabel(_AM_SF_PARENT_CATEGORY_EXP, ob_get_contents()));
    ob_end_clean();

    /*  $mytree = new XoopsTree($xoopsDB->prefix("smartfaq_categories"), "categoryid" , "parentid");

        ob_start();
        $sform->addElement(new XoopsFormHidden('categoryid', $categoryObj->categoryid()));
        $mytree->makeMySelBox("name", "weight", $categoryObj->categoryid());
        $sform->addElement(new XoopsFormLabel(_AM_SF_CATEGORY_FAQ, ob_get_contents()));
        ob_end_clean();
        */

    // Decsription
    $sform->addElement(new XoopsFormTextArea(_AM_SF_COLDESCRIPT, 'description', $categoryObj->description('e'), 7, 60));

    // Weight
    $sform->addElement(new XoopsFormText(_AM_SF_COLPOSIT, 'weight', 4, 4, $categoryObj->weight()));

    // READ PERMISSIONS
    $memberHandler = xoops_getHandler('member');
    $group_list    = $memberHandler->getGroupList();

    $groups_read_checkbox = new XoopsFormCheckBox(_AM_SF_PERMISSIONS_CAT_READ, 'groups_read[]', $categoryObj->getGroups_read());
    foreach ($group_list as $group_id => $group_name) {
        if ($group_id != XOOPS_GROUP_ADMIN) {
            $groups_read_checkbox->addOption($group_id, $group_name);
        }
    }
    $sform->addElement($groups_read_checkbox);
    // Apply permissions on all faqs
    $addapplyall_radio = new XoopsFormRadioYN(_AM_SF_PERMISSIONS_APPLY_ON_FAQS, 'applyall', 0, ' ' . _AM_SF_YES . '', ' ' . _AM_SF_NO . '');
    $sform->addElement($addapplyall_radio);
    // MODERATORS
    //$moderators_tray = new XoopsFormElementTray(_AM_SF_MODERATORS_DEF, '');


    $module_id = $xoopsModule->getVar('mid');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

    /*$gpermHandler = xoops_getHandler('groupperm');

    $mod_perms = $gpermHandler->getGroupIds('category_moderation', $categoryid, $module_id);

    $moderators_select = new XoopsFormSelect('', 'moderators', $moderators, 5, true);
    $moderators_tray->addElement($moderators_select);

    $butt_mngmods = new XoopsFormButton('', '', 'Manage mods', 'button');
    $butt_mngmods->setExtra('onclick="javascript:small_window(\'pop.php\', 370, 350);"');
    $moderators_tray->addElement($butt_mngmods);

    $butt_delmod = new XoopsFormButton('', '', 'Delete mod', 'button');
    $butt_delmod->setExtra('onclick="javascript:deleteSelectedItemsFromList(this.form.elements[\'moderators[]\']);"');
    $moderators_tray->addElement($butt_delmod);

    $sform->addElement($moderators_tray);
    */
    $sform->addElement(new XoopsFormHidden('categoryid', $categoryid));

    // Action buttons tray
    $button_tray = new XoopsFormElementTray('', '');

    /*for ($i = 0, $iMax = count($moderators); $i < $iMax; ++$i) {

    $allmods[] = $moderators[$i];
    }

    $hiddenmods = new XoopsFormHidden('allmods', $allmods);
    $button_tray->addElement($hiddenmods);
    */
    $hidden = new XoopsFormHidden('op', 'addcategory');
    $button_tray->addElement($hidden);
    // No ID for category -- then it's new category, button says 'Create'
    if (!$categoryid) {

        $butt_create = new XoopsFormButton('', '', _AM_SF_CREATE, 'submit');
        $butt_create->setExtra('onclick="this.form.elements.op.value=\'addcategory\'"');
        $button_tray->addElement($butt_create);

        $butt_clear = new XoopsFormButton('', '', _AM_SF_CLEAR, 'reset');
        $button_tray->addElement($butt_clear);

        $butt_cancel = new XoopsFormButton('', '', _AM_SF_CANCEL, 'button');
        $butt_cancel->setExtra('onclick="history.go(-1)"');
        $button_tray->addElement($butt_cancel);
    } else {
        // button says 'Update'
        $butt_create = new XoopsFormButton('', '', _AM_SF_MODIFY, 'submit');
        $butt_create->setExtra('onclick="this.form.elements.op.value=\'addcategory\'"');
        $button_tray->addElement($butt_create);

        $butt_cancel = new XoopsFormButton('', '', _AM_SF_CANCEL, 'button');
        $butt_cancel->setExtra('onclick="history.go(-1)"');
        $button_tray->addElement($butt_cancel);
    }

    $sform->addElement($button_tray);
    $sform->display();
    echo '</div>';

    if ($categoryid) {
        include_once XOOPS_ROOT_PATH . '/modules/smartfaq/include/displayfaqs.php';
    }

    unset($hidden);
}

switch ($op) {
    case 'mod':
        $categoryid = isset($_GET['categoryid']) ? (int)$_GET['categoryid'] : 0;
        $destList   = isset($_POST['destList']) ? $_POST['destList'] : '';
        $adminObject  = \Xmf\Module\Admin::getInstance();
        xoops_cp_header();

        $adminObject->displayNavigation(basename(__FILE__));
        editcat(true, $categoryid);
        break;

    case 'addcategory':
        global $_POST, $xoopsUser, $xoopsUser, $xoopsConfig, $xoopsDB, $xoopsModule, $xoopsModuleConfig, $modify, $myts, $categoryid;
function myFunction($a, $b) {
    // Do something
}

        $categoryid = isset($_POST['categoryid']) ? (int)$_POST['categoryid'] : 0;

        if ($categoryid != 0) {
            $categoryObj = new sfCategory($categoryid);
        } else {
            $categoryObj = $categoryHandler->create();
        }

        //if (isset($_POST['allmods'])) $allmods = $_POST['allmods'];

        //if (isset($_POST['moderators'])) $moderators = $_POST['moderators'];


        $categoryObj->setVar('parentid', isset($_POST['parentid']) ? (int)$_POST['parentid'] : 0);
        $applyall = isset($_POST['applyall']) ? (int)$_POST['applyall'] : 0;
        $categoryObj->setVar('weight', isset($_POST['weight']) ? (int)$_POST['weight'] : 1);

        // Groups and permissions
        if (isset($_POST['groups_read'])) {
            $categoryObj->setGroups_read($_POST['groups_read']);
        } else {
            $categoryObj->setGroups_read();
        }
        //  $groups_admin = isset($_POST['groups_admin'])? $_POST['groups_admin'] : array();

        //  $mod_perms = isset($_POST['mod_perms'])? $_POST['mod_perms'] : array();


        $categoryObj->setVar('name', $_POST['name']);

        $categoryObj->setVar('description', $_POST['description']);
        if ($categoryObj->isNew()) {
            $redirect_msg = _AM_SF_CATCREATED;
            $redirect_to  = 'category.php?op=mod';
        } else {
            $redirect_msg = _AM_SF_COLMODIFIED;
            $redirect_to  = 'category.php';
        }

        if (!$categoryObj->store()) {
            redirect_header('javascript:history.go(-1)', 3, _AM_SF_CATEGORY_SAVE_ERROR . sf_formatErrors($categoryObj->getErrors()));
        }
        // TODO : put this function in the category class
        sf_saveCategory_Permissions($categoryObj->getGroups_read(), $categoryObj->categoryid(), 'category_read');
        //sf_saveCategory_Permissions($groups_admin, $categoriesObj->categoryid(), 'category_admin');


        if ($applyall) {
            // TODO : put this function in the category class
            sf_overrideFaqsPermissions($categoryObj->getGroups_read(), $categoryObj->categoryid());
        }

        redirect_header($redirect_to, 2, $redirect_msg);
        break;

    case 'del':

        global $xoopsUser, $xoopsUser, $xoopsConfig, $xoopsDB, $_GET;
function myFunction($a, $b) {
    // Do something
}

        $module_id    = $xoopsModule->getVar('mid');
        $gpermHandler = xoops_getHandler('groupperm');

        $categoryid = isset($_POST['categoryid']) ? (int)$_POST['categoryid'] : 0;
        $categoryid = isset($_GET['categoryid']) ? (int)$_GET['categoryid'] : $categoryid;

        $categoryObj = new sfCategory($categoryid);

        $confirm = isset($_POST['confirm']) ? $_POST['confirm'] : 0;
        $name    = isset($_POST['name']) ? $_POST['name'] : '';

        if ($confirm) {
            if (!$categoryHandler->delete($categoryObj)) {
                redirect_header('category.php', 1, _AM_SF_DELETE_CAT_ERROR);
            }
            redirect_header('category.php', 1, sprintf(_AM_SF_COLISDELETED, $name));
        } else {
            // no confirm: show deletion condition
            $categoryid = isset($_GET['categoryid']) ? (int)$_GET['categoryid'] : 0;
            xoops_cp_header();
            xoops_confirm(array(
                              'op'         => 'del',
                              'categoryid' => $categoryObj->categoryid(),
                              'confirm'    => 1,
                              'name'       => $categoryObj->name()
                          ), 'category.php', _AM_SF_DELETECOL . " '" . $categoryObj->name() . "'. <br> <br>" . _AM_SF_DELETE_CAT_CONFIRM, _AM_SF_DELETE);
            xoops_cp_footer();
        }
        exit();
        break;

    case 'cancel':
        redirect_header('category.php', 1, sprintf(_AM_SF_BACK2IDX, ''));
        break;
    case 'default':
    default:
        $adminObject  = \Xmf\Module\Admin::getInstance();
        xoops_cp_header();

        $adminObject->displayNavigation(basename(__FILE__));
        echo "<br>\n";

        // Creating the objects for top categories
        $categoriesObj = $categoryHandler->getCategories($xoopsModuleConfig['perpage'], $startcategory, 0);

        sf_collapsableBar('toptable', 'toptableicon');
        echo "<img id='toptableicon' src=" . XOOPS_URL . '/modules/' . $xoopsModule->dirname() . "/assets/images/icon/close12.gif alt='' /></a>&nbsp;" . _AM_SF_CATEGORIES_TITLE . '</h3>';
        echo "<div id='toptable'>";
        echo '<span style="color: #567; margin: 3px 0 12px 0; font-size: small; display: block; ">' . _AM_SF_CATEGORIES_DSC . '</span>';

        echo "<table width='100%' cellspacing=1 cellpadding=3 border=0 class = outer>";
        echo '<tr>';
        echo "<th width='35%' class='bg3' align='left'><b>" . _AM_SF_ARTCOLNAME . '</b></td>';
        echo "<th class='bg3' align='left'><b>" . _AM_SF_DESCRIP . '</b></td>';
        echo "<th class='bg3' width='65' align='center'><b>" . _AM_SF_WEIGHT . '</b></td>';
        echo "<th width='60' class='bg3' align='center'><b>" . _AM_SF_ACTION . '</b></td>';
        echo '</tr>';
        $totalCategories = $categoryHandler->getCategoriesCount(0);
        if (count($categoriesObj) > 0) {
            foreach ($categoriesObj as $key => $thiscat) {
                displayCategory($thiscat);
            }
        } else {
            echo '<tr>';
            echo "<td class='head' align='center' colspan= '7'>" . _AM_SF_NOCAT . '</td>';
            echo '</tr>';
            $categoryid = '0';
        }
        echo "</table>\n";
        include_once XOOPS_ROOT_PATH . '/class/pagenav.php';
        $pagenav = new XoopsPageNav($totalCategories, $xoopsModuleConfig['perpage'], $startcategory, 'startcategory');
        echo '<div style="text-align:right;">' . $pagenav->renderNav() . '</div>';
        echo '</div>';

        editcat(false);

        break;
}

require_once __DIR__ . '/admin_footer.php';


Branch — master (c92e39)

category.php ➔ displayCategory() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2016-03-30 08:40 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 30 and the first side effect is on line 9. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3		/**
4		* Module: SmartFAQ
5		* Author: The SmartFactory <www.smartfactory.ca>
6		* Licence: GNU
7		*/
8
9		require_once __DIR__ . '/admin_header.php';
10
11		// Creating the category handler object
12		$categoryHandler = sf_gethandler('category');
13
14		$op = '';
15
16		if (isset($_GET['op'])) {
17		$op = $_GET['op'];
18		}
19		if (isset($_POST['op'])) {
20		$op = $_POST['op'];
21		}
22
23		// Where do we start?
24		$startcategory = isset($_GET['startcategory']) ? (int)$_GET['startcategory'] : 0;
25
26		/**
27		* @param $categoryObj
28		* @param int $level
29		*/
30		function displayCategory($categoryObj, $level = 0)
31		{
32		global $xoopsModule, $categoryHandler, $pathIcon16;
		0 ignored issues – show Compatibility Best Practice introduced 2016-01-18 08:41 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
33		$description = $categoryObj->description();
34	View Code Duplication	if (!XOOPS_USE_MULTIBYTES) {
		0 ignored issues – show Duplication introduced 2016-01-18 08:45 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
35		if (strlen($description) >= 100) {
36		$description = substr($description, 0, 100 - 1) . '...';
37		}

mambax7 / smartfaq

Branch — master (c92e39)

category.php ➔ displayCategory() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like