notification.inc.php ➔ xtubeNotifyIteminfo() - Code Metrics - Inspection of "Merge pull request #14 from trabisdementia/Bleek" - XoopsModules25x/xoopstube - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (ddc2b8)

by Michael

created 2017-05-19 09:37 UTC

notification.inc.php ➔ xtubeNotifyIteminfo() B

↳ Parent: Project

Complexity

Conditions	8
Paths	12

Size

Total Lines	53
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	32
nc	12
nop	2
dl	0
loc	53
rs	7.1199
c	0
b	0
f	0

How to fix Long Method

<?php
/**
 * Module: XoopsTube
 *
 * You may not change or alter any portion of this comment or credits
 * of supporting developers from this source code or any supporting source code
 * which is considered copyrighted (c) material of the original comment or credit authors.
 *
 * PHP version 5
 *
 * @category        Module
 * @package         Xoopstube
 * @author          XOOPS Development Team
 * @copyright       2001-2016 XOOPS Project (http://xoops.org)
 * @license         GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @link            http://xoops.org/
 * @since           1.0.6
 *
 * @param $category
 * @param $item_id
 *
 * @return null
 */


function xtubeNotifyIteminfo($category, $item_id)
// 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);
    }
}
{
    global $xoopsModule;
function myFunction($a, $b) {
    // Do something
}

    $moduleDirName = basename(dirname(__DIR__));
    //    $modulePath = dirname(__DIR__);


    if (empty($xoopsModule) || $xoopsModule->getVar('dirname') !== 'xoopstube') {
        /** @var XoopsModuleHandler $moduleHandler */
        $moduleHandler = xoops_getHandler('module');
        $module        = $moduleHandler->getByDirname($moduleDirName);
        $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;
$myVar = 'Value';
$higher = false;

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

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

    if ('global' === $category) {
        $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;
    }

    if ('category' === $category) {
        // Assume we have a valid category id
        $sql = 'SELECT title FROM ' . $GLOBALS['xoopsDB']->prefix('xoopstube_cat') . ' WHERE cid=' . $item_id;
        if (!$result = $GLOBALS['xoopsDB']->query($sql)) {
            return false;
        }
        $result_array = $GLOBALS['xoopsDB']->fetchArray($result);
        $item['name'] = $result_array['title'];
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
        $item['url']  = XOOPS_URL . '/modules/xoopstube/viewcat.php?cid=' . $item_id;

        return $item;
    }

    if ('video' === $category) {
        // Assume we have a valid file id
        $sql = 'SELECT cid,title FROM ' . $GLOBALS['xoopsDB']->prefix('xoopstube_videos') . ' WHERE lid=' . $item_id;
        if (!$result = $GLOBALS['xoopsDB']->query($sql)) {
            return false;
        }
        $result_array = $GLOBALS['xoopsDB']->fetchArray($result);
        $item['name'] = $result_array['title'];
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
        $item['url']  = XOOPS_URL . '/modules/xoopstube/singlevideo.php?cid=' . $result_array['cid'] . '&amp;lid=' . $item_id;

        return $item;
    }

    return null;
}


1			<?php
2			/**
3			* Module: XoopsTube
4			*
5			* You may not change or alter any portion of this comment or credits
6			* of supporting developers from this source code or any supporting source code
7			* which is considered copyrighted (c) material of the original comment or credit authors.
8			*
9			* PHP version 5
10			*
11			* @category Module
12			* @package Xoopstube
13			* @author XOOPS Development Team
14			* @copyright 2001-2016 XOOPS Project (http://xoops.org)
15			* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
16			* @link http://xoops.org/
17			* @since 1.0.6
18			*
19			* @param $category
20			* @param $item_id
21			*
22			* @return null
23			*/
			0 ignored issues – show Documentation introduced 2016-01-18 10:12 UTC by Report Bug Copy Issue Report Should the return type not be `array<string,string>\|false\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
24
25			function xtubeNotifyIteminfo($category, $item_id)
			0 ignored issues – show Coding Style introduced 2016-06-16 09:33 UTC by Report Bug Copy Issue Report `xtubeNotifyIteminfo` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // 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); } } Loading history...
26			{
27			global $xoopsModule;
			0 ignored issues – show Compatibility Best Practice introduced 2016-06-16 09:33 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...
28
29			$moduleDirName = basename(dirname(__DIR__));
30			// $modulePath = dirname(__DIR__);
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-06-01 04:15 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
31
32			if (empty($xoopsModule) \|\| $xoopsModule->getVar('dirname') !== 'xoopstube') {
33			/** @var XoopsModuleHandler $moduleHandler */
34			$moduleHandler = xoops_getHandler('module');
35			$module = $moduleHandler->getByDirname($moduleDirName);
36			$configHandler = xoops_getHandler('config');
37			$config = $configHandler->getConfigsByCat(0, $module->getVar('mid'));
			0 ignored issues – show Unused Code introduced 2016-06-16 09:33 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...
38			} else {
39			$module = $xoopsModule;
			0 ignored issues – show Unused Code introduced 2016-06-16 09:33 UTC by Report Bug Copy Issue Report `$module` 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...
40			$config = $GLOBALS['xoopsModuleConfig'];
			0 ignored issues – show Unused Code introduced 2016-06-16 09:33 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...
41			}
42
43			if ('global' === $category) {
44			$item['name'] = '';
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-18 10:12 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...
45			$item['url'] = '';
46
47			return $item;
48			}
49
50			if ('category' === $category) {
51			// Assume we have a valid category id
52			$sql = 'SELECT title FROM ' . $GLOBALS['xoopsDB']->prefix('xoopstube_cat') . ' WHERE cid=' . $item_id;
53			if (!$result = $GLOBALS['xoopsDB']->query($sql)) {
54			return false;
55			}
56			$result_array = $GLOBALS['xoopsDB']->fetchArray($result);
57			$item['name'] = $result_array['title'];
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-18 10:12 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...
58			$item['url'] = XOOPS_URL . '/modules/xoopstube/viewcat.php?cid=' . $item_id;
59
60			return $item;
61			}
62
63			if ('video' === $category) {
64			// Assume we have a valid file id
65			$sql = 'SELECT cid,title FROM ' . $GLOBALS['xoopsDB']->prefix('xoopstube_videos') . ' WHERE lid=' . $item_id;
66			if (!$result = $GLOBALS['xoopsDB']->query($sql)) {
67			return false;
68			}
69			$result_array = $GLOBALS['xoopsDB']->fetchArray($result);
70			$item['name'] = $result_array['title'];
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-18 10:12 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...
71			$item['url'] = XOOPS_URL . '/modules/xoopstube/singlevideo.php?cid=' . $result_array['cid'] . '&lid=' . $item_id;
72
73			return $item;
74			}
75
76			return null;
77			}
78

XoopsModules25x / xoopstube

Branch — master (ddc2b8)

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

Duplication Side-by-Side

Filter issues like