Completed
Push — master ( 171474...8d265e )
by Michael
01:31
created

onuninstall.php ➔ xoops_module_pre_uninstall_randomquote()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 2
nc 1
nop 1
dl 0
loc 5
rs 9.4285
c 0
b 0
f 0
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 by
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
27
/**
28
 * Prepares system prior to attempting to uninstall module
29
 * @param \XoopsModule $module {@link XoopsModule}
30
 *
31
 * @return bool true if ready to uninstall, false if not
32
 */
33
function xoops_module_pre_uninstall_randomquote(\XoopsModule $module)
0 ignored issues
show
Unused Code introduced by
The parameter $module is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
34
{
35
    // Do some synchronization if needed
36
    return true;
37
}
38
39
/**
40
 *
41
 * Performs tasks required during uninstallation of the module
42
 * @param XoopsModule $module {@link XoopsModule}
43
 *
44
 * @return bool true if uninstallation successful, false if not
45
 */
46
function xoops_module_uninstall_randomquote(\XoopsModule $module)
47
{
48
    include __DIR__ . '/../preloads/autoloader.php';
49
    $moduleDirName      = basename(dirname(__DIR__));
50
    $moduleDirNameUpper = strtoupper($moduleDirName); //$capsDirName
0 ignored issues
show
Unused Code introduced by
$moduleDirNameUpper 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...
51
52
    /** @var randomquote\Helper $helper */
53
    /** @var randomquote\Utility $utility */
54
    $helper  = randomquote\Helper::getInstance();
55
    $utility = new randomquote\Utility();
0 ignored issues
show
Unused Code introduced by
$utility 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...
56
    //    $configurator = new randomquote\common\Configurator();
0 ignored issues
show
Unused Code Comprehensibility introduced by
46% 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...
57
58
    // Load language files
59
    $helper->loadLanguage('admin');
60
    $helper->loadLanguage('common');
61
    $success = true;
62
63
    //------------------------------------------------------------------
64
    // Remove uploads folder (and all subfolders) if they exist
65
    //------------------------------------------------------------------
66
    /*
0 ignored issues
show
Unused Code Comprehensibility introduced by
54% 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...
67
        $old_directories = [$GLOBALS['xoops']->path("uploads/{$moduleDirName}")];
68
        foreach ($old_directories as $old_dir) {
69
            $dirInfo = new SplFileInfo($old_dir);
70
            if ($dirInfo->isDir()) {
71
                // The directory exists so delete it
72
                if (false === $utility::rrmdir($old_dir)) {
73
                    $module->setErrors(sprintf(constant('CO_' . $moduleDirNameUpper . '_ERROR_BAD_DEL_PATH'), $old_dir));
74
                    $success = false;
75
                }
76
            }
77
            unset($dirInfo);
78
        }
79
        */
80
81
    /*
0 ignored issues
show
Unused Code Comprehensibility introduced by
43% 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...
82
    //------------ START ----------------
83
    //------------------------------------------------------------------
84
    // Remove xsitemap.xml from XOOPS root folder if it exists
85
    //------------------------------------------------------------------
86
    $xmlfile = $GLOBALS['xoops']->path('xsitemap.xml');
87
    if (is_file($xmlfile)) {
88
        if (false === ($delOk = unlink($xmlfile))) {
89
            $module->setErrors(sprintf(constant('CO_' . $moduleDirNameUpper . '_ERROR_BAD_REMOVE'), $xmlfile));
90
        }
91
    }
92
//    return $success && $delOk; // use this if you're using this routine
93
*/
94
95
    return $success;
96
    //------------ END  ----------------
97
}
98