PermissionHandler::deleteByForum() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/mambax..." - mambax7/newbb5 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 62af87...249590 )

by Michael

created 2018-01-13 06:18 UTC

PermissionHandler::deleteByForum() A

↳ Parent: PermissionHandler

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	1
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0

<?php namespace XoopsModules\Newbb;


/**
 * NewBB 5.0x,  the forum module for XOOPS project
 *
 * @copyright      XOOPS Project (https://xoops.org)
 * @license        GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @author         Taiwen Jiang (phppp or D.J.) <[email protected]>
 * @since          4.00
 * @package        module::newbb
 */

use XoopsModules\Newbb;

// defined('XOOPS_ROOT_PATH') || exit('Restricted access.');


defined('NEWBB_FUNCTIONS_INI') || include $GLOBALS['xoops']->path('modules/newbb/include/functions.ini.php');
define('NEWBB_HANDLER_PERMISSION', 1);

// Initializing XoopsGroupPermHandler if not loaded yet
if (!class_exists('XoopsGroupPermHandler')) {
    require_once $GLOBALS['xoops']->path('kernel/groupperm.php');
}

/**
 * Class PermissionHandler
 */
class PermissionHandler extends \XoopsGroupPermHandler
{
    public $_handler;

    /** @var \Xmf\Module\Helper\Cache */
    protected $cacheHelper;

    /**
     * @param $db
     */
    public function __construct(\XoopsDatabase $db)

    {
        $this->cacheHelper = new \Xmf\Module\Helper\Cache('newbb');

        $this->db = $db;
        parent::__construct($db);
    }

    /**
     * @param $name
     * @return mixed
     */
    public function loadHandler($name)
    {
        if (!isset($this->_handler[$name])) {
//            require_once __DIR__ . "/permission.{$name}.php";

            $className             = '\\XoopsModules\\Newbb\\Permission' . ucfirst($name) . 'Handler';
            $this->_handler[$name] = new $className($this->db);
        }

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

    /**
     * @param  bool $fullname
     * @return mixed
     */
    public function getValidForumPerms($fullname = false)
    {
        $handler = $this->loadHandler('forum');

        return $handler->getValidPerms($fullname);
    }

    /**
     * @param  int  $forum
     * @param  bool $topic_locked
     * @param  bool $isAdmin
     * @return mixed
     */
    public function getPermissionTable($forum = 0, $topic_locked = false, $isAdmin = false)

    {
        $handler = $this->loadHandler('forum');
        $perm    = $handler->getPermissionTable($forum, $topic_locked, $isAdmin);


        return $perm;
    }

    /**
     * @param $forum_id
     * @return mixed
     */
    public function deleteByForum($forum_id)

    {
        $this->cacheHelper->delete('permission_forum');
        $handler = $this->loadHandler('forum');

        return $handler->deleteByForum($forum_id);

    }

    /**
     * @param $cat_id
     * @return mixed
     */
    public function deleteByCategory($cat_id)

    {
        $this->cacheHelper->delete('permission_category');
        $handler = $this->loadHandler('category');

        return $handler->deleteByCategory($cat_id);

    }

    /**
     * @param        $category
     * @param  array $groups
     * @return mixed
     */
    public function setCategoryPermission($category, array $groups = [])
    {
        $this->cacheHelper->delete('permission_category');
        $handler = $this->loadHandler('category');

        return $handler->setCategoryPermission($category, $groups);
    }

    /**
     * @param         $type
     * @param  string $gperm_name
     * @param  int    $id
     * @return bool
     */
    public function getPermission($type, $gperm_name = 'access', $id = 0)
// 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);
    }
}
    {
        global $xoopsModule;
function myFunction($a, $b) {
    // Do something
}
        $ret = false;
        if ($GLOBALS['xoopsUserIsAdmin'] && 'newbb' === $xoopsModule->getVar('dirname')) {
            $ret = true;
        }

        $groups = is_object($GLOBALS['xoopsUser']) ? $GLOBALS['xoopsUser']->getGroups() : [XOOPS_GROUP_ANONYMOUS];
        if (!$groups) {
            $ret = false;
        }
        if (!$allowed_groups = $this->getGroups("{$type}_{$gperm_name}", $id)) {

            $ret = false;
        }

        if (count(array_intersect($allowed_groups, $groups)) > 0) {

            $ret = true;
        }

        return $ret;
    }

    /**
     * @param  string $perm_name
     * @return array
     */
    public function &getCategories($perm_name = 'access')

    {
        $ret = $this->getAllowedItems('category', "category_{$perm_name}");


        return $ret;
    }

    /**
     * @param  string $perm_name
     * @return array
     */
    public function getForums($perm_name = 'access')

    {
        $ret = $this->getAllowedItems('forum', "forum_{$perm_name}");


        return $ret;
    }

    /**
     * @param $type
     * @param $perm_name
     * @return array
     */
    public function getAllowedItems($type, $perm_name)
// 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);
    }
}
    {
        $ret = [];

        $groups = is_object($GLOBALS['xoopsUser']) ? $GLOBALS['xoopsUser']->getGroups() : [XOOPS_GROUP_ANONYMOUS];
        if (count($groups) < 1) {
            return $ret;
        }

        if (!$_cachedPerms = $this->loadPermData($perm_name, $type)) {

            return $ret;
        }

        $allowed_items = [];

        foreach ($_cachedPerms as $id => $allowed_groups) {

            if (0 == $id || empty($allowed_groups)) {

                continue;
            }

            if (array_intersect($groups, $allowed_groups)) {

                $allowed_items[$id] = 1;

            }
        }
        unset($_cachedPerms);

        $ret = array_keys($allowed_items);


        return $ret;
    }

    /**
     * @param        $gperm_name
     * @param  int   $id
     * @return array
     */
    public function getGroups($gperm_name, $id = 0)

    {
        $_cachedPerms = $this->loadPermData($gperm_name);

        $groups       = empty($_cachedPerms[$id]) ? [] : array_unique($_cachedPerms[$id]);

        unset($_cachedPerms);


        return $groups;
    }

    /**
     * @param  string $perm_name
     * @return array
     */
    public function createPermData($perm_name = 'forum_all')

    {
        global $xoopsModule;
function myFunction($a, $b) {
    // Do something
}
        /** @var \XoopsModuleHandler $moduleHandler */
        $perms = [];

        if (is_object($xoopsModule) && 'newbb' === $xoopsModule->getVar('dirname')) {

            $modid = $xoopsModule->getVar('mid');
        } else {
            $moduleHandler = xoops_getHandler('module');
            $module        = $moduleHandler->getByDirname('newbb');
            $modid         = $module->getVar('mid');
            unset($module);
        }

        if (in_array($perm_name, ['forum_all', 'category_all'], true)) {

            /** @var \XoopsMemberHandler $memberHandler */
            $memberHandler = xoops_getHandler('member');
            $groups        = array_keys($memberHandler->getGroupList());

            $type          = ('category_all' === $perm_name) ? 'category' : 'forum';

            $objectHandler = Newbb\Helper::getInstance()->getHandler($type);
            $object_ids    = $objectHandler->getIds();

            foreach ($object_ids as $item_id) {

                $perms[$perm_name][$item_id] = $groups;

            }
        } else {
            $gpermHandler = xoops_getHandler('groupperm');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            $criteria     = new \CriteriaCompo(new \Criteria('gperm_modid', $modid));
            if (!empty($perm_name) && 'forum_all' !== $perm_name && 'category_all' !== $perm_name) {

                $criteria->add(new \Criteria('gperm_name', $perm_name));

            }
            $permissions = $this->getObjects($criteria);

            foreach ($permissions as $gperm) {
                $item_id                                         = $gperm->getVar('gperm_itemid');

                $group_id                                        = (int)$gperm->getVar('gperm_groupid');

                $perms[$gperm->getVar('gperm_name')][$item_id][] = $group_id;

            }
        }
        if (count($perms) > 0) {
            foreach (array_keys($perms) as $perm) {
                $this->cacheHelper->write("permission_{$perm}", $perms[$perm]);
            }
        }
        $ret = !empty($perm_name) ? @$perms[$perm_name] : $perms;


        return $ret;
    }

    /**
     * @param  string $perm_name
     * @return array|mixed|null
     */
    public function &loadPermData($perm_name = 'forum_access')

    {
        if (!$perms = $this->cacheHelper->read("permission_{$perm_name}")) {

            $perms = $this->createPermData($perm_name);

        }

        return $perms;
    }

    /**
     * @param       $perm
     * @param       $itemid
     * @param       $groupid
     * @param  null $mid
     * @return bool
     */
    public function validateRight($perm, $itemid, $groupid, $mid = null)
// 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);
    }
}
    {
        if (empty($mid)) {

            if (is_object($GLOBALS['xoopsModule']) && 'newbb' === $GLOBALS['xoopsModule']->getVar('dirname')) {
                $mid = $GLOBALS['xoopsModule']->getVar('mid');
            } else {
                /** @var \XoopsModuleHandler $moduleHandler */
                $moduleHandler = xoops_getHandler('module');
                $mod           = $moduleHandler->getByDirname('newbb');
                $mid           = $mod->getVar('mid');
                unset($mod);
            }
        }
        if ($this->myCheckRight($perm, $itemid, $groupid, $mid)) {
            return true;
        }
        $this->cacheHelper->delete('permission');
        $this->addRight($perm, $itemid, $groupid, $mid);

        return true;
    }

    /**
     * Check permission (directly)
     *
     * @param string $gperm_name   Name of permission
     * @param int    $gperm_itemid ID of an item
     * @param        int           /array $gperm_groupid A group ID or an array of group IDs
     * @param int    $gperm_modid  ID of a module
     *
     * @return bool TRUE if permission is enabled
     */
    public function myCheckRight($gperm_name, $gperm_itemid, $gperm_groupid, $gperm_modid = 1)

    {
        $ret      = false;
        $criteria = new \CriteriaCompo(new \Criteria('gperm_modid', $gperm_modid));

        $criteria->add(new \Criteria('gperm_name', $gperm_name));

        $gperm_itemid = (int)$gperm_itemid;

        if ($gperm_itemid > 0) {

            $criteria->add(new \Criteria('gperm_itemid', $gperm_itemid));

        }
        if (is_array($gperm_groupid)) {

            $criteria2 = new \CriteriaCompo();
            foreach ($gperm_groupid as $gid) {

                $criteria2->add(new \Criteria('gperm_groupid', $gid), 'OR');
            }
            $criteria->add($criteria2);
        } else {
            $criteria->add(new \Criteria('gperm_groupid', $gperm_groupid));

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

        return $ret;
    }

    /**
     * @param       $perm
     * @param       $itemid
     * @param       $groupid
     * @param  null $mid
     * @return bool
     */
    public function deleteRight($perm, $itemid, $groupid, $mid = null)
// 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);
    }
}
    {
        $this->cacheHelper->delete('permission');
        if (null === $mid) {

            if (is_object($GLOBALS['xoopsModule']) && 'newbb' === $GLOBALS['xoopsModule']->getVar('dirname')) {
                $mid = $GLOBALS['xoopsModule']->getVar('mid');
            } else {
                /** @var \XoopsModuleHandler $moduleHandler */
                $moduleHandler = xoops_getHandler('module');
                $mod           = $moduleHandler->getByDirname('newbb');
                $mid           = $mod->getVar('mid');
                unset($mod);
            }
        }
        if (is_callable([&$this->XoopsGroupPermHandler, 'deleteRight'])) {
            return parent::deleteRight($perm, $itemid, $groupid, $mid);
        } else {
            $criteria = new \CriteriaCompo(new \Criteria('gperm_name', $perm));
            $criteria->add(new \Criteria('gperm_groupid', $groupid));
            $criteria->add(new \Criteria('gperm_itemid', $itemid));
            $criteria->add(new \Criteria('gperm_modid', $mid));
            $permsObject = $this->getObjects($criteria);
            if (!empty($permsObject)) {
                foreach ($permsObject as $permObject) {
                    $this->delete($permObject);
                }
            }
            unset($criteria, $permsObject);
        }

        return true;
    }

    /**
     * @param        $forum
     * @param  int   $mid
     * @return mixed
     */
    public function applyTemplate($forum, $mid = 0)
    {
        $this->cacheHelper->delete('permission_forum');
        $handler = $this->loadHandler('forum');

        return $handler->applyTemplate($forum, $mid);
    }

    /**
     * @return mixed
     */
    public function getTemplate()
    {
        $handler  = $this->loadHandler('forum');
        $template = $handler->getTemplate();

        return $template;
    }

    /**
     * @param $perms
     * @return mixed
     */
    public function setTemplate($perms)
    {
        $handler = $this->loadHandler('forum');

        return $handler->setTemplate($perms);
    }
}


Push — master ( 62af87...249590 )

PermissionHandler::deleteByForum() 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			<?php namespace XoopsModules\Newbb;
			0 ignored issues – show Coding Style Compatibility introduced 2018-01-13 06:21 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 18 and the first side effect is on line 17. 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			/**
4			* NewBB 5.0x, the forum module for XOOPS project
5			*
6			* @copyright XOOPS Project (https://xoops.org)
7			* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
8			* @author Taiwen Jiang (phppp or D.J.) <[email protected]>
9			* @since 4.00
10			* @package module::newbb
11			*/
12
13			use XoopsModules\Newbb;
14
15			// defined('XOOPS_ROOT_PATH') \|\| exit('Restricted access.');
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-01-13 06:21 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...
16
17			defined('NEWBB_FUNCTIONS_INI') \|\| include $GLOBALS['xoops']->path('modules/newbb/include/functions.ini.php');
18			define('NEWBB_HANDLER_PERMISSION', 1);
19
20			// Initializing XoopsGroupPermHandler if not loaded yet
21			if (!class_exists('XoopsGroupPermHandler')) {
22			require_once $GLOBALS['xoops']->path('kernel/groupperm.php');
23			}
24
25			/**
26			* Class PermissionHandler
27			*/
28			class PermissionHandler extends \XoopsGroupPermHandler
29			{
30			public $_handler;
			0 ignored issues – show Coding Style introduced 2017-11-20 06:47 UTC by Report Bug Copy Issue Report `$_handler` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
31			/** @var \Xmf\Module\Helper\Cache */
32			protected $cacheHelper;
33
34			/**
35			* @param $db
36			*/
37			public function __construct(\XoopsDatabase $db)

mambax7 / newbb5

Push — master ( 62af87...249590 )

PermissionHandler::deleteByForum() 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

Duplication Side-by-Side

Filter issues like