oninstall.php ➔ xoops_module_pre_install_xfguestbook() - Code Metrics - Inspection of "3.10. FINAL" - XoopsModules25x/xfguestbook - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#10)

by Michael

created 2017-01-24 06:56 UTC

oninstall.php ➔ xoops_module_pre_install_xfguestbook() B

↳ Parent: Project

Complexity

Conditions	5
Paths	8

Size

Total Lines	24
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	13
nc	8
nop	1
dl	0
loc	24
rs	8.5125
c	0
b	0
f	0

<?php
/*
 * 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

/**
 * @copyright    XOOPS Project http://xoops.org/
 * @license      GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @package
 * @since
 * @author       XOOPS Development Team
 */

/**
 *
 * Prepares system prior to attempting to install module
 * @param XoopsModule $module {@link XoopsModule}
 *
 * @return bool true if ready to install, false if not
 */
function xoops_module_pre_install_xfguestbook(XoopsModule $module)
// 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);
    }
}
{
    $moduleDirName = basename(dirname(__DIR__));
    $classUtil     = ucfirst($moduleDirName) . 'Util';
    if (!class_exists($classUtil)) {
        xoops_load('util', $moduleDirName);
    }
    //check for minimum XOOPS version
    if (!$classUtil::checkVerXoops($module)) {
        return false;
    }

    // check for minimum PHP version
    if (!$classUtil::checkVerPhp($module)) {
        return false;
    }

    $mod_tables =& $module->getInfo('tables');
    foreach ($mod_tables as $table) {
        $GLOBALS['xoopsDB']->queryF('DROP TABLE IF EXISTS ' . $GLOBALS['xoopsDB']->prefix($table) . ';');
    }

    return true;
}

/**
 *
 * Performs tasks required during installation of the module
 * @param XoopsModule $module {@link XoopsModule}
 *
 * @return bool true if installation successful, false if not
 */
function xoops_module_install_xfguestbook(XoopsModule $module)
{
    include_once dirname(dirname(dirname(__DIR__))) . '/mainfile.php';
    include_once dirname(__DIR__) . '/include/config.php';

    if (!isset($moduleDirName)) {

        $moduleDirName = basename(dirname(__DIR__));
    }

    if (false !== ($moduleHelper = Xmf\Module\Helper::getHelper($moduleDirName))) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
    } else {
        $moduleHelper = Xmf\Module\Helper::getHelper('system');
    }

    // Load language files
    $moduleHelper->loadLanguage('admin');
    $moduleHelper->loadLanguage('modinfo');

    $configurator = new ModuleConfigurator();
    $classUtil    = ucfirst($moduleDirName) . 'Util';
    if (!class_exists($classUtil)) {
        xoops_load('util', $moduleDirName);
    }

    // default Permission Settings ----------------------
    global $xoopsModule;
function myFunction($a, $b) {
    // Do something
}
    $moduleId     = $xoopsModule->getVar('mid');
    $moduleId2    = $moduleHelper->getModule()->mid();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
    $gpermHandler = xoops_getHandler('groupperm');
    // access rights ------------------------------------------
    $gpermHandler->addRight($moduleDirName . '_approve', 1, XOOPS_GROUP_ADMIN, $moduleId);
    $gpermHandler->addRight($moduleDirName . '_submit', 1, XOOPS_GROUP_ADMIN, $moduleId);
    $gpermHandler->addRight($moduleDirName . '_view', 1, XOOPS_GROUP_ADMIN, $moduleId);
    $gpermHandler->addRight($moduleDirName . '_view', 1, XOOPS_GROUP_USERS, $moduleId);
    $gpermHandler->addRight($moduleDirName . '_view', 1, XOOPS_GROUP_ANONYMOUS, $moduleId);

    //  ---  CREATE FOLDERS ---------------
    if (count($configurator->uploadFolders) > 0) {

        //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {

        foreach (array_keys($configurator->uploadFolders) as $i) {
            $classUtil::createFolder($configurator->uploadFolders[$i]);
        }
    }

    //  ---  COPY blank.png FILES ---------------
    if (count($configurator->blankFiles) > 0) {

        $file = __DIR__ . '/../assets/images/blank.png';
        foreach (array_keys($configurator->blankFiles) as $i) {
            $dest = $configurator->blankFiles[$i] . '/blank.png';
            $classUtil::copyFile($file, $dest);
        }
    }

    return true;
}


1		<?php
2		/*
3		* You may not change or alter any portion of this comment or credits
4		* of supporting developers from this source code or any supporting source code
5		* which is considered copyrighted (c) material of the original comment or credit authors.
6		*
7		* This program is distributed in the hope that it will be useful,
8		* but WITHOUT ANY WARRANTY; without even the implied warranty of
9		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10		*/
11
12		/**
13		* @copyright XOOPS Project http://xoops.org/
14		* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
15		* @package
16		* @since
17		* @author XOOPS Development Team
18		*/
19
20		/**
21		*
22		* Prepares system prior to attempting to install module
23		* @param XoopsModule $module {@link XoopsModule}
24		*
25		* @return bool true if ready to install, false if not
26		*/
27		function xoops_module_pre_install_xfguestbook(XoopsModule $module)
		0 ignored issues – show Coding Style introduced 2017-01-24 06:58 UTC by Report Bug Copy Issue Report `xoops_module_pre_install_xfguestbook` 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...
28		{
29		$moduleDirName = basename(dirname(__DIR__));
30		$classUtil = ucfirst($moduleDirName) . 'Util';
31		if (!class_exists($classUtil)) {
32		xoops_load('util', $moduleDirName);
33		}
34		//check for minimum XOOPS version
35		if (!$classUtil::checkVerXoops($module)) {
36		return false;
37		}
38
39		// check for minimum PHP version
40		if (!$classUtil::checkVerPhp($module)) {
41		return false;
42		}
43
44		$mod_tables =& $module->getInfo('tables');
45		foreach ($mod_tables as $table) {
46		$GLOBALS['xoopsDB']->queryF('DROP TABLE IF EXISTS ' . $GLOBALS['xoopsDB']->prefix($table) . ';');
47		}
48
49		return true;
50		}
51
52		/**
53		*
54		* Performs tasks required during installation of the module
55		* @param XoopsModule $module {@link XoopsModule}
56		*
57		* @return bool true if installation successful, false if not
58		*/
59		function xoops_module_install_xfguestbook(XoopsModule $module)
60		{
61		include_once dirname(dirname(dirname(__DIR__))) . '/mainfile.php';
62		include_once dirname(__DIR__) . '/include/config.php';
63
64		if (!isset($moduleDirName)) {
		0 ignored issues – show Bug introduced 2017-01-24 06:58 UTC by Report Bug Copy Issue Report The variable `$moduleDirName` seems only to be defined at a later point. As such the call to `isset()` seems to always evaluate to `false`. This check marks calls to `isset(...)` or `empty(...)` that are found before the variable itself is defined. These will always have the same result. This is likely the result of code being shifted around. Consider removing these calls. Loading history...
65		$moduleDirName = basename(dirname(__DIR__));
66		}
67
68		if (false !== ($moduleHelper = Xmf\Module\Helper::getHelper($moduleDirName))) {
		0 ignored issues – show Unused Code introduced 2017-01-24 06:58 UTC by Report Bug Copy Issue Report This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
69		} else {
70		$moduleHelper = Xmf\Module\Helper::getHelper('system');
71		}
72
73		// Load language files
74		$moduleHelper->loadLanguage('admin');
75		$moduleHelper->loadLanguage('modinfo');
76
77		$configurator = new ModuleConfigurator();
78		$classUtil = ucfirst($moduleDirName) . 'Util';
79		if (!class_exists($classUtil)) {
80		xoops_load('util', $moduleDirName);
81		}
82
83		// default Permission Settings ----------------------
84		global $xoopsModule;
		0 ignored issues – show Compatibility Best Practice introduced 2017-01-24 06:58 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...
85		$moduleId = $xoopsModule->getVar('mid');
86		$moduleId2 = $moduleHelper->getModule()->mid();
		0 ignored issues – show Unused Code introduced 2017-01-24 06:58 UTC by Report Bug Copy Issue Report `$moduleId2` 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...
87		$gpermHandler = xoops_getHandler('groupperm');
88		// access rights ------------------------------------------
89		$gpermHandler->addRight($moduleDirName . '_approve', 1, XOOPS_GROUP_ADMIN, $moduleId);
90		$gpermHandler->addRight($moduleDirName . '_submit', 1, XOOPS_GROUP_ADMIN, $moduleId);
91		$gpermHandler->addRight($moduleDirName . '_view', 1, XOOPS_GROUP_ADMIN, $moduleId);
92		$gpermHandler->addRight($moduleDirName . '_view', 1, XOOPS_GROUP_USERS, $moduleId);
93		$gpermHandler->addRight($moduleDirName . '_view', 1, XOOPS_GROUP_ANONYMOUS, $moduleId);
94
95		// --- CREATE FOLDERS ---------------
96	View Code Duplication	if (count($configurator->uploadFolders) > 0) {
		0 ignored issues – show Duplication introduced 2017-01-24 06:58 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...
97		// foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-24 06:58 UTC by Report Bug Copy Issue Report `67%` 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...
98		foreach (array_keys($configurator->uploadFolders) as $i) {
99		$classUtil::createFolder($configurator->uploadFolders[$i]);
100		}
101		}
102
103		// --- COPY blank.png FILES ---------------
104	View Code Duplication	if (count($configurator->blankFiles) > 0) {
		0 ignored issues – show Duplication introduced 2017-01-24 06:58 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...
105		$file = __DIR__ . '/../assets/images/blank.png';
106		foreach (array_keys($configurator->blankFiles) as $i) {
107		$dest = $configurator->blankFiles[$i] . '/blank.png';
108		$classUtil::copyFile($file, $dest);
109		}
110		}
111
112		return true;
113		}
114

XoopsModules25x / xfguestbook

Pull Request — master (#10)

oninstall.php ➔ xoops_module_pre_install_xfguestbook() B

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like