Pedigree::getHandler() - Code Metrics - Inspection of "Merge pull request #3 from zyspec/master" - mambax7/pedigree - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b847d6...d6d54c )

by Michael

created 2019-10-21 01:45 UTC

Pedigree::getHandler() A

↳ Parent: Pedigree

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php 


namespace XoopsModules\Pedigree;

/*
 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.
 */
/**
 *  Pedigree class
 *
 * @copyright       The XUUPS Project http://sourceforge.net/projects/xuups/
 * @license         http://www.fsf.org/copyleft/gpl.html GNU public license
 * @package         XoopsModules\Pedigree\class
 * @since           1.0
 * @author          trabis <[email protected]>
 * @author          XOOPS Module Dev
 */
defined('XOOPS_ROOT_PATH') || die('Restricted access');

use \XoopsModules\Pedigree\Helper;

/**
 * Class Pedigree
 * @deprecated
 */
class Pedigree
{
    public $dirname;
    public $module;
    public $handler;
    public $config;
    public $debug;
    public $debugArray = [];

    /**
     * @param $debug
     */
    protected function __construct($debug)
    {
       $this->debug   = $debug;
       $moduleDirName = basename(dirname(__DIR__));

       //parent::__construct($moduleDirName);

    }

    /**
     * @param bool $debug
     *
     * @return \XoopsModules\Pedigree\Pedigree
     */
    public static function getInstance($debug = false)
    {
        static $instance;
        if (null === $instance) {
            $instance = new static($debug);
        }
        //error_log("instance: [" . print_r($istance,true) . "]");

        //phpinfo();

        //debug_print_backtrace ();

        return $instance;
    }

    public function getModule()
    {
        if (null === $this->module) {
            $this->initModule();
        }
        return $this->module;
    }

    /**
     * getConfig gets module configuration parameters
     *
     * @param string|null $name get a specific config paramter or all configs if $name = null
     *
     * @return array|string|null
     */
    public function getConfig($name = null)
    {
        $helper = Helper::getInstance();

        if (null === $this->config) {
            $this->initConfig();
        }
        if (!$name) {
            $helper->addLog('Getting all config');
            //$this->addLog('Getting all config');

            return $this->config;
        }
        if (!isset($this->config[$name])) {
            $helper->addLog("ERROR :: CONFIG '{$name}' does not exist");
            //$this->addLog("ERROR :: CONFIG '{$name}' does not exist");

            return null;
        }
        $helper->addLog("Getting config '{$name}' : " . print_r($this->config[$name], true));
        //$this->addLog("Getting config '{$name}' : " . print_r($this->config[$name], true));



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

    /**
     * @param string|null $name name of configuration option
     * @param mixed|null $value value for config option
     *
     * @return mixed
     */
    public function setConfig($name = null, $value = null)
    {
        /** @var \XoopsModules\Pedigree\Helper $helper */
        $helper = Helper::getInstance();

        if (null === $this->config) {
            $this->initConfig();
        }
        $this->config[$name] = $value;
        $helper->addLog("Setting config '{$name}' : " . $this->config[$name]);
        //$this->addLog("Setting config '{$name}' : " . $this->config[$name]);



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

    /**
     * @param $name
     *
     * @return mixed
     */
    public function getHandler($name)
    {
        if (!isset($this->handler[$name . 'Handler'])) {
            $this->initHandler($name);
        }
        $helper = Helper::getInstance();
        $helper->addLog("Getting handler '{$name}'");
        //$this->addLog("Getting handler '{$name}'");


        return $this->handler[$name . 'Handler'];
    }

    /**
     * initModule instantiates XOOPS module object
     *
     * @return void
     */
    public function initModule()
    {
        /** @var \XoopsModules\Pedigree\Helper $helper */
        $helper       = Helper::getInstance();
        $this->module = $helper->getModule();
        $helper->addLog('INIT MODULE');
        /*


        global $xoopsModule;
        if (isset($xoopsModule) && is_object($xoopsModule) && $xoopsModule->getVar('dirname') == $this->dirname) {
            $this->module = $xoopsModule;
        } else {
            $hModule      = xoops_getHandler('module');
            $this->module = $hModule->getByDirname($this->dirname);
        }
        $this->addLog('INIT MODULE');
        */

    }

    public function initConfig()
    {
        /** @var \XoopsModules\Pedigree\Helper $helper */
        $helper       = Helper::getInstance();
        $this->config = $helper->getConfig();
        /*

        $this->addLog('INIT CONFIG');
        $hModConfig   = xoops_getHandler('config');
        $this->config = $hModConfig->getConfigsByCat(0, $this->getModule()->getVar('mid'));
        */
    }

    /**
     * @param string $name name of the class/object for the handler
     */
    public function initHandler($name)
    {
        /** @var \XoopsModules\Pedigree\Helper $helper */
        $helper = Helper::getInstance();
        $this->handler[$name . 'Handler'] = $helper->getHandler(ucfirst($name));
        /*

        $helper->addLog('INIT ' . ucase($name) . ' HANDLER');
        $this->addLog('INIT ' . ucase($name) . ' HANDLER');
        $this->handler[$name . 'Handler'] = xoops_getModuleHandler($name, $this->dirname);
        */

    }

    /**
     * @param $log
     */
    public function addLog($log)
    {
        if ($this->debug) {
            /** @var \XoopsModules\Pedigree\Helper $helper */
            $helper = Helper::getInstance();
            $helper->addLog($log);
            /*

            if (is_object($GLOBALS['xoopsLogger'])) {
                $GLOBALS['xoopsLogger']->addExtra($this->module->name(), $log);
            }
            */

        }
    }
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2019-10-21 01:50 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 32 and the first side effect is on line 24. 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			namespace XoopsModules\Pedigree;
4
5			/*
6			You may not change or alter any portion of this comment or credits
7			of supporting developers from this source code or any supporting source code
8			which is considered copyrighted (c) material of the original comment or credit authors.
9
10			This program is distributed in the hope that it will be useful,
11			but WITHOUT ANY WARRANTY; without even the implied warranty of
12			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13			*/
14			/**
15			* Pedigree class
16			*
17			* @copyright The XUUPS Project http://sourceforge.net/projects/xuups/
18			* @license http://www.fsf.org/copyleft/gpl.html GNU public license
19			* @package XoopsModules\Pedigree\class
20			* @since 1.0
21			* @author trabis <[email protected]>
22			* @author XOOPS Module Dev
23			*/
24			defined('XOOPS_ROOT_PATH') \|\| die('Restricted access');
25
26			use \XoopsModules\Pedigree\Helper;
27
28			/**
29			* Class Pedigree
30			* @deprecated
31			*/
32			class Pedigree
33			{
34			public $dirname;
35			public $module;
36			public $handler;
37			public $config;
38			public $debug;
39			public $debugArray = [];
40
41			/**
42			* @param $debug
43			*/
44			protected function __construct($debug)
45			{
46			$this->debug = $debug;
47			$moduleDirName = basename(dirname(__DIR__));
			0 ignored issues – show Unused Code introduced 2019-10-21 01:50 UTC by Report Bug Copy Issue Report The assignment to `$moduleDirName` is dead and can be removed. Loading history...
48			//parent::__construct($moduleDirName);
			0 ignored issues – show Unused Code Comprehensibility introduced 2019-10-21 01:50 UTC by Report Bug Copy Issue Report `86%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
49			}
50
51			/**
52			* @param bool $debug
53			*
54			* @return \XoopsModules\Pedigree\Pedigree
55			*/
56			public static function getInstance($debug = false)
57			{
58			static $instance;
59			if (null === $instance) {
60			$instance = new static($debug);
61			}
62			//error_log("instance: [" . print_r($istance,true) . "]");
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-13 09:56 UTC by Report Bug Copy Issue Report `56%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
63			//phpinfo();
			0 ignored issues – show Unused Code Comprehensibility introduced 2019-01-19 04:01 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
64			//debug_print_backtrace ();
			0 ignored issues – show Unused Code Comprehensibility introduced 2019-01-19 04:01 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
65			return $instance;
66			}
67
68			public function getModule()
69			{
70			if (null === $this->module) {
71			$this->initModule();
72			}
73			return $this->module;
74			}
75
76			/**
77			* getConfig gets module configuration parameters
78			*
79			* @param string\|null $name get a specific config paramter or all configs if $name = null
80			*
81			* @return array\|string\|null
82			*/
83			public function getConfig($name = null)
84			{
85			$helper = Helper::getInstance();
86
87			if (null === $this->config) {
88			$this->initConfig();
89			}
90			if (!$name) {
91			$helper->addLog('Getting all config');
92			//$this->addLog('Getting all config');
			0 ignored issues – show Unused Code Comprehensibility introduced 2019-10-21 01:50 UTC by Report Bug Copy Issue Report `86%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
93			return $this->config;
94			}
95			if (!isset($this->config[$name])) {
96			$helper->addLog("ERROR :: CONFIG '{$name}' does not exist");
97			//$this->addLog("ERROR :: CONFIG '{$name}' does not exist");
			0 ignored issues – show Unused Code Comprehensibility introduced 2019-10-21 01:50 UTC by Report Bug Copy Issue Report `86%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
98			return null;
99			}
100			$helper->addLog("Getting config '{$name}' : " . print_r($this->config[$name], true));
101			//$this->addLog("Getting config '{$name}' : " . print_r($this->config[$name], true));
			0 ignored issues – show Unused Code Comprehensibility introduced 2019-10-21 01:50 UTC by Report Bug Copy Issue Report `69%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
102
103
104			return $this->config[$name];
105			}
106
107			/**
108			* @param string\|null $name name of configuration option
109			* @param mixed\|null $value value for config option
110			*
111			* @return mixed
112			*/
113			public function setConfig($name = null, $value = null)
114			{
115			/** @var \XoopsModules\Pedigree\Helper $helper */
116			$helper = Helper::getInstance();
117
118			if (null === $this->config) {
119			$this->initConfig();
120			}
121			$this->config[$name] = $value;
122			$helper->addLog("Setting config '{$name}' : " . $this->config[$name]);
123			//$this->addLog("Setting config '{$name}' : " . $this->config[$name]);
			0 ignored issues – show Unused Code Comprehensibility introduced 2019-10-21 01:50 UTC by Report Bug Copy Issue Report `69%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
124
125
126			return $this->config[$name];
127			}
128
129			/**
130			* @param $name
131			*
132			* @return mixed
133			*/
134			public function getHandler($name)
135			{
136			if (!isset($this->handler[$name . 'Handler'])) {
137			$this->initHandler($name);
138			}
139			$helper = Helper::getInstance();
140			$helper->addLog("Getting handler '{$name}'");
141			//$this->addLog("Getting handler '{$name}'");
			0 ignored issues – show Unused Code Comprehensibility introduced 2019-10-21 01:50 UTC by Report Bug Copy Issue Report `86%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
142
143			return $this->handler[$name . 'Handler'];
144			}
145
146			/**
147			* initModule instantiates XOOPS module object
148			*
149			* @return void
150			*/
151			public function initModule()
152			{
153			/** @var \XoopsModules\Pedigree\Helper $helper */
154			$helper = Helper::getInstance();
155			$this->module = $helper->getModule();
156			$helper->addLog('INIT MODULE');
157			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2019-10-21 01:50 UTC by Report Bug Copy Issue Report `57%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
158
159			global $xoopsModule;
160			if (isset($xoopsModule) && is_object($xoopsModule) && $xoopsModule->getVar('dirname') == $this->dirname) {
161			$this->module = $xoopsModule;
162			} else {
163			$hModule = xoops_getHandler('module');
164			$this->module = $hModule->getByDirname($this->dirname);
165			}
166			$this->addLog('INIT MODULE');
167			*/
168
169			}
170
171			public function initConfig()
172			{
173			/** @var \XoopsModules\Pedigree\Helper $helper */
174			$helper = Helper::getInstance();
175			$this->config = $helper->getConfig();
176			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2019-10-21 01:50 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
177			$this->addLog('INIT CONFIG');
178			$hModConfig = xoops_getHandler('config');
179			$this->config = $hModConfig->getConfigsByCat(0, $this->getModule()->getVar('mid'));
180			*/
181			}
182
183			/**
184			* @param string $name name of the class/object for the handler
185			*/
186			public function initHandler($name)
187			{
188			/** @var \XoopsModules\Pedigree\Helper $helper */
189			$helper = Helper::getInstance();
190			$this->handler[$name . 'Handler'] = $helper->getHandler(ucfirst($name));
191			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2019-10-21 01:50 UTC by Report Bug Copy Issue Report `54%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
192			$helper->addLog('INIT ' . ucase($name) . ' HANDLER');
193			$this->addLog('INIT ' . ucase($name) . ' HANDLER');
194			$this->handler[$name . 'Handler'] = xoops_getModuleHandler($name, $this->dirname);
195			*/
196
197			}
198
199			/**
200			* @param $log
201			*/
202			public function addLog($log)
203			{
204			if ($this->debug) {
205			/** @var \XoopsModules\Pedigree\Helper $helper */
206			$helper = Helper::getInstance();
207			$helper->addLog($log);
208			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2019-10-21 01:50 UTC by Report Bug Copy Issue Report `73%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
209			if (is_object($GLOBALS['xoopsLogger'])) {
210			$GLOBALS['xoopsLogger']->addExtra($this->module->name(), $log);
211			}
212			*/
213
214			}
215			}
216			}
217

mambax7 / pedigree

Push — master ( b847d6...d6d54c )

Pedigree::getHandler() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like