GenericHelper::isUserAdmin() - Code Metrics - Inspection of "Library Refresh" - XOOPS/XoopsCore25 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#583)

by Richard

created 2018-05-12 17:36 UTC

GenericHelper::isUserAdmin() A

↳ Parent: GenericHelper

Complexity

Conditions	3
Paths	4

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	3
nc	4
nop	0
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0

<?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;

use Xmf\Language;

/**
 * GenericHelper implements a Xoops 2.6 Xoops\Module\Helper\HelperAbstract.
 * We use it pre 2.6 systems so we can encapsulate many of the changes
 * needed to make modules more compatible with 2.6 in these methods.
 * The most common deprecated warnings can be avoided by using module
 * helper methods.
 *
 * @category  Xmf\Module\Helper\GenericHelper
 * @package   Xmf
 * @author    trabis <[email protected]>
 * @author    Richard Griffith <[email protected]>
 * @copyright 2016-2018 XOOPS Project (https://xoops.org)
 * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @link      https://xoops.org
 */
abstract class GenericHelper extends AbstractHelper
{
    /**
     * @var string module directory name
     */
    protected $dirname;

    /**
     * @var \XoopsModule
     */
    protected $object;

    /**
     * @var array of XoopsObjectHandler|XoopsPersistableObjectHandler
     */
    protected $handlers;

    /**
     * @var array config items
     */
    protected $configs;

    /**
     * Initialize parent::__construct calls this after verifying module object.
     *
     * @return void
     */
    public function init()
    {
        $this->object = $this->module;

        $this->dirname = $this->object->getVar('dirname');
    }

    /**
     * get the module object
     *
     * @return \XoopsModule
     */
    public function getModule()
    {
        if ($this->object == null) {
            $this->initObject();
        }
        if (!is_object($this->object)) {
            $this->addLog("ERROR :: Module '{$this->dirname}' does not exist");
        }

        return $this->object;
    }

    /**
     * get a module config item
     *
     * @param string $name    name of config item, or blank for all items
     * @param mixed  $default default value to return if config $name is not set
     *
     * @return mixed string config item, array of config items,
     *                or null if config not found
     */
    public function getConfig($name = null, $default = null)
    {
        if ($this->configs == null) {
            $this->initConfig();
        }
        if (empty($name)) {
            $this->addLog("Getting all config");

            return $this->configs;
        }

        if (!isset($this->configs[$name])) {
            $this->addLog("ERROR :: Config '{$name}' does not exist");
            return $default;
        }

        $this->addLog("Getting config '{$name}' : " . $this->serializeForHelperLog($this->configs[$name]));

        return $this->configs[$name];
    }

    /**
     * Get an Object Handler
     *
     * @param string $name name of handler to load
     *
     * @return bool|XoopsObjectHandler|XoopsPersistableObjectHandler
     */
    public function getHandler($name)
    {
        $ret = false;
        $name = strtolower($name);
        if (!isset($this->handlers[$name])) {
            $this->initHandler($name);
        }

        if (!isset($this->handlers[$name])) {
            $this->addLog("ERROR :: Handler '{$name}' does not exist");
        } else {
            $this->addLog("Getting handler '{$name}'");
            $ret = $this->handlers[$name];
        }

        return $ret;
    }

    /**
     * get a module object
     *
     * @return void
     */
    protected function initObject()
    {
        global $xoopsModule;
function myFunction($a, $b) {
    // Do something
}
        if (isset($xoopsModule) && is_object($xoopsModule)
            && $xoopsModule->getVar('dirname') == $this->dirname
        ) {
            $this->object = $xoopsModule;
        } else {
            /* @var $module_handler \XoopsModuleHandler */
            $module_handler = xoops_getHandler('module');
            $this->object = $module_handler->getByDirname($this->dirname);
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;
}
        }
        $this->addLog('INIT MODULE OBJECT');
    }

    /**
     * get module configs
     *
     * @return void
     */
    protected function initConfig()
    {
        $this->addLog('INIT CONFIG');
        global $xoopsModule;
function myFunction($a, $b) {
    // Do something
}
        if (isset($xoopsModule) && is_object($xoopsModule)
            && $xoopsModule->getVar('dirname') == $this->dirname
        ) {
            global $xoopsModuleConfig;
function myFunction($a, $b) {
    // Do something
}
            $this->configs = $xoopsModuleConfig;
        } else {
            /* @var $config_handler \XoopsConfigHandler */
            $config_handler = xoops_getHandler('config');
            $this->configs = $config_handler->getConfigsByCat(0, $this->getModule()->getVar('mid'));
        }
    }

    /**
     * get a handler instance and store in $this->_handlers
     *
     * @param string $name name of handler to load
     *
     * @return void
     */
    protected function initHandler($name)
    {
        $this->addLog('INIT ' . $name . ' HANDLER');

        if (!isset($this->handlers[$name])) {
            $hnd_file = XOOPS_ROOT_PATH . "/modules/{$this->dirname}/class/{$name}.php";
            if (file_exists($hnd_file)) {
                include_once $hnd_file;
            }
            $class = ucfirst(strtolower($this->dirname))
                . ucfirst(strtolower($name)) . 'Handler';
            if (class_exists($class)) {
                $db = \XoopsDatabaseFactory::getDatabaseConnection();
                $this->handlers[$name] = new $class($db);
                $this->addLog("Loading class '{$class}'");
            } else {
                $this->addLog("ERROR :: Class '{$class}' could not be loaded");
            }
        }
    }

    /**
     * load a language file for this module
     *
     * @param string $name basename of language file (i.e. 'admin')
     *
     * @return bool
     */
    public function loadLanguage($name)
    {
        if ($ret = Language::load($name, $this->dirname)) {
            $this->addLog("Loading language '{$name}'");
        } else {
            $this->addLog("ERROR :: Language '{$name}' could not be loaded");
        }

        return $ret;
    }

    /**
     * Is this the currently active module?
     *
     * @return bool
     */
    public function isCurrentModule()
    {
        if ($GLOBALS['xoopsModule']->getVar('dirname') == $this->dirname) {
            return true;
        }

        return false;
    }

    /**
     * Does user have admin rights to this module?
     *
     * @return bool true is user has admin right, else false
     */
    public function isUserAdmin()
    {
        return (isset($GLOBALS['xoopsUser']) && $GLOBALS['xoopsUser'] instanceof \XoopsUser)
            ? $GLOBALS['xoopsUser']->isAdmin($this->getModule()->getVar('mid')) : false;
    }

    /**
     * Return absolute URL for a module relative URL
     *
     * @param string $url module relative URL
     *
     * @return string
     */
    public function url($url = '')
    {
        return XOOPS_URL . '/modules/' . $this->dirname . '/' . $url;
    }

    /**
     * Return absolute filesystem path for a module relative path
     *
     * @param string $path module relative file system path
     *
     * @return string
     */
    public function path($path = '')
    {
        return XOOPS_ROOT_PATH . '/modules/' . $this->dirname . '/' . $path;
    }

    /**
     * Redirect the user to a page within this module
     *
     * @param string $url     module relative url (i.e. index.php)
     * @param int    $time    time in seconds to show redirect message
     * @param string $message redirect message
     *
     * @return void
     */
    public function redirect($url, $time = 3, $message = '')
    {
        redirect_header($this->url($url), $time, $message);
    }
}


Pull Request — master (#583)

GenericHelper::isUserAdmin() A

Complexity

Size

Duplication

Importance

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

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			use Xmf\Language;
15
16			/**
17			* GenericHelper implements a Xoops 2.6 Xoops\Module\Helper\HelperAbstract.
18			* We use it pre 2.6 systems so we can encapsulate many of the changes
19			* needed to make modules more compatible with 2.6 in these methods.
20			* The most common deprecated warnings can be avoided by using module
21			* helper methods.
22			*
23			* @category Xmf\Module\Helper\GenericHelper
24			* @package Xmf
25			* @author trabis <[email protected]>
26			* @author Richard Griffith <[email protected]>
27			* @copyright 2016-2018 XOOPS Project (https://xoops.org)
28			* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
29			* @link https://xoops.org
30			*/
31			abstract class GenericHelper extends AbstractHelper
32			{
33			/**
34			* @var string module directory name
35			*/
36			protected $dirname;
37
38			/**
39			* @var \XoopsModule
40			*/
41			protected $object;
42
43			/**
44			* @var array of XoopsObjectHandler\|XoopsPersistableObjectHandler
45			*/
46			protected $handlers;
47
48			/**
49			* @var array config items
50			*/
51			protected $configs;
52
53			/**
54			* Initialize parent::__construct calls this after verifying module object.
55			*
56			* @return void
57			*/
58			public function init()
59			{
60			$this->object = $this->module;
			0 ignored issues – show Documentation Bug introduced 2018-05-12 17:47 UTC by Report Bug Copy Issue Report It seems like `$this->module` of type `object<Xmf\Module\Helper\XoopsModule>` is incompatible with the declared type `object<XoopsModule>` of property `$object`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
61			$this->dirname = $this->object->getVar('dirname');
62			}
63
64			/**
65			* get the module object
66			*
67			* @return \XoopsModule
68			*/
69			public function getModule()
70			{
71			if ($this->object == null) {
72			$this->initObject();
73			}
74			if (!is_object($this->object)) {
75			$this->addLog("ERROR :: Module '{$this->dirname}' does not exist");
76			}
77
78			return $this->object;
79			}
80
81			/**
82			* get a module config item
83			*
84			* @param string $name name of config item, or blank for all items
85			* @param mixed $default default value to return if config $name is not set
86			*
87			* @return mixed string config item, array of config items,
88			* or null if config not found
89			*/
90			public function getConfig($name = null, $default = null)
91			{
92			if ($this->configs == null) {
93			$this->initConfig();
94			}
95			if (empty($name)) {
96			$this->addLog("Getting all config");
97
98			return $this->configs;
99			}
100
101			if (!isset($this->configs[$name])) {
102			$this->addLog("ERROR :: Config '{$name}' does not exist");
103			return $default;
104			}
105
106			$this->addLog("Getting config '{$name}' : " . $this->serializeForHelperLog($this->configs[$name]));
107
108			return $this->configs[$name];
109			}
110
111			/**
112			* Get an Object Handler
113			*
114			* @param string $name name of handler to load
115			*
116			* @return bool\|XoopsObjectHandler\|XoopsPersistableObjectHandler
117			*/
118			public function getHandler($name)
119			{
120			$ret = false;
121			$name = strtolower($name);
122			if (!isset($this->handlers[$name])) {
123			$this->initHandler($name);
124			}
125
126			if (!isset($this->handlers[$name])) {
127			$this->addLog("ERROR :: Handler '{$name}' does not exist");
128			} else {
129			$this->addLog("Getting handler '{$name}'");
130			$ret = $this->handlers[$name];
131			}
132
133			return $ret;
134			}
135
136			/**
137			* get a module object
138			*
139			* @return void
140			*/
141			protected function initObject()
142			{
143			global $xoopsModule;
			0 ignored issues – show Compatibility Best Practice introduced 2016-03-07 05:16 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...
144			if (isset($xoopsModule) && is_object($xoopsModule)
145			&& $xoopsModule->getVar('dirname') == $this->dirname
146			) {
147			$this->object = $xoopsModule;
148			} else {
149			/* @var $module_handler \XoopsModuleHandler */
150			$module_handler = xoops_getHandler('module');
151			$this->object = $module_handler->getByDirname($this->dirname);
			0 ignored issues – show Documentation Bug introduced 2017-02-11 18:34 UTC by Report Bug Copy Issue Report It seems like `$module_handler->getByDirname($this->dirname)` can also be of type `false`. However, the property `$object` is declared as type `object<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...
152			}
153			$this->addLog('INIT MODULE OBJECT');
154			}
155
156			/**
157			* get module configs
158			*
159			* @return void
160			*/
161			protected function initConfig()
162			{
163			$this->addLog('INIT CONFIG');
164			global $xoopsModule;
			0 ignored issues – show Compatibility Best Practice introduced 2016-03-07 05:16 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...
165			if (isset($xoopsModule) && is_object($xoopsModule)
166			&& $xoopsModule->getVar('dirname') == $this->dirname
167			) {
168			global $xoopsModuleConfig;
			0 ignored issues – show Compatibility Best Practice introduced 2016-03-07 05:16 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...
169			$this->configs = $xoopsModuleConfig;
170			} else {
171			/* @var $config_handler \XoopsConfigHandler */
172			$config_handler = xoops_getHandler('config');
173			$this->configs = $config_handler->getConfigsByCat(0, $this->getModule()->getVar('mid'));
174			}
175			}
176
177			/**
178			* get a handler instance and store in $this->_handlers
179			*
180			* @param string $name name of handler to load
181			*
182			* @return void
183			*/
184			protected function initHandler($name)
185			{
186			$this->addLog('INIT ' . $name . ' HANDLER');
187
188			if (!isset($this->handlers[$name])) {
189			$hnd_file = XOOPS_ROOT_PATH . "/modules/{$this->dirname}/class/{$name}.php";
190			if (file_exists($hnd_file)) {
191			include_once $hnd_file;
192			}
193			$class = ucfirst(strtolower($this->dirname))
194			. ucfirst(strtolower($name)) . 'Handler';
195			if (class_exists($class)) {
196			$db = \XoopsDatabaseFactory::getDatabaseConnection();
197			$this->handlers[$name] = new $class($db);
198			$this->addLog("Loading class '{$class}'");
199			} else {
200			$this->addLog("ERROR :: Class '{$class}' could not be loaded");
201			}
202			}
203			}
204
205			/**
206			* load a language file for this module
207			*
208			* @param string $name basename of language file (i.e. 'admin')
209			*
210			* @return bool
211			*/
212			public function loadLanguage($name)
213			{
214			if ($ret = Language::load($name, $this->dirname)) {
215			$this->addLog("Loading language '{$name}'");
216			} else {
217			$this->addLog("ERROR :: Language '{$name}' could not be loaded");
218			}
219
220			return $ret;
221			}
222
223			/**
224			* Is this the currently active module?
225			*
226			* @return bool
227			*/
228			public function isCurrentModule()
229			{
230			if ($GLOBALS['xoopsModule']->getVar('dirname') == $this->dirname) {
231			return true;
232			}
233
234			return false;
235			}
236
237			/**
238			* Does user have admin rights to this module?
239			*
240			* @return bool true is user has admin right, else false
241			*/
242			public function isUserAdmin()
243			{
244			return (isset($GLOBALS['xoopsUser']) && $GLOBALS['xoopsUser'] instanceof \XoopsUser)
245			? $GLOBALS['xoopsUser']->isAdmin($this->getModule()->getVar('mid')) : false;
246			}
247
248			/**
249			* Return absolute URL for a module relative URL
250			*
251			* @param string $url module relative URL
252			*
253			* @return string
254			*/
255			public function url($url = '')
256			{
257			return XOOPS_URL . '/modules/' . $this->dirname . '/' . $url;
258			}
259
260			/**
261			* Return absolute filesystem path for a module relative path
262			*
263			* @param string $path module relative file system path
264			*
265			* @return string
266			*/
267			public function path($path = '')
268			{
269			return XOOPS_ROOT_PATH . '/modules/' . $this->dirname . '/' . $path;
270			}
271
272			/**
273			* Redirect the user to a page within this module
274			*
275			* @param string $url module relative url (i.e. index.php)
276			* @param int $time time in seconds to show redirect message
277			* @param string $message redirect message
278			*
279			* @return void
280			*/
281			public function redirect($url, $time = 3, $message = '')
282			{
283			redirect_header($this->url($url), $time, $message);
284			}
285			}
286

XOOPS / XoopsCore25

Pull Request — master (#583)

GenericHelper::isUserAdmin() A

Complexity

Size

Duplication

Importance

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