Rating::dirname() - Code Metrics - Inspection of "updates" - mambax7/smartobject - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 88111b...b3fce7 )

by Michael

created 2018-03-22 11:20 UTC

Rating::dirname() A

↳ Parent: Rating

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	0
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0

<?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 XoopsModules\Smartobject;

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


//require_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartobject.php';

//require_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartplugins.php';

/**
 * Class SmartobjectRating
 */
class Rating extends Smartobject\BaseSmartObject
{
    public $_modulePlugin = false;

    /**
     * SmartobjectRating constructor.
     */
    public function __construct()
    {
        $this->quickInitVar('ratingid', XOBJ_DTYPE_INT, true);
        $this->quickInitVar('dirname', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_RATING_DIRNAME);
        $this->quickInitVar('item', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_RATING_ITEM);
        $this->quickInitVar('itemid', XOBJ_DTYPE_INT, true, _CO_SOBJECT_RATING_ITEMID);
        $this->quickInitVar('uid', XOBJ_DTYPE_INT, true, _CO_SOBJECT_RATING_UID);
        $this->quickInitVar('date', XOBJ_DTYPE_LTIME, true, _CO_SOBJECT_RATING_DATE);
        $this->quickInitVar('rate', XOBJ_DTYPE_INT, true, _CO_SOBJECT_RATING_RATE);

        $this->initNonPersistableVar('name', XOBJ_DTYPE_TXTBOX, 'user', _CO_SOBJECT_RATING_NAME);

        $this->setControl('dirname', [
            'handler'  => 'rating',
            'method'   => 'getModuleList',
            'onSelect' => 'submit'
        ]);

        $this->setControl('item', [
            'object' => &$this,
            'method' => 'getItemList'
        ]);

        $this->setControl('uid', 'user');

        $this->setControl('rate', [
            'handler' => 'rating',
            'method'  => 'getRateList'
        ]);
    }

    /**
     * @param  string $key
     * @param  string $format
     * @return mixed
     */
    public function getVar($key, $format = 's')

    {
        if ('s' === $format && in_array($key, ['name', 'dirname'])) {
            //            return call_user_func(array($this, $key));

            return $this->{$key}();
        }

        return parent::getVar($key, $format);
    }

    /**
     * @return string
     */
    public function name()
    {
        $ret = Smartobject\Utility::getLinkedUnameFromId($this->getVar('uid', 'e'), true, []);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $ret;
    }

    /**
     * @return mixed
     */
    public function dirname()
    {
        global $smartobjectRatingHandler;
        $moduleArray = $smartobjectRatingHandler->getModuleList();

        return $moduleArray[$this->getVar('dirname', 'n')];
    }

    /**
     * @return mixed
     */
    public function getItemList()
    {
        $plugin = $this->getModulePlugin();

        return $plugin->getItemList();

    }

    /**
     * @return string
     */
    public function getItemValue()
    {
        $moduleUrl      = XOOPS_URL . '/modules/' . $this->getVar('dirname', 'n') . '/';
        $plugin         = $this->getModulePlugin();
        $pluginItemInfo = $plugin->getItemInfo($this->getVar('item'));

        if (!$pluginItemInfo) {
            return '';
        }
        $itemPath = sprintf($pluginItemInfo['url'], $this->getVar('itemid'));
        $ret      = '<a href="' . $moduleUrl . $itemPath . '">' . $pluginItemInfo['caption'] . '</a>';

        return $ret;
    }

    /**
     * @return mixed
     */
    public function getRateValue()
    {
        return $this->getVar('rate');
    }

    /**
     * @return bool
     */
    public function getModulePlugin()
    {
        if (!$this->_modulePlugin) {
            global $smartobjectRatingHandler;
            $this->_modulePlugin = $smartobjectRatingHandler->pluginsObject->getPlugin($this->getVar('dirname', 'n'));
        }

        return $this->_modulePlugin;
    }
}


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 XoopsModules\Smartobject;
22
23		// defined('XOOPS_ROOT_PATH') \|\| die('Restricted access');
		0 ignored issues – show Unused Code Comprehensibility introduced 2018-03-21 16:43 UTC by Report Bug Copy Issue Report `70%` 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...
24
25		//require_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartobject.php';
		0 ignored issues – show Unused Code Comprehensibility introduced 2018-03-21 16:43 UTC by Report Bug Copy Issue Report `36%` 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...
26		//require_once XOOPS_ROOT_PATH . '/modules/smartobject/class/smartplugins.php';
27
28		/**
29		* Class SmartobjectRating
30		*/
31		class Rating extends Smartobject\BaseSmartObject
32		{
33		public $_modulePlugin = false;
34
35		/**
36		* SmartobjectRating constructor.
37		*/
38		public function __construct()
39		{
40		$this->quickInitVar('ratingid', XOBJ_DTYPE_INT, true);
41		$this->quickInitVar('dirname', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_RATING_DIRNAME);
42		$this->quickInitVar('item', XOBJ_DTYPE_TXTBOX, true, _CO_SOBJECT_RATING_ITEM);
43		$this->quickInitVar('itemid', XOBJ_DTYPE_INT, true, _CO_SOBJECT_RATING_ITEMID);
44		$this->quickInitVar('uid', XOBJ_DTYPE_INT, true, _CO_SOBJECT_RATING_UID);
45		$this->quickInitVar('date', XOBJ_DTYPE_LTIME, true, _CO_SOBJECT_RATING_DATE);
46		$this->quickInitVar('rate', XOBJ_DTYPE_INT, true, _CO_SOBJECT_RATING_RATE);
47
48		$this->initNonPersistableVar('name', XOBJ_DTYPE_TXTBOX, 'user', _CO_SOBJECT_RATING_NAME);
49
50		$this->setControl('dirname', [
51		'handler' => 'rating',
52		'method' => 'getModuleList',
53		'onSelect' => 'submit'
54		]);
55
56		$this->setControl('item', [
57		'object' => &$this,
58		'method' => 'getItemList'
59		]);
60
61		$this->setControl('uid', 'user');
62
63		$this->setControl('rate', [
64		'handler' => 'rating',
65		'method' => 'getRateList'
66		]);
67		}
68
69		/**
70		* @param string $key
71		* @param string $format
72		* @return mixed
73		*/
74	View Code Duplication	public function getVar($key, $format = 's')
		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...
75		{
76		if ('s' === $format && in_array($key, ['name', 'dirname'])) {
77		// return call_user_func(array($this, $key));
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-01 11:05 UTC by Report Bug Copy Issue Report `72%` 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...
78		return $this->{$key}();
79		}
80
81		return parent::getVar($key, $format);
82		}
83
84		/**
85		* @return string
86		*/
87		public function name()
88		{
89		$ret = Smartobject\Utility::getLinkedUnameFromId($this->getVar('uid', 'e'), true, []);
		0 ignored issues – show Documentation introduced 2018-03-22 11:26 UTC by Report Bug Copy Issue Report `true` is of type `boolean`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
90
91		return $ret;
92		}
93
94		/**
95		* @return mixed
96		*/
97		public function dirname()
98		{
99		global $smartobjectRatingHandler;
100		$moduleArray = $smartobjectRatingHandler->getModuleList();
101
102		return $moduleArray[$this->getVar('dirname', 'n')];
103		}
104
105		/**
106		* @return mixed
107		*/
108		public function getItemList()
109		{
110		$plugin = $this->getModulePlugin();
111
112		return $plugin->getItemList();
		0 ignored issues – show Bug introduced 2016-04-01 11:05 UTC by Report Bug Copy Issue Report The method `getItemList` cannot be called on `$plugin` (of type `boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
113		}
114
115		/**
116		* @return string
117		*/
118		public function getItemValue()
119		{
120		$moduleUrl = XOOPS_URL . '/modules/' . $this->getVar('dirname', 'n') . '/';
121		$plugin = $this->getModulePlugin();
122		$pluginItemInfo = $plugin->getItemInfo($this->getVar('item'));
		0 ignored issues – show Bug introduced 2016-04-01 11:05 UTC by Report Bug Copy Issue Report The method `getItemInfo` cannot be called on `$plugin` (of type `boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
123		if (!$pluginItemInfo) {
124		return '';
125		}
126		$itemPath = sprintf($pluginItemInfo['url'], $this->getVar('itemid'));
127		$ret = '<a href="' . $moduleUrl . $itemPath . '">' . $pluginItemInfo['caption'] . '</a>';
128
129		return $ret;
130		}
131
132		/**
133		* @return mixed
134		*/
135		public function getRateValue()
136		{
137		return $this->getVar('rate');
138		}
139
140		/**
141		* @return bool
142		*/
143		public function getModulePlugin()
144		{
145		if (!$this->_modulePlugin) {
146		global $smartobjectRatingHandler;
147		$this->_modulePlugin = $smartobjectRatingHandler->pluginsObject->getPlugin($this->getVar('dirname', 'n'));
148		}
149
150		return $this->_modulePlugin;
151		}
152		}
153

mambax7 / smartobject

Push — master ( 88111b...b3fce7 )

Rating::dirname() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like