NewbbUtility - Code Metrics - Inspection of "PhpDocs" - mambax7/newbb5 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2b5506...d00cae )

by Michael

created 2017-09-18 04:06 UTC

NewbbUtility A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

Metric	Value
dl	0
loc	117
rs	10
c	0
b	0
f	0
wmc	12
lcom	0
cbo	1

6 Methods

Rating	Name	Size	Complexity
A	tableExists()	8	1
A	fieldExists()	7	1
A	addField()	7	1
A	prepareFolder()	12	4
A	cleanCache()	16	2
A	userIsAdmin()	18	3

<?php

/**
 * Class NewbbUtility
 */
class NewbbUtility
namespace YourVendor;

class YourClass { }
{
    /**
     * Verify that a mysql table exists
     *
     * @package       News
     * @author        Hervé Thouzard (http://www.herve-thouzard.com)
     * @copyright (c) Hervé Thouzard
     * @param $tablename
     * @return bool
     */
    public function tableExists($tablename)
    {
        global $xoopsDB;
function myFunction($a, $b) {
    // Do something
}
        /** @var \XoopsMySQLDatabase $xoopsDB */
        $result = $xoopsDB->queryF("SHOW TABLES LIKE '$tablename'");

        return ($xoopsDB->getRowsNum($result) > 0);
    }

    /**
     * Verify that a field exists inside a mysql table
     *
     * @package       News
     * @author        Hervé Thouzard (http://www.herve-thouzard.com)
     * @copyright (c) Hervé Thouzard
     * @param $fieldname
     * @param $table
     * @return bool
     */
    public function fieldExists($fieldname, $table)
    {
        global $xoopsDB;
function myFunction($a, $b) {
    // Do something
}
        $result = $xoopsDB->queryF("SHOW COLUMNS FROM   $table LIKE '$fieldname'");

        return ($xoopsDB->getRowsNum($result) > 0);
    }

    /**
     * Add a field to a mysql table
     *
     * @package       News
     * @author        Hervé Thouzard (http://www.herve-thouzard.com)
     * @copyright (c) Hervé Thouzard
     * @param $field
     * @param $table
     * @return bool|\mysqli_result
     */
    public function addField($field, $table)
    {
        global $xoopsDB;
function myFunction($a, $b) {
    // Do something
}
        $result = $xoopsDB->queryF('ALTER TABLE ' . $table . " ADD $field;");

        return $result;
    }

    /**
     * Function responsible for checking if a directory exists, we can also write in and create an index.html file
     *
     * @param string $folder Le chemin complet du répertoire à vérifier
     *
     * @return void
     */
    public static function prepareFolder($folder)
    {
        try {
            if (!@mkdir($folder) && !is_dir($folder)) {
                throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder));
            } else {
                file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
            }
        } catch (Exception $e) {
            echo 'Caught exception: ', $e->getMessage(), "\n", '<br>';
        }
    }
        
    public static function cleanCache()
    {
          $cacheHelper = new \Xmf\Module\Helper\Cache('newbb');
            if (method_exists($cacheHelper,'clear')) {
                $cacheHelper->clear();
            return;
          }
    // for 2.5 systems, clear everything
          require_once XOOPS_ROOT_PATH . '/modules/system/class/maintenance.php';
          $maintenance = new SystemMaintenance();
            $cacheList = [
            3, // xoops_cache
            ];
        $maintenance->CleanCache($cacheList);
        xoops_setActiveModules();
    }

    /**
     * Checks if a user is admin of NewBB
     *
     * @return boolean
     */
    public static function userIsAdmin()
// 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);
    }
}
    {
        $helper = Newbb::getInstance();

        static $newbbIsAdmin;

        if (isset($newbbIsAdmin)) {
            return $newbbIsAdmin;
        }

        if (!$GLOBALS['xoopsUser']) {
            $newbbIsAdmin = false;
        } else {
            $newbbIsAdmin = $GLOBALS['xoopsUser']->isAdmin($helper->getModule()->getVar('mid'));
        }

        return $newbbIsAdmin;
    }
}


1			<?php
2
3			/**
4			* Class NewbbUtility
5			*/
6			class NewbbUtility
			0 ignored issues – show Coding Style Compatibility introduced 2017-06-25 02:50 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
7			{
8			/**
9			* Verify that a mysql table exists
10			*
11			* @package News
12			* @author Hervé Thouzard (http://www.herve-thouzard.com)
13			* @copyright (c) Hervé Thouzard
14			* @param $tablename
15			* @return bool
16			*/
17			public function tableExists($tablename)
18			{
19			global $xoopsDB;
			0 ignored issues – show Compatibility Best Practice introduced 2017-06-25 02:50 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...
20			/** @var \XoopsMySQLDatabase $xoopsDB */
21			$result = $xoopsDB->queryF("SHOW TABLES LIKE '$tablename'");
22
23			return ($xoopsDB->getRowsNum($result) > 0);
24			}
25
26			/**
27			* Verify that a field exists inside a mysql table
28			*
29			* @package News
30			* @author Hervé Thouzard (http://www.herve-thouzard.com)
31			* @copyright (c) Hervé Thouzard
32			* @param $fieldname
33			* @param $table
34			* @return bool
35			*/
36			public function fieldExists($fieldname, $table)
37			{
38			global $xoopsDB;
			0 ignored issues – show Compatibility Best Practice introduced 2017-06-25 02:50 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...
39			$result = $xoopsDB->queryF("SHOW COLUMNS FROM $table LIKE '$fieldname'");
40
41			return ($xoopsDB->getRowsNum($result) > 0);
42			}
43
44			/**
45			* Add a field to a mysql table
46			*
47			* @package News
48			* @author Hervé Thouzard (http://www.herve-thouzard.com)
49			* @copyright (c) Hervé Thouzard
50			* @param $field
51			* @param $table
52			* @return bool\|\mysqli_result
53			*/
54			public function addField($field, $table)
55			{
56			global $xoopsDB;
			0 ignored issues – show Compatibility Best Practice introduced 2017-06-25 02:50 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...
57			$result = $xoopsDB->queryF('ALTER TABLE ' . $table . " ADD $field;");
58
59			return $result;
60			}
61
62			/**
63			* Function responsible for checking if a directory exists, we can also write in and create an index.html file
64			*
65			* @param string $folder Le chemin complet du répertoire à vérifier
66			*
67			* @return void
68			*/
69			public static function prepareFolder($folder)
70			{
71			try {
72			if (!@mkdir($folder) && !is_dir($folder)) {
73			throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder));
74			} else {
75			file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>');
76			}
77			} catch (Exception $e) {
78			echo 'Caught exception: ', $e->getMessage(), "\n", '<br>';
79			}
80			}
81
82			public static function cleanCache()
83			{
84			$cacheHelper = new \Xmf\Module\Helper\Cache('newbb');
85			if (method_exists($cacheHelper,'clear')) {
86			$cacheHelper->clear();
87			return;
88			}
89			// for 2.5 systems, clear everything
90			require_once XOOPS_ROOT_PATH . '/modules/system/class/maintenance.php';
91			$maintenance = new SystemMaintenance();
92			$cacheList = [
93			3, // xoops_cache
94			];
95			$maintenance->CleanCache($cacheList);
96			xoops_setActiveModules();
97			}
98
99			/**
100			* Checks if a user is admin of NewBB
101			*
102			* @return boolean
103			*/
104			public static function userIsAdmin()
			0 ignored issues – show Coding Style introduced 2017-09-16 15:50 UTC by Report Bug Copy Issue Report `userIsAdmin` 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...
105			{
106			$helper = Newbb::getInstance();
107
108			static $newbbIsAdmin;
109
110			if (isset($newbbIsAdmin)) {
111			return $newbbIsAdmin;
112			}
113
114			if (!$GLOBALS['xoopsUser']) {
115			$newbbIsAdmin = false;
116			} else {
117			$newbbIsAdmin = $GLOBALS['xoopsUser']->isAdmin($helper->getModule()->getVar('mid'));
118			}
119
120			return $newbbIsAdmin;
121			}
122			}
123

mambax7 / newbb5

Push — master ( 2b5506...d00cae )

NewbbUtility A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like