notification.inc.php ➔ smartfaq_notify_iteminfo() - 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

notification.inc.php ➔ smartfaq_notify_iteminfo() B

↳ Parent: Project

Complexity

Conditions	6
Paths	8

Size

Total Lines	46
Code Lines	29

Duplication

Lines	20
Ratio	43.48 %

Importance

Changes

Metric	Value
cc	6
eloc	29
nc	8
nop	2
dl	20
loc	46
rs	8.4751
c	0
b	0
f	0

<?php

/**
 * Module: SmartFAQ
 * Author: The SmartFactory <www.smartfactory.ca>
 * Licence: GNU
 * @param $category
 * @param $item_id
 * @return mixed
 */

function smartfaq_notify_iteminfo($category, $item_id)
{
    global $xoopsModule, $xoopsModuleConfig, $xoopsConfig;
function myFunction($a, $b) {
    // Do something
}

    if (empty($xoopsModule) || $xoopsModule->getVar('dirname') !== 'smartfaq') {
        /** @var XoopsModuleHandler $moduleHandler */
        $moduleHandler = xoops_getHandler('module');
        $module        = $moduleHandler->getByDirname('smartfaq');
        $configHandler = xoops_getHandler('config');
        $config        = $configHandler->getConfigsByCat(0, $module->getVar('mid'));
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
    } else {
        $module = $xoopsModule;
        $config = $xoopsModuleConfig;
$myVar = 'Value';
$higher = false;

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

    if ($category === 'global') {
        $item['name'] = '';
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
        $item['url']  = '';

        return $item;
    }

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

    if ($category === 'category') {

        // Assume we have a valid category id
        $sql          = 'SELECT name FROM ' . $xoopsDB->prefix('smartfaq_categories') . ' WHERE categoryid  = ' . $item_id;
        $result       = $xoopsDB->query($sql); // TODO: error check
        $result_array = $xoopsDB->fetchArray($result);
        $item['name'] = $result_array['name'];
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
        $item['url']  = XOOPS_URL . '/modules/' . $module->getVar('dirname') . '/category.php?categoryid=' . $item_id;

        return $item;
    }

    if ($category === 'faq') {

        // Assume we have a valid story id
        $sql          = 'SELECT question FROM ' . $xoopsDB->prefix('smartfaq_faq') . ' WHERE faqid = ' . $item_id;
        $result       = $xoopsDB->query($sql); // TODO: error check
        $result_array = $xoopsDB->fetchArray($result);
        $item['name'] = $result_array['question'];
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
        $item['url']  = XOOPS_URL . '/modules/' . $module->getVar('dirname') . '/faq.php?faqid=' . $item_id;

        return $item;
    }
}


Branch — master (c92e39)

notification.inc.php ➔ smartfaq_notify_iteminfo() B

Complexity

Size

Duplication

Importance

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
2
3		/**
4		* Module: SmartFAQ
5		* Author: The SmartFactory <www.smartfactory.ca>
6		* Licence: GNU
7		* @param $category
8		* @param $item_id
9		* @return mixed
10		*/
11
12		function smartfaq_notify_iteminfo($category, $item_id)
13		{
14		global $xoopsModule, $xoopsModuleConfig, $xoopsConfig;
		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...
15
16		if (empty($xoopsModule) \|\| $xoopsModule->getVar('dirname') !== 'smartfaq') {
17		/** @var XoopsModuleHandler $moduleHandler */
18		$moduleHandler = xoops_getHandler('module');
19		$module = $moduleHandler->getByDirname('smartfaq');
20		$configHandler = xoops_getHandler('config');
21		$config = $configHandler->getConfigsByCat(0, $module->getVar('mid'));
		0 ignored issues – show Unused Code introduced 2017-02-26 23:24 UTC by Report Bug Copy Issue Report `$config` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
22		} else {
23		$module = $xoopsModule;
24		$config = $xoopsModuleConfig;
		0 ignored issues – show Unused Code introduced 2017-02-26 23:24 UTC by Report Bug Copy Issue Report `$config` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
25		}
26
27		if ($category === 'global') {
28		$item['name'] = '';
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-18 08:40 UTC by Report Bug Copy Issue Report `$item` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$item = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
29		$item['url'] = '';
30
31		return $item;
32		}
33
34		global $xoopsDB;
		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...
35
36	View Code Duplication	if ($category === 'category') {
		0 ignored issues – show Duplication introduced 2016-03-30 08:40 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...
37		// Assume we have a valid category id
38		$sql = 'SELECT name FROM ' . $xoopsDB->prefix('smartfaq_categories') . ' WHERE categoryid = ' . $item_id;
39		$result = $xoopsDB->query($sql); // TODO: error check
40		$result_array = $xoopsDB->fetchArray($result);
41		$item['name'] = $result_array['name'];
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-18 08:40 UTC by Report Bug Copy Issue Report `$item` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$item = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
42		$item['url'] = XOOPS_URL . '/modules/' . $module->getVar('dirname') . '/category.php?categoryid=' . $item_id;
43
44		return $item;
45		}
46
47	View Code Duplication	if ($category === 'faq') {
		0 ignored issues – show Duplication introduced 2016-03-30 08:40 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...
48		// Assume we have a valid story id
49		$sql = 'SELECT question FROM ' . $xoopsDB->prefix('smartfaq_faq') . ' WHERE faqid = ' . $item_id;
50		$result = $xoopsDB->query($sql); // TODO: error check
51		$result_array = $xoopsDB->fetchArray($result);
52		$item['name'] = $result_array['question'];
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-18 08:40 UTC by Report Bug Copy Issue Report `$item` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$item = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
53		$item['url'] = XOOPS_URL . '/modules/' . $module->getVar('dirname') . '/faq.php?faqid=' . $item_id;
54
55		return $item;
56		}
57		}
58

mambax7 / smartfaq

Branch — master (c92e39)

notification.inc.php ➔ smartfaq_notify_iteminfo() B

Complexity

Size

Duplication

Importance

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