oninstall.php ➔ xoops_module_install_randomquote() - Code Metrics - Inspection of "namespaces, category" - mambax7/randomquote - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 171474...8d265e )

by Michael

created 2018-01-01 13:50 UTC

oninstall.php ➔ xoops_module_install_randomquote() B

↳ Parent: Project

Complexity

Conditions	7
Paths	8

Size

Total Lines	61
Code Lines	32

Duplication

Lines	21
Ratio	34.43 %

Importance

Changes

Metric	Value
cc	7
eloc	32
nc	8
nop	1
dl	21
loc	61
rs	7.399
c	0
b	0
f	0

How to fix Long Method

<?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.
*/

/**
 * Module: randomquote
 *
 * @category        Module
 * @package         randomquote
 * @author          XOOPS Development Team <[email protected]> - <https://xoops.org>
 * @copyright       {@link https://xoops.org/ XOOPS Project}
 * @license         GPL 2.0 or later
 * @link            https://xoops.org/
 * @since           1.0.0
 */

use Xoopsmodules\randomquote;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Xoopsmodules\randomquote\common;

/**
 * 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_randomquote(\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);
    }
}
{
    include __DIR__ . '/../preloads/autoloader.php';
    /** @var randomquote\Utility $utility */
    $utility = new randomquote\Utility();

    //check for minimum XOOPS version
    $xoopsSuccess = $utility::checkVerXoops($module);

    // check for minimum PHP version
    $phpSuccess = $utility::checkVerPhp($module);

    if (false !== $xoopsSuccess && false !== $phpSuccess) {
        $moduleTables =& $module->getInfo('tables');
        foreach ($moduleTables as $table) {
            $GLOBALS['xoopsDB']->queryF('DROP TABLE IF EXISTS ' . $GLOBALS['xoopsDB']->prefix($table) . ';');
        }
    }
    return $xoopsSuccess && $phpSuccess;
}

/**
 *
 * 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_randomquote(\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);
    }
}
{
    include __DIR__ . '/../preloads/autoloader.php';

    $moduleDirName = basename(dirname(__DIR__));

    /** @var randomquote\Helper $helper */
    /** @var randomquote\Utility $utility */
    /** @var common\Configurator $configurator */
    $helper       = randomquote\Helper::getInstance();
    $utility      = new randomquote\Utility();
    $configurator = new common\Configurator();

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

    // default Permission Settings ----------------------
    $moduleId  = $module->getVar('mid');
    $moduleId2 = $helper->getModule()->mid();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
    //$moduleName = $module->getVar('name');

    $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) {
            $utility::createFolder($configurator->uploadFolders[$i]);
        }
    }
    //  ---  COPY blank.png FILES ---------------
    if (count($configurator->copyBlankFiles) > 0) {

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

    //  ---  COPY test folder files ---------------
    if (count($configurator->copyTestFolders) > 0) {

        //        $file = __DIR__ . '/../testdata/images/';

        foreach (array_keys($configurator->copyTestFolders) as $i) {
            $src  = $configurator->copyTestFolders[$i][0];
            $dest = $configurator->copyTestFolders[$i][1];
            $utility::xcopy($src, $dest);
        }
    }

    //delete .html entries from the tpl table
    $sql = 'DELETE FROM ' . $GLOBALS['xoopsDB']->prefix('tplfile') . " WHERE `tpl_module` = '" . $module->getVar('dirname', 'n') . "' AND `tpl_file` LIKE '%.html%'";
    $GLOBALS['xoopsDB']->queryF($sql);

    return true;
}


1		<?php
2
3		/*
4		You may not change or alter any portion of this comment or credits
5		of supporting developers from this source code or any supporting source code
6		which is considered copyrighted (c) material of the original comment or credit authors.
7
8		This program is distributed in the hope that it will be useful,
9		but WITHOUT ANY WARRANTY; without even the implied warranty of
10		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11		*/
12
13		/**
14		* Module: randomquote
15		*
16		* @category Module
17		* @package randomquote
18		* @author XOOPS Development Team <[email protected]> - <https://xoops.org>
19		* @copyright {@link https://xoops.org/ XOOPS Project}
20		* @license GPL 2.0 or later
21		* @link https://xoops.org/
22		* @since 1.0.0
23		*/
24
25		use Xoopsmodules\randomquote;
		0 ignored issues – show Bug introduced 2018-01-01 13:52 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `randomquote`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
26		use Xoopsmodules\randomquote\common;
27
28		/**
29		* Prepares system prior to attempting to install module
30		* @param \XoopsModule $module {@link XoopsModule}
31		*
32		* @return bool true if ready to install, false if not
33		*/
34		function xoops_module_pre_install_randomquote(\XoopsModule $module)
		0 ignored issues – show Coding Style introduced 2018-01-01 13:52 UTC by Report Bug Copy Issue Report `xoops_module_pre_install_randomquote` 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...
35		{
36		include __DIR__ . '/../preloads/autoloader.php';
37		/** @var randomquote\Utility $utility */
38		$utility = new randomquote\Utility();
39
40		//check for minimum XOOPS version
41		$xoopsSuccess = $utility::checkVerXoops($module);
42
43		// check for minimum PHP version
44		$phpSuccess = $utility::checkVerPhp($module);
45
46		if (false !== $xoopsSuccess && false !== $phpSuccess) {
47		$moduleTables =& $module->getInfo('tables');
48		foreach ($moduleTables as $table) {
49		$GLOBALS['xoopsDB']->queryF('DROP TABLE IF EXISTS ' . $GLOBALS['xoopsDB']->prefix($table) . ';');
50		}
51		}
52		return $xoopsSuccess && $phpSuccess;
53		}
54
55		/**
56		*
57		* Performs tasks required during installation of the module
58		* @param XoopsModule $module {@link XoopsModule}
59		*
60		* @return bool true if installation successful, false if not
61		*/
62		function xoops_module_install_randomquote(\XoopsModule $module)
		0 ignored issues – show Coding Style introduced 2018-01-01 13:52 UTC by Report Bug Copy Issue Report `xoops_module_install_randomquote` 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...
63		{
64		include __DIR__ . '/../preloads/autoloader.php';
65
66		$moduleDirName = basename(dirname(__DIR__));
67
68		/** @var randomquote\Helper $helper */
69		/** @var randomquote\Utility $utility */
70		/** @var common\Configurator $configurator */
71		$helper = randomquote\Helper::getInstance();
72		$utility = new randomquote\Utility();
73		$configurator = new common\Configurator();
74
75		// Load language files
76		$helper->loadLanguage('admin');
77		$helper->loadLanguage('modinfo');
78
79		// default Permission Settings ----------------------
80		$moduleId = $module->getVar('mid');
81		$moduleId2 = $helper->getModule()->mid();
		0 ignored issues – show Unused Code introduced 2018-01-01 13:52 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...
82		//$moduleName = $module->getVar('name');
		0 ignored issues – show Unused Code Comprehensibility introduced 2018-01-01 13:52 UTC by Report Bug Copy Issue Report `64%` 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...
83		$gpermHandler = xoops_getHandler('groupperm');
84		// access rights ------------------------------------------
85		$gpermHandler->addRight($moduleDirName . '_approve', 1, XOOPS_GROUP_ADMIN, $moduleId);
86		$gpermHandler->addRight($moduleDirName . '_submit', 1, XOOPS_GROUP_ADMIN, $moduleId);
87		$gpermHandler->addRight($moduleDirName . '_view', 1, XOOPS_GROUP_ADMIN, $moduleId);
88		$gpermHandler->addRight($moduleDirName . '_view', 1, XOOPS_GROUP_USERS, $moduleId);
89		$gpermHandler->addRight($moduleDirName . '_view', 1, XOOPS_GROUP_ANONYMOUS, $moduleId);
90
91		// --- CREATE FOLDERS ---------------
92	View Code Duplication	if (count($configurator->uploadFolders) > 0) {
		0 ignored issues – show Duplication introduced 2018-01-01 13:52 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...
93		// foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2018-01-01 13:52 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...
94		foreach (array_keys($configurator->uploadFolders) as $i) {
95		$utility::createFolder($configurator->uploadFolders[$i]);
96		}
97		}
98		// --- COPY blank.png FILES ---------------
99	View Code Duplication	if (count($configurator->copyBlankFiles) > 0) {
		0 ignored issues – show Duplication introduced 2018-01-01 13:52 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...
100		$file = __DIR__ . '/../assets/images/blank.png';
101		foreach (array_keys($configurator->copyBlankFiles) as $i) {
102		$dest = $configurator->copyBlankFiles[$i] . '/blank.png';
103		$utility::copyFile($file, $dest);
104		}
105		}
106
107		// --- COPY test folder files ---------------
108	View Code Duplication	if (count($configurator->copyTestFolders) > 0) {
		0 ignored issues – show Duplication introduced 2018-01-01 13:52 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...
109		// $file = __DIR__ . '/../testdata/images/';
		0 ignored issues – show Unused Code Comprehensibility introduced 2018-01-01 13:52 UTC by Report Bug Copy Issue Report `37%` 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...
110		foreach (array_keys($configurator->copyTestFolders) as $i) {
111		$src = $configurator->copyTestFolders[$i][0];
112		$dest = $configurator->copyTestFolders[$i][1];
113		$utility::xcopy($src, $dest);
114		}
115		}
116
117		//delete .html entries from the tpl table
118		$sql = 'DELETE FROM ' . $GLOBALS['xoopsDB']->prefix('tplfile') . " WHERE `tpl_module` = '" . $module->getVar('dirname', 'n') . "' AND `tpl_file` LIKE '%.html%'";
119		$GLOBALS['xoopsDB']->queryF($sql);
120
121		return true;
122		}
123

mambax7 / randomquote

Push — master ( 171474...8d265e )

oninstall.php ➔ xoops_module_install_randomquote() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like