action.module.php ➔ xoops_module_uninstall_xoopspartners() - Code Metrics - Inspection of "1.12 (Zyspec)" - XoopsModules25x/xoopspartners - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#3)

by Michael

created 2016-07-11 03:11 UTC

action.module.php ➔ xoops_module_uninstall_xoopspartners() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	4
rs	10

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

/**
 * XOOPS XoopsPartners module
 *
 * @category     Module
 * @package      xoopspartners
 * @subpackage   include
 * @author       Taiwen Jiang <[email protected]>
 * @author       zyspec <[email protected]>
 * @author       XOOPS Module Development Team
 * @copyright    {@link http://xoops.org 2001-2016 XOOPS Project}
 * @license      {@link http://www.gnu.org/licenses/gpl-2.0.html GNU Public License}
 * @link         http://xoops.org XOOPS
 */

/**
 * @internal {Make sure you PROTECT THIS FILE}
 */

if ((!defined('XOOPS_ROOT_PATH'))
    || !($GLOBALS['xoopsUser'] instanceof XoopsUser)
if ($x instanceof DoesNotExist) {
    // Do something.
}
    || !$GLOBALS['xoopsUser']->isAdmin()
) {
    exit('Restricted access' . PHP_EOL);
}

/**
 *
 * Verifies XOOPS version meets minimum requirements for this module
 * @param XoopsModule $module {@link XoopsModule}
 *
 * @return bool true if meets requirements, false if not
 */
function xoopspartnersCheckXoopsVer(XoopsModule $module)
{
    xoops_loadLanguage('admin', $module->dirname());
    //check for minimum XOOPS version
    $currentVer  = substr(XOOPS_VERSION, 6); // get the numeric part of string
    $currArray   = explode('.', $currentVer);
    $requiredVer = '' . $module->getInfo('min_xoops'); //making sure it's a string
    $reqArray    = explode('.', $requiredVer);
    $success     = true;
    foreach ($reqArray as $k => $v) {
        if (isset($currArray[$k])) {
            if ($currArray[$k] > $v) {
                break;
            } elseif ($currArray[$k] == $v) {
                continue;
            } else {
                $success = false;
                break;
            }
        } else {
            if ((int)$v > 0) { // handles things like x.x.x.0_RC2
                $success = false;
                break;
            }
        }
    }

    if (!$success) {
        $module->setErrors(sprintf(_AM_XPARTNERS_ERROR_BAD_XOOPS, $requiredVer, $currentVer));
    }

    return $success;
}

/**
 *
 * Verifies PHP version meets minimum requirements for this module
 * @param XoopsModule $module {@link XoopsModule}
 *
 * @return bool true if meets requirements, false if not
 */
function xoopspartnersCheckPHPVer(XoopsModule $module)
{
    xoops_loadLanguage('admin', $module->dirname());
    // check for minimum PHP version
    $success = true;
    $verNum  = phpversion();
    $reqVer  =& $module->getInfo('min_php');
    if (false !== $reqVer && '' !== $reqVer) {
        if (version_compare($verNum, $reqVer, '<')) {
            $module->setErrors(sprintf(_AM_XPARTNERS_ERROR_BAD_XOOPS, $reqVer, $verNum));
            $success = false;
        }
    }

    return $success;
}

/**
 *
 * 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_xoopspartners(XoopsModule $module)

{
    //check for minimum XOOPS version
    if (!xoopspartnersCheckXoopsVer($module)) {
        return false;
    }

    // check for minimum PHP version
    if (!xoopspartnersCheckPHPVer($module)) {
        return false;
    }
    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_xoopspartners(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);
    }
}
{

    $indexFile = $GLOBALS['xoops']->path('/modules/' . $module->dirname() . '/include/index.html');

    //Create the "uploads" directory for the module
    $module_uploads = $GLOBALS['xoops']->path('/uploads/' . $module->dirname());
    if (!is_dir($module_uploads)) {
        mkdir($module_uploads, 0777);
    }
    chmod($module_uploads, 0777);
    //now copy the index file to help prevent 'browsing' the directory
    copy($indexFile, $GLOBALS['xoops']->path('/uploads/' . $module->dirname() . '/index.html'));

    return true;
}

/**
 *
 * Prepares system prior to attempting to update module
 * @param XoopsModule $module {@link XoopsModule}
 *
 * @return bool true if successfully ready to update module, false if not
 */
function xoops_module_pre_update_xoopspartners(XoopsModule $module)

{
    //check for minimum XOOPS version
    if (!xoopspartnersCheckXoopsVer($module)) {
        return false;
    }

    // check for minimum PHP version
    if (!xoopspartnersCheckPHPVer($module)) {
        return false;
    }
    return true;
}

/**
 *
 * Functions to upgrade from previous version of the module
 *
 * @param XoopsModule $module       {@link XoopsModule}
 * @param int         $curr_version version number of module currently installed

 *
 * @return bool true if successfully updated module, false if not
 */
function xoops_module_update_xoopspartners(XoopsModule $module, $curr_version = null)

{
    return true;
}

/**
 *
 * Function to perform before module uninstall
 * @param XoopsModule $module {@link XoopsModule}
 *
 * @return bool true if successfully executed, false if not
 */
function xoops_module_pre_uninstall_xoopspartners(XoopsModule $module)

{
    return true;
}

/**
 *
 * Function to complete upon module uninstall
 * @param XoopsModule $module {@link XoopsModule}
 *
 * @return bool true if successfully executed uninstall of module, false if not
 */
function xoops_module_uninstall_xoopspartners(XoopsModule $module)

{
    return true;
}


Pull Request — master (#3)

action.module.php ➔ xoops_module_uninstall_xoopspartners() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2016-07-11 03:13 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 44 and the first side effect is on line 34. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
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		* XOOPS XoopsPartners module
14		*
15		* @category Module
16		* @package xoopspartners
17		* @subpackage include
18		* @author Taiwen Jiang <[email protected]>
19		* @author zyspec <[email protected]>
20		* @author XOOPS Module Development Team
21		* @copyright {@link http://xoops.org 2001-2016 XOOPS Project}
22		* @license {@link http://www.gnu.org/licenses/gpl-2.0.html GNU Public License}
23		* @link http://xoops.org XOOPS
24		*/
25
26		/**
27		* @internal {Make sure you PROTECT THIS FILE}
28		*/
29
30		if ((!defined('XOOPS_ROOT_PATH'))
31		\|\| !($GLOBALS['xoopsUser'] instanceof XoopsUser)
		0 ignored issues – show Bug introduced 2016-07-11 03:13 UTC by Report Bug Copy Issue Report The class `XoopsUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
32		\|\| !$GLOBALS['xoopsUser']->isAdmin()
33		) {
34		exit('Restricted access' . PHP_EOL);
35		}
36
37		/**
38		*
39		* Verifies XOOPS version meets minimum requirements for this module
40		* @param XoopsModule $module {@link XoopsModule}
41		*
42		* @return bool true if meets requirements, false if not
43		*/
44		function xoopspartnersCheckXoopsVer(XoopsModule $module)
45		{
46		xoops_loadLanguage('admin', $module->dirname());
47		//check for minimum XOOPS version
48		$currentVer = substr(XOOPS_VERSION, 6); // get the numeric part of string
49		$currArray = explode('.', $currentVer);
50		$requiredVer = '' . $module->getInfo('min_xoops'); //making sure it's a string
51		$reqArray = explode('.', $requiredVer);
52		$success = true;
53		foreach ($reqArray as $k => $v) {
54		if (isset($currArray[$k])) {
55		if ($currArray[$k] > $v) {
56		break;
57		} elseif ($currArray[$k] == $v) {
58		continue;
59		} else {
60		$success = false;
61		break;
62		}
63		} else {
64		if ((int)$v > 0) { // handles things like x.x.x.0_RC2
65		$success = false;
66		break;
67		}
68		}
69		}
70
71		if (!$success) {
72		$module->setErrors(sprintf(_AM_XPARTNERS_ERROR_BAD_XOOPS, $requiredVer, $currentVer));
73		}
74
75		return $success;
76		}
77
78		/**
79		*
80		* Verifies PHP version meets minimum requirements for this module
81		* @param XoopsModule $module {@link XoopsModule}
82		*
83		* @return bool true if meets requirements, false if not
84		*/
85		function xoopspartnersCheckPHPVer(XoopsModule $module)
86		{
87		xoops_loadLanguage('admin', $module->dirname());
88		// check for minimum PHP version
89		$success = true;
90		$verNum = phpversion();
91		$reqVer =& $module->getInfo('min_php');
92		if (false !== $reqVer && '' !== $reqVer) {
93		if (version_compare($verNum, $reqVer, '<')) {
94		$module->setErrors(sprintf(_AM_XPARTNERS_ERROR_BAD_XOOPS, $reqVer, $verNum));
95		$success = false;
96		}
97		}
98
99		return $success;
100		}
101
102		/**
103		*
104		* Prepares system prior to attempting to install module
105		* @param XoopsModule $module {@link XoopsModule}
106		*
107		* @return bool true if ready to install, false if not
108		*/
109	View Code Duplication	function xoops_module_pre_install_xoopspartners(XoopsModule $module)
		0 ignored issues – show Duplication introduced 2016-07-11 03:13 UTC by Report Bug Copy Issue Report This function seems to be duplicated in 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...
110		{
111		//check for minimum XOOPS version
112		if (!xoopspartnersCheckXoopsVer($module)) {
113		return false;
114		}
115
116		// check for minimum PHP version
117		if (!xoopspartnersCheckPHPVer($module)) {
118		return false;
119		}
120		return true;
121		}
122
123		/**
124		*
125		* Performs tasks required during installation of the module
126		* @param XoopsModule $module {@link XoopsModule}
127		*
128		* @return bool true if installation successful, false if not
129		*/
130		function xoops_module_install_xoopspartners(XoopsModule $module)
		0 ignored issues – show Coding Style introduced 2016-07-11 03:13 UTC by Report Bug Copy Issue Report `xoops_module_install_xoopspartners` 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...
131		{
132
133		$indexFile = $GLOBALS['xoops']->path('/modules/' . $module->dirname() . '/include/index.html');
134
135		//Create the "uploads" directory for the module
136		$module_uploads = $GLOBALS['xoops']->path('/uploads/' . $module->dirname());
137		if (!is_dir($module_uploads)) {
138		mkdir($module_uploads, 0777);
139		}
140		chmod($module_uploads, 0777);
141		//now copy the index file to help prevent 'browsing' the directory
142		copy($indexFile, $GLOBALS['xoops']->path('/uploads/' . $module->dirname() . '/index.html'));
143
144		return true;
145		}
146
147		/**
148		*
149		* Prepares system prior to attempting to update module
150		* @param XoopsModule $module {@link XoopsModule}
151		*
152		* @return bool true if successfully ready to update module, false if not
153		*/
154	View Code Duplication	function xoops_module_pre_update_xoopspartners(XoopsModule $module)
		0 ignored issues – show Duplication introduced 2016-07-11 03:13 UTC by Report Bug Copy Issue Report This function seems to be duplicated in 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...
155		{
156		//check for minimum XOOPS version
157		if (!xoopspartnersCheckXoopsVer($module)) {
158		return false;
159		}
160
161		// check for minimum PHP version
162		if (!xoopspartnersCheckPHPVer($module)) {
163		return false;
164		}
165		return true;
166		}
167
168		/**
169		*
170		* Functions to upgrade from previous version of the module
171		*
172		* @param XoopsModule $module {@link XoopsModule}
173		* @param int $curr_version version number of module currently installed
		0 ignored issues – show Documentation introduced 2016-07-11 03:13 UTC by Report Bug Copy Issue Report Should the type for parameter `$curr_version` not be `integer\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
174		*
175		* @return bool true if successfully updated module, false if not
176		*/
177		function xoops_module_update_xoopspartners(XoopsModule $module, $curr_version = null)
		0 ignored issues – show Unused Code introduced 2016-07-11 03:13 UTC by Report Bug Copy Issue Report 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... Unused Code introduced 2016-07-11 03:13 UTC by Report Bug Copy Issue Report The parameter `$curr_version` 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...
178		{
179		return true;
180		}
181
182		/**
183		*
184		* Function to perform before module uninstall
185		* @param XoopsModule $module {@link XoopsModule}
186		*
187		* @return bool true if successfully executed, false if not
188		*/
189		function xoops_module_pre_uninstall_xoopspartners(XoopsModule $module)
		0 ignored issues – show Unused Code introduced 2016-07-11 03:13 UTC by Report Bug Copy Issue Report 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...
190		{
191		return true;
192		}
193
194		/**
195		*
196		* Function to complete upon module uninstall
197		* @param XoopsModule $module {@link XoopsModule}
198		*
199		* @return bool true if successfully executed uninstall of module, false if not
200		*/
201		function xoops_module_uninstall_xoopspartners(XoopsModule $module)
		0 ignored issues – show Unused Code introduced 2016-07-11 03:13 UTC by Report Bug Copy Issue Report 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...
202		{
203		return true;
204		}
205

XoopsModules25x / xoopspartners

Pull Request — master (#3)

action.module.php ➔ xoops_module_uninstall_xoopspartners() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like