ExtgalleryPublicRating::__construct() - Code Metrics - Inspection of "Updates" - mambax7/extgallery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (f9052b)

by Michael

created 2016-11-19 19:26 UTC

ExtgalleryPublicRating::__construct() A

↳ Parent: ExtgalleryPublicRating

Complexity

Conditions	1
Paths	1

Size

Total Lines	21
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	16
nc	1
nop	0
dl	0
loc	21
rs	9.3142
c	0
b	0
f	0

<?php

/**
 * ExtGallery Class Manager
 *
 * 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   {@link http://xoops.org/ XOOPS Project}
 * @license     GNU GPL 2 (http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
 * @author      Zoullou (http://www.zoullou.net)
 * @package     ExtGallery
 */

// defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');


include_once __DIR__ . '/ExtgalleryPersistableObjectHandler.php';

/**
 * Class ExtgalleryPublicRating
 */
class ExtgalleryPublicRating extends XoopsObject
namespace YourVendor;

class YourClass { }
{
    public $externalKey = array();

    /**
     * ExtgalleryPublicRating constructor.
     */
    public function __construct()
    {
        parent::__construct();
        $this->initVar('rating_id', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('photo_id', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('uid', XOBJ_DTYPE_INT, 0, false);
        $this->initVar('rating_rate', XOBJ_DTYPE_INT, 0, false);

        $this->externalKey['photo_id'] = array(
            'className'      => 'publicphoto',
            'getMethodeName' => 'getPhoto',
            'keyName'        => 'photo',
            'core'           => false
        );
        $this->externalKey['uid']      = array(
            'className'      => 'user',
            'getMethodeName' => 'get',
            'keyName'        => 'user',
            'core'           => true
        );
    }

    /**
     * @param $key
     *
     * @return mixed
     */
    public function getExternalKey($key)
    {
        return $this->externalKey[$key];
    }
}

/**
 * Class ExtgalleryPublicRatingHandler
 */
class ExtgalleryPublicRatingHandler extends ExtgalleryPersistableObjectHandler
namespace YourVendor;

class YourClass { }
{
    /**
     * @param XoopsDatabase $db
     */
    public function __construct(XoopsDatabase $db)
    {
        parent::__construct($db, 'extgallery_publicrating', 'ExtgalleryPublicRating', 'rating_id');
    }

    /**
     * @param $photoId
     * @param $rating
     *
     * @return bool
     */
    public function rate($photoId, $rating)
// 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);
    }
}
    {
        /** @var ExtgalleryPublicPhotoHandler $photoHandler */
        $photoHandler = xoops_getModuleHandler('publicphoto', 'extgallery');

        $userId = is_object($GLOBALS['xoopsUser']) ? $GLOBALS['xoopsUser']->getVar('uid') : 0;
        $rate   = $this->create();
        $rate->assignVar('photo_id', $photoId);
        $rate->assignVar('uid', $userId);
        $rate->assignVar('rating_rate', $rating);

        if ($this->_haveRated($rate)) {
            return false;
        }

        if (!$this->insert($rate, true)) {
            return false;
        }

        return $photoHandler->updateNbRating($photoId);
    }

    /**
     * @param $photoId
     *
     * @return float
     */
    public function getRate($photoId)
    {
        $criteria = new Criteria('photo_id', $photoId);
        $avg      = $this->getAvg($criteria, 'rating_rate');

        return round($avg);
    }

    /**
     * @param $rate
     *
     * @return bool
     */
    public function _haveRated(&$rate)
    {
        // If the user is annonymous
        if ($rate->getVar('uid') == 0) {
            return false;
        }

        $criteria = new CriteriaCompo();
        $criteria->add(new Criteria('photo_id', $rate->getVar('photo_id')));
        $criteria->add(new Criteria('uid', $rate->getVar('uid')));

        if ($this->getCount($criteria) > 0) {
            return true;
        }

        return false;
    }
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-03-22 05:38 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 25 and the first side effect is on line 20. 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			* ExtGallery Class Manager
4			*
5			* You may not change or alter any portion of this comment or credits
6			* of supporting developers from this source code or any supporting source code
7			* which is considered copyrighted (c) material of the original comment or credit authors.
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			* @copyright {@link http://xoops.org/ XOOPS Project}
13			* @license GNU GPL 2 (http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
14			* @author Zoullou (http://www.zoullou.net)
15			* @package ExtGallery
16			*/
17
18			// defined('XOOPS_ROOT_PATH') \|\| exit('XOOPS root path not defined');
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-22 05:38 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...
19
20			include_once __DIR__ . '/ExtgalleryPersistableObjectHandler.php';
21
22			/**
23			* Class ExtgalleryPublicRating
24			*/
25			class ExtgalleryPublicRating extends XoopsObject
			0 ignored issues – show Coding Style Compatibility introduced 2016-03-22 05:38 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
26			{
27			public $externalKey = array();
28
29			/**
30			* ExtgalleryPublicRating constructor.
31			*/
32			public function __construct()
33			{
34			parent::__construct();
35			$this->initVar('rating_id', XOBJ_DTYPE_INT, 0, false);
36			$this->initVar('photo_id', XOBJ_DTYPE_INT, 0, false);
37			$this->initVar('uid', XOBJ_DTYPE_INT, 0, false);
38			$this->initVar('rating_rate', XOBJ_DTYPE_INT, 0, false);
39
40			$this->externalKey['photo_id'] = array(
41			'className' => 'publicphoto',
42			'getMethodeName' => 'getPhoto',
43			'keyName' => 'photo',
44			'core' => false
45			);
46			$this->externalKey['uid'] = array(
47			'className' => 'user',
48			'getMethodeName' => 'get',
49			'keyName' => 'user',
50			'core' => true
51			);
52			}
53
54			/**
55			* @param $key
56			*
57			* @return mixed
58			*/
59			public function getExternalKey($key)
60			{
61			return $this->externalKey[$key];
62			}
63			}
64
65			/**
66			* Class ExtgalleryPublicRatingHandler
67			*/
68			class ExtgalleryPublicRatingHandler extends ExtgalleryPersistableObjectHandler
			0 ignored issues – show Coding Style Compatibility introduced 2016-03-22 05:38 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history... Coding Style Compatibility introduced 2016-03-22 05:38 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
69			{
70			/**
71			* @param XoopsDatabase $db
72			*/
73			public function __construct(XoopsDatabase $db)
74			{
75			parent::__construct($db, 'extgallery_publicrating', 'ExtgalleryPublicRating', 'rating_id');
76			}
77
78			/**
79			* @param $photoId
80			* @param $rating
81			*
82			* @return bool
83			*/
84			public function rate($photoId, $rating)
			0 ignored issues – show Coding Style introduced 2016-03-22 05:38 UTC by Report Bug Copy Issue Report `rate` 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...
85			{
86			/** @var ExtgalleryPublicPhotoHandler $photoHandler */
87			$photoHandler = xoops_getModuleHandler('publicphoto', 'extgallery');
88
89			$userId = is_object($GLOBALS['xoopsUser']) ? $GLOBALS['xoopsUser']->getVar('uid') : 0;
90			$rate = $this->create();
91			$rate->assignVar('photo_id', $photoId);
92			$rate->assignVar('uid', $userId);
93			$rate->assignVar('rating_rate', $rating);
94
95			if ($this->_haveRated($rate)) {
96			return false;
97			}
98
99			if (!$this->insert($rate, true)) {
100			return false;
101			}
102
103			return $photoHandler->updateNbRating($photoId);
104			}
105
106			/**
107			* @param $photoId
108			*
109			* @return float
110			*/
111			public function getRate($photoId)
112			{
113			$criteria = new Criteria('photo_id', $photoId);
114			$avg = $this->getAvg($criteria, 'rating_rate');
115
116			return round($avg);
117			}
118
119			/**
120			* @param $rate
121			*
122			* @return bool
123			*/
124			public function _haveRated(&$rate)
125			{
126			// If the user is annonymous
127			if ($rate->getVar('uid') == 0) {
128			return false;
129			}
130
131			$criteria = new CriteriaCompo();
132			$criteria->add(new Criteria('photo_id', $rate->getVar('photo_id')));
133			$criteria->add(new Criteria('uid', $rate->getVar('uid')));
134
135			if ($this->getCount($criteria) > 0) {
136			return true;
137			}
138
139			return false;
140			}
141			}
142

mambax7 / extgallery

Branch — master (f9052b)

ExtgalleryPublicRating::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like