AbstractHelper - Code Metrics - Inspection of "Move to more sensible project structure - step 1" - XOOPS/XoopsCore - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#563)

by Richard

created 2018-02-13 18:45 UTC

AbstractHelper A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

73.91%

Importance

Changes

Metric	Value
dl	0
loc	85
rs	10
c	0
b	0
f	0
ccs	17
cts	23
cp	0.7391
wmc	10
lcom	1
cbo	2

4 Methods

Rating	Name	Size	Complexity
	init()	1	?
A	setDebug()	4	1
A	addLog()	6	2
C	__construct()	29	7

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

namespace Xmf\Module\Helper;

/**
 * Xmf\Module\Helper\AbstractHelper defines the basis for various
 * helpers that simplify routine module tasks.
 *
 * @category  Xmf\Module\Helper\AbstractHelper
 * @package   Xmf
 * @author    trabis <[email protected]>
 * @author    Richard Griffith <[email protected]>
 * @copyright 2011-2016 XOOPS Project (http://xoops.org)
 * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @link      http://xoops.org
 */
abstract class AbstractHelper
{
    /**
     * @var XoopsModule
     */
    protected $module;

    /**
     * @var bool true if debug is enabled
     */
    protected $debug;

    /**
     * Instantiate a XoopsModule object for the helper to use.
     * The module is determined as follows:
     * - if null is passed, use the current module
     * - if a string is passed, use as dirname to load
     *
     * @param string|null $dirname dirname
     */
    public function __construct($dirname = null)
// 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);
    }
}
    {
        $this->module = null;
        if (class_exists('Xoops', false)) {
            $xoops = \Xoops::getInstance();
        }
        if (empty($dirname)) {
            // nothing specified, use current module
            // check if we are running in 2.6
            if (isset($xoops)) {
                if ($xoops->isModule()) {
                    $this->module = $xoops->module;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
                }
            } else {
                $this->module = $GLOBALS['xoopsModule'];
            }
        } else {
            // assume dirname specified, try to get a module object
            if (isset($xoops)) {
                $moduleHandler = $xoops->getHandlerModule();
            } else {
                $moduleHandler = xoops_getHandler('module');

            }
            $this->module = $moduleHandler->getByDirname($dirname);
        }
        if (is_object($this->module)) {
            $this->init();
        }
    }

    /**
     * init() is called once/if __construct has a module object.
     * $this->module will have a module object that any further
     * initialization can use.
     *
     * @return void
     */
    abstract public function init();

    /**
     * Set debug option on or off
     *
     * @param bool $bool true to turn on debug logging, false for off
     *
     * @return void
     */
    public function setDebug($bool = true)
    {
        $this->debug = (bool) $bool;
    }

    /**
     * Add a message to the module log
     *
     * @param string $log log message
     *
     * @return void
     */
    public function addLog($log)
    {
        if ($this->debug) {
            \Xoops::getInstance()->logger()->debug($log, array('channel'=>'Extra'));
        }
    }
}


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		namespace Xmf\Module\Helper;
13
14		/**
15		* Xmf\Module\Helper\AbstractHelper defines the basis for various
16		* helpers that simplify routine module tasks.
17		*
18		* @category Xmf\Module\Helper\AbstractHelper
19		* @package Xmf
20		* @author trabis <[email protected]>
21		* @author Richard Griffith <[email protected]>
22		* @copyright 2011-2016 XOOPS Project (http://xoops.org)
23		* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
24		* @link http://xoops.org
25		*/
26		abstract class AbstractHelper
27		{
28		/**
29		* @var XoopsModule
30		*/
31		protected $module;
32
33		/**
34		* @var bool true if debug is enabled
35		*/
36		protected $debug;
37
38		/**
39		* Instantiate a XoopsModule object for the helper to use.
40		* The module is determined as follows:
41		* - if null is passed, use the current module
42		* - if a string is passed, use as dirname to load
43		*
44		* @param string\|null $dirname dirname
45		*/
46	2	public function __construct($dirname = null)
		0 ignored issues – show Coding Style introduced 2017-08-29 03:22 UTC by Report Bug Copy Issue Report `__construct` 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...
47		{
48	2	$this->module = null;
49	2	if (class_exists('Xoops', false)) {
50	2	$xoops = \Xoops::getInstance();
51		}
52	2	if (empty($dirname)) {
53		// nothing specified, use current module
54		// check if we are running in 2.6
55	2	if (isset($xoops)) {
56	2	if ($xoops->isModule()) {
57	2	$this->module = $xoops->module;
		0 ignored issues – show Documentation Bug introduced 2015-12-12 03:50 UTC by Report Bug Copy Issue Report It seems like `$xoops->module` can also be of type `object<Xoops\Core\Kernel\Handlers\XoopsModule>`. However, the property `$module` is declared as type `object<Xmf\Module\Helper\XoopsModule>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
58		}
59		} else {
60	2	$this->module = $GLOBALS['xoopsModule'];
61		}
62		} else {
63		// assume dirname specified, try to get a module object
64		if (isset($xoops)) {
65		$moduleHandler = $xoops->getHandlerModule();
66		} else {
67		$moduleHandler = xoops_getHandler('module');
		0 ignored issues – show Deprecated Code introduced 2016-03-22 02:49 UTC by Report Bug Copy Issue Report The function `xoops_getHandler()` has been deprecated. This function has been deprecated. Loading history...
68		}
69		$this->module = $moduleHandler->getByDirname($dirname);
70		}
71	2	if (is_object($this->module)) {
72		$this->init();
73		}
74	2	}
75
76		/**
77		* init() is called once/if __construct has a module object.
78		* $this->module will have a module object that any further
79		* initialization can use.
80		*
81		* @return void
82		*/
83		abstract public function init();
84
85		/**
86		* Set debug option on or off
87		*
88		* @param bool $bool true to turn on debug logging, false for off
89		*
90		* @return void
91		*/
92	1	public function setDebug($bool = true)
93		{
94	1	$this->debug = (bool) $bool;
95	1	}
96
97		/**
98		* Add a message to the module log
99		*
100		* @param string $log log message
101		*
102		* @return void
103		*/
104	1	public function addLog($log)
105		{
106	1	if ($this->debug) {
107		\Xoops::getInstance()->logger()->debug($log, array('channel'=>'Extra'));
108		}
109	1	}
110		}
111

XOOPS / XoopsCore

Pull Request — master (#563)

AbstractHelper A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

4 Methods

Duplication Side-by-Side

Filter issues like