ObjectsRegistry - Code Metrics - mambax7/smartobject - Measure and Improve Code Quality continuously with Scrutinizer

ObjectsRegistry A
last analyzed 2019-01-19 04:07 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	168
Duplicated Lines	36.9 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	62
loc	168
rs	10
c	0
b	0
f	0
wmc	23
lcom	1
cbo	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getInstance()	0	9	2
A	addObjectsFromHandler()	8	11	2
A	addObjectsFromItemName()	8	21	4
A	getObjects()	23	23	5
A	getList()	23	23	5
A	getSingleObject()	0	22	5

How to fix Duplicated Code

<?php namespace XoopsModules\Smartobject;

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

/**
 * @copyright    XOOPS Project https://xoops.org/
 * @license      GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @package
 * @since
 * @author     XOOPS Development Team
 */

use CriteriaCompo;
use XoopsModules\Smartobject;

// defined('XOOPS_ROOT_PATH') || die('Restricted access');

/**
 * SmartObjects Registry
 *
 * The SmartObjects Registry is an object containing SmartObject objects that will be reused in the same process
 *
 * @package SmartObject
 * @author  marcan <[email protected]>
 * @link    http://smartfactory.ca The SmartFactory
 */
class ObjectsRegistry
{
    public $_registryArray;

    /**
     * Access the only instance of this class
     *
     * @return \XoopsModules\Smartobject\ObjectsRegistry
     *
     * @static
     * @staticvar   object
     */
    public static function getInstance()
    {
        static $instance;
        if (null === $instance) {
            $instance = new static();
        }

        return $instance;
    }

    /**
     * Adding objects to the registry
     *
     * @param  PersistableObjectHandler $handler  of the objects to add
     * @param  bool|CriteriaCompo       $criteria to pass to the getObjects method of the handler (with id_as_key)
     * @return FALSE                         if an error occured
     */
    public function addObjectsFromHandler(&$handler, $criteria = false)
    {
        if (method_exists($handler, 'getObjects')) {

            $objects                                                                     = $handler->getObjects($criteria, true);
            $this->_registryArray['objects'][$handler->_moduleName][$handler->_itemname] = $objects;

            return $objects;
        } else {
            return false;
        }
    }

    /**
     * Adding objects to the registry from an item name
     * This method will fetch the handler of the item / module and call the addObjectsFromHandler
     *
     * @param  string             $item       name of the item
     * @param  bool|string        $modulename name of the module
     * @param  bool|CriteriaCompo $criteria   to pass to the getObjects method of the handler (with id_as_key)
     * @return FALSE              if an error occured
     */
    public function addObjectsFromItemName($item, $modulename = false, $criteria = false)
    {
        if (!$modulename) {
            global $xoopsModule;
            if (!is_object($xoopsModule)) {
                return false;
            } else {
                $modulename = $xoopsModule->dirname();
            }
        }
        $objectHandler = xoops_getModuleHandler($item, $modulename);

        if (method_exists($objectHandler, 'getObjects')) {

            $objects                                                                                 = $objectHandler->getObjects($criteria, true);
            $this->_registryArray['objects'][$objectHandler->_moduleName][$objectHandler->_itemname] = $objects;

            return $objects;
        } else {
            return false;
        }
    }

    /**
     * Fetching objects from the registry
     *
     * @param string $itemname
     * @param string $modulename
     *
     * @return false|array the requested objects or FALSE if they don't exists in the registry
     */
    public function getObjects($itemname, $modulename)

    {
        if (!$modulename) {
            global $xoopsModule;
            if (!is_object($xoopsModule)) {
                return false;
            } else {
                $modulename = $xoopsModule->dirname();
            }
        }
        if (isset($this->_registryArray['objects'][$modulename][$itemname])) {
            return $this->_registryArray['objects'][$modulename][$itemname];
        } else {
            // if they were not in registry, let's fetch them and add them to the reigistry
            $moduleHandler = xoops_getModuleHandler($itemname, $modulename);
            if (method_exists($moduleHandler, 'getObjects')) {
                $objects = $moduleHandler->getObjects();
            }
            $this->_registryArray['objects'][$modulename][$itemname] = $objects;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

            return $objects;
        }
    }

    /**
     * Fetching objects from the registry, as a list: objectid => identifier
     *
     * @param string $itemname
     * @param string $modulename
     *
     * @return false|array the requested objects or FALSE if they don't exists in the registry
     */
    public function getList($itemname, $modulename)

    {
        if (!$modulename) {
            global $xoopsModule;
            if (!is_object($xoopsModule)) {
                return false;
            } else {
                $modulename = $xoopsModule->dirname();
            }
        }
        if (isset($this->_registryArray['list'][$modulename][$itemname])) {
            return $this->_registryArray['list'][$modulename][$itemname];
        } else {
            // if they were not in registry, let's fetch them and add them to the reigistry
            $moduleHandler = xoops_getModuleHandler($itemname, $modulename);
            if (method_exists($moduleHandler, 'getList')) {
                $objects = $moduleHandler->getList();
            }
            $this->_registryArray['list'][$modulename][$itemname] = $objects;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

            return $objects;
        }
    }

    /**
     * Retreive a single object
     *
     * @param string $itemname
     * @param string $key
     *
     * @param  bool  $modulename
     * @return false|\XoopsObject the  requestd object or FALSE if they don't exists in the registry
     */
    public function getSingleObject($itemname, $key, $modulename = false)
    {
        if (!$modulename) {
            global $xoopsModule;
            if (!is_object($xoopsModule)) {
                return false;
            } else {
                $modulename = $xoopsModule->dirname();
            }
        }
        if (isset($this->_registryArray['objects'][$modulename][$itemname][$key])) {
            return $this->_registryArray['objects'][$modulename][$itemname][$key];
        } else {
            $objectHandler = xoops_getModuleHandler($itemname, $modulename);
            $object        = $objectHandler->get($key);
            if (!$object->isNew()) {
                return $object;
            } else {
                return false;
            }
        }
    }
}


ObjectsRegistry A
last analyzed 2019-01-19 04:07 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

1		<?php namespace XoopsModules\Smartobject;
2
3		/*
4		* You may not change or alter any portion of this comment or credits
5		* of supporting developers from this source code or any supporting source code
6		* which is considered copyrighted (c) material of the original comment or credit authors.
7		*
8		* This program is distributed in the hope that it will be useful,
9		* but WITHOUT ANY WARRANTY; without even the implied warranty of
10		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11		*/
12
13		/**
14		* @copyright XOOPS Project https://xoops.org/
15		* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
16		* @package
17		* @since
18		* @author XOOPS Development Team
19		*/
20
21		use CriteriaCompo;
22		use XoopsModules\Smartobject;
23
24		// defined('XOOPS_ROOT_PATH') \|\| die('Restricted access');
25
26		/**
27		* SmartObjects Registry
28		*
29		* The SmartObjects Registry is an object containing SmartObject objects that will be reused in the same process
30		*
31		* @package SmartObject
32		* @author marcan <[email protected]>
33		* @link http://smartfactory.ca The SmartFactory
34		*/
35		class ObjectsRegistry
36		{
37		public $_registryArray;
38
39		/**
40		* Access the only instance of this class
41		*
42		* @return \XoopsModules\Smartobject\ObjectsRegistry
43		*
44		* @static
45		* @staticvar object
46		*/
47		public static function getInstance()
48		{
49		static $instance;
50		if (null === $instance) {
51		$instance = new static();
52		}
53
54		return $instance;
55		}
56
57		/**
58		* Adding objects to the registry
59		*
60		* @param PersistableObjectHandler $handler of the objects to add
61		* @param bool\|CriteriaCompo $criteria to pass to the getObjects method of the handler (with id_as_key)
62		* @return FALSE if an error occured
63		*/
64		public function addObjectsFromHandler(&$handler, $criteria = false)
65		{
66	View Code Duplication	if (method_exists($handler, 'getObjects')) {
		0 ignored issues – show Duplication introduced 2016-04-01 10:59 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
67		$objects = $handler->getObjects($criteria, true);
68		$this->_registryArray['objects'][$handler->_moduleName][$handler->_itemname] = $objects;
69
70		return $objects;
71		} else {
72		return false;
73		}
74		}
75
76		/**
77		* Adding objects to the registry from an item name
78		* This method will fetch the handler of the item / module and call the addObjectsFromHandler
79		*
80		* @param string $item name of the item
81		* @param bool\|string $modulename name of the module
82		* @param bool\|CriteriaCompo $criteria to pass to the getObjects method of the handler (with id_as_key)
83		* @return FALSE if an error occured
84		*/
85		public function addObjectsFromItemName($item, $modulename = false, $criteria = false)
86		{
87		if (!$modulename) {
88		global $xoopsModule;
89		if (!is_object($xoopsModule)) {
90		return false;
91		} else {
92		$modulename = $xoopsModule->dirname();
93		}
94		}
95		$objectHandler = xoops_getModuleHandler($item, $modulename);
96
97	View Code Duplication	if (method_exists($objectHandler, 'getObjects')) {
		0 ignored issues – show Duplication introduced 2016-04-01 10:59 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
98		$objects = $objectHandler->getObjects($criteria, true);
99		$this->_registryArray['objects'][$objectHandler->_moduleName][$objectHandler->_itemname] = $objects;
100
101		return $objects;
102		} else {
103		return false;
104		}
105		}
106
107		/**
108		* Fetching objects from the registry
109		*
110		* @param string $itemname
111		* @param string $modulename
112		*
113		* @return false\|array the requested objects or FALSE if they don't exists in the registry
114		*/
115	View Code Duplication	public function getObjects($itemname, $modulename)
		0 ignored issues – show Duplication introduced 2017-08-04 04:21 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
116		{
117		if (!$modulename) {
118		global $xoopsModule;
119		if (!is_object($xoopsModule)) {
120		return false;
121		} else {
122		$modulename = $xoopsModule->dirname();
123		}
124		}
125		if (isset($this->_registryArray['objects'][$modulename][$itemname])) {
126		return $this->_registryArray['objects'][$modulename][$itemname];
127		} else {
128		// if they were not in registry, let's fetch them and add them to the reigistry
129		$moduleHandler = xoops_getModuleHandler($itemname, $modulename);
130		if (method_exists($moduleHandler, 'getObjects')) {
131		$objects = $moduleHandler->getObjects();
132		}
133		$this->_registryArray['objects'][$modulename][$itemname] = $objects;
		0 ignored issues – show Bug introduced 2016-04-01 10:59 UTC by Report Bug Copy Issue Report The variable `$objects` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
134
135		return $objects;
136		}
137		}
138
139		/**
140		* Fetching objects from the registry, as a list: objectid => identifier
141		*
142		* @param string $itemname
143		* @param string $modulename
144		*
145		* @return false\|array the requested objects or FALSE if they don't exists in the registry
146		*/
147	View Code Duplication	public function getList($itemname, $modulename)
		0 ignored issues – show Duplication introduced 2017-08-04 04:21 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
148		{
149		if (!$modulename) {
150		global $xoopsModule;
151		if (!is_object($xoopsModule)) {
152		return false;
153		} else {
154		$modulename = $xoopsModule->dirname();
155		}
156		}
157		if (isset($this->_registryArray['list'][$modulename][$itemname])) {
158		return $this->_registryArray['list'][$modulename][$itemname];
159		} else {
160		// if they were not in registry, let's fetch them and add them to the reigistry
161		$moduleHandler = xoops_getModuleHandler($itemname, $modulename);
162		if (method_exists($moduleHandler, 'getList')) {
163		$objects = $moduleHandler->getList();
164		}
165		$this->_registryArray['list'][$modulename][$itemname] = $objects;
		0 ignored issues – show Bug introduced 2016-04-01 10:59 UTC by Report Bug Copy Issue Report The variable `$objects` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
166
167		return $objects;
168		}
169		}
170
171		/**
172		* Retreive a single object
173		*
174		* @param string $itemname
175		* @param string $key
176		*
177		* @param bool $modulename
178		* @return false\|\XoopsObject the requestd object or FALSE if they don't exists in the registry
179		*/
180		public function getSingleObject($itemname, $key, $modulename = false)
181		{
182		if (!$modulename) {
183		global $xoopsModule;
184		if (!is_object($xoopsModule)) {
185		return false;
186		} else {
187		$modulename = $xoopsModule->dirname();
188		}
189		}
190		if (isset($this->_registryArray['objects'][$modulename][$itemname][$key])) {
191		return $this->_registryArray['objects'][$modulename][$itemname][$key];
192		} else {
193		$objectHandler = xoops_getModuleHandler($itemname, $modulename);
194		$object = $objectHandler->get($key);
195		if (!$object->isNew()) {
196		return $object;
197		} else {
198		return false;
199		}
200		}
201		}
202		}
203

mambax7 / smartobject

ObjectsRegistry A last analyzed 2019-01-19 04:07 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

ObjectsRegistry A
last analyzed 2019-01-19 04:07 UTC