AbstractHelper::addLog() - Code Metrics - Inspection of "Cleaning Up" - XOOPS/XoopsCore - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#491)

by Richard

created 2016-05-12 03:47 UTC

AbstractHelper::addLog() A

↳ Parent: AbstractHelper

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2.0625

Metric	Value
dl	0
loc	6
ccs	3
cts	4
cp	0.75
rs	9.4285
cc	2
eloc	3
nc	2
nop	1
crap	2.0625

<?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)
 * @version   Release: 1.0
 * @link      http://xoops.org
 * @since     1.0
 */
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		* @version Release: 1.0
25		* @link http://xoops.org
26		* @since 1.0
27		*/
28		abstract class AbstractHelper
29		{
30		/**
31		* @var XoopsModule
32		*/
33		protected $module;
34
35		/**
36		* @var bool true if debug is enabled
37		*/
38		protected $debug;
39
40		/**
41		* Instantiate a XoopsModule object for the helper to use.
42		* The module is determined as follows:
43		* - if null is passed, use the current module
44		* - if a string is passed, use as dirname to load
45		*
46		* @param string\|null $dirname dirname
47		*/
48		public function __construct($dirname = null)
		0 ignored issues – show Coding Style introduced 2016-03-22 02:49 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...
49		{
50		$this->module = null;
51		if (class_exists('Xoops', false)) {
52		$xoops = \Xoops::getInstance();
53		}
54		if (empty($dirname)) {
55		// nothing specified, use current module
56		// check if we are running in 2.6
57		if (isset($xoops)) {
58		if ($xoops->isModule()) {
59		$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...
60		}
61		} else {
62		$this->module = $GLOBALS['xoopsModule'];
63		}
64		} else {
65		// assume dirname specified, try to get a module object
66		if (isset($xoops)) {
67		$moduleHandler = $xoops->getHandlerModule();
68		} else {
69		$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...
70		}
71		$this->module = $moduleHandler->getByDirname($dirname);
72		}
73		if (is_object($this->module)) {
74		$this->init();
75		}
76		}
77
78		/**
79		* init() is called once/if __construct has a module object.
80		* $this->module will have a module object that any further
81		* initialization can use.
82		*
83		* @return void
84		*/
85		abstract public function init();
86
87		/**
88		* Set debug option on or off
89		*
90		* @param bool $bool true to turn on debug logging, false for off
91		*
92		* @return void
93		*/
94	1	public function setDebug($bool = true)
95		{
96	1	$this->debug = (bool) $bool;
97	1	}
98
99		/**
100		* Add a message to the module log
101		*
102		* @param string $log log message
103		*
104		* @return void
105		*/
106	1	public function addLog($log)
107		{
108	1	if ($this->debug) {
109		\Xoops::getInstance()->logger()->debug($log, array('channel'=>'Extra'));
110		}
111	1	}
112		}
113

XOOPS / XoopsCore

Pull Request — master (#491)

AbstractHelper::addLog() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like